Sign in

v1

latestOpenAPI 3.1.02026-07-26132433.7 KB
Responses

Create response

post/responses

Headers

x-project-idstring

Optional project identifier. Scopes the request to a specific project when provided.

Request body

model'llama-3.1-8b-instruct-fast' | 'LFM2.5-1.2B-Instruct' | 'LFM2.5-1.2B-Thinking' | 'gpt-oss-120b' | 'deberta-v3-small' | 'gliner2-base-v1' | 'gliner-multi-pii-v1' | 'zlm-v1-followup-questions-edge' | 'zlm-v1-iab-classify-edge' | 'zlm-v2-iab-classify-edge-enriched' | 'zlm-v1-iab-domain-classifier' required

Model identifier. Open a model page for a dedicated playground with the correct body for that model.

inputstring textarea required

The text or document to send, as a plain string.

instructionsstring

Optional system-style instructions applied on top of input, for models that support them.

metadataobject

Optional model-specific parameters, passed through to the model. For example, PII models accept mask and usecase. See the relevant model page for supported keys.

Example request

{
  "model": "llama-3.1-8b-instruct-fast",
  "text": {
    "format": {
      "type": "text"
    }
  }
}

Response

Success

idstring

Unique identifier for the response.

objectstring

Object type. Always response.

createdinteger

Unix timestamp (seconds) when the response was created.

modelstring

The model used for inference.

Example response

{
  "id": "resp_abc123",
  "object": "response",
  "created": 1710000000,
  "model": "llama-3.1-8b-instruct-fast",
  "output": [
    {
      "type": "message",
      "role": "assistant",
      "content": [
        {
          "type": "output_text",
          "text": "Artemis III, slated for late 2026, will return astronauts to the Moon for the first time since 1972."
        }
      ]
    }
  ],
  "usage": {
    "input_tokens": 112,
    "output_tokens": 44,
    "total_tokens": 156
  }
}