Sign in

v171

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0726249111.7 MB
Deployments

Invoke

Invoke a deployment with a given payload

post/v2/deployments/invoke

Request body

keystring required

The deployment key to invoke

streamboolean

If set, partial message content will be sent. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message.

inputsobject

Key-value pairs variables to replace in your prompts. If a variable is not provided that is defined in the prompt, the default variables are used.

contextobject

Key-value pairs that match your data model and fields declared in your deployment routing configuration

file_idsstring[]

A list of file IDs that are associated with the deployment request.

metadataobject

Key-value pairs that you want to attach to the log generated by this request.

extra_paramsobject

Utilized for passing additional parameters to the model provider. Exercise caution when using this feature, as the included parameters will overwrite any parameters specified in the deployment prompt configuration.

Example request

{
  "identity": {
    "id": "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
    "display_name": "Jane Doe",
    "email": "jane.doe@example.com",
    "metadata": [
      {
        "department": "Engineering",
        "role": "Senior Developer"
      }
    ],
    "logo_url": "https://example.com/avatars/jane-doe.jpg",
    "tags": [
      "hr",
      "engineering"
    ]
  },
  "documents": [
    {
      "text": "The refund policy allows customers to return items within 30 days of purchase for a full refund.",
      "metadata": {
        "file_name": "refund_policy.pdf",
        "file_type": "application/pdf",
        "page_number": 1
      }
    },
    {
      "text": "Premium members receive free shipping on all orders over $50.",
      "metadata": {
        "file_name": "membership_benefits.md",
        "file_type": "text/markdown"
      }
    }
  ]
}

Response

Successful operation

idstring ulid required

A unique identifier for the response. Can be used to add metrics to the transaction.

createdstring date-time required

A timestamp indicating when the object was created. Usually in a standardized format like ISO 8601

object'chat' | 'completion' | 'image' required

Indicates the type of model used to generate the response

modelstring required

The model used to generate the response

provider'openai' | 'groq' | 'cohere' | 'azure' | 'aws' | 'google' | 'google-ai' | 'huggingface' | 'togetherai' | 'perplexity' | 'anthropic' | 'leonardoai' | 'fal' | 'nvidia' | 'jina' | 'elevenlabs' | 'litellm' | 'cerebras' | 'openailike' | 'bytedance' | 'mistral' | 'deepseek' | 'moonshotai' | 'zai' | 'minimax' | 'xai' | 'alibaba' | 'tensorix' | 'scaleway' | 'hcompany' | 'inceptron' | 'wafer' | 'poolside' | 'tencent' | 'nebius' | 'fireworks' | 'baseten' | 'reson8' | 'slack' | 'orq' required

The provider used to generate the response

is_finalboolean required

Indicates if the response is the final response

integration_idstring

Indicates integration id used to generate the response

finalizedstring date-time

A timestamp indicating when the object was finalized. Usually in a standardized format like ISO 8601

system_fingerprintstring nullable

Provider backed system fingerprint.

{"stackTrail":"paths:/v2/deployments/invoke:post:responses:200:content:application/json:schema:properties:provider_response","oasType":"schema","type":"unknown","description":"Response returned by the model provider. This functionality is only supported when streaming is not used. If streaming is used, the `provider_response` property will be set to `null`."}