Get Text Generator items

List text generation tasks for the authenticated workspace.

GET /sse/text_generator/

Get Text Generator items

cURL

curl --request GET \
  --url https://api.creatify.ai/sse/text_generator/ \
  --header 'X-API-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>'

200

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "model_name": "<string>",
    "messages": [
      {
        "role": "user",
        "content": "",
        "function_call": {
          "name": "<string>",
          "args": {}
        },
        "function_response": {
          "name": "<string>",
          "response": {}
        }
      }
    ],
    "config": {
      "temperature": 123,
      "max_output_tokens": 123,
      "top_p": 123,
      "top_k": 123,
      "presence_penalty": 123,
      "frequency_penalty": 123,
      "seed": 123,
      "stop_sequences": [
        "<string>"
      ],
      "response_mime_type": "text/plain",
      "response_json_schema": "<unknown>"
    },
    "response_function_calls": [
      {
        "name": "<string>",
        "args": {}
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "system_instruction": "<string>",
    "status": "pending",
    "response_text": "<string>",
    "failed_reason": "<string>",
    "credits_used": 123
  }
]

Authorizations

X-API-ID · string · header · required

API ID, from your settings page.

X-API-KEY · string · header · required

API Key, from your settings page.

Response

200

application/json

List of text generation tasks.

id · string<uuid> · required · read-only

model_name · string · required · read-only

messages · object[] · required · read-only

Show child attributes

config · object · required

Structured config serializer for OpenAPI documentation.

Show child attributes

response_function_calls · object[] · required · read-only

Show child attributes

created_at · string<date-time> · required · read-only

updated_at · string<date-time> · required · read-only

system_instruction · string

Optional system instruction for the model.

status · enum<string>

• pending - pending
• running - running
• done - done
• failed - failed

Available options: pending, running, done, failed

response_text · string

Generated text response from the model.

failed_reason · string

Reason for failure if status is failed.

credits_used · number<double>

Credits consumed for this generation.