Skip to main content

Overview

Basic chat completions allow you to send a message and receive a response from the model. This is the simplest way to interact with the LLM Gateway.

Getting started

Send a message and receive a response:

Streamed responses

You can stream responses from OpenAI models by setting stream to true. This returns partial responses as server-sent events (SSE), allowing you to display output as it’s generated.
Streamed responses are currently supported on OpenAI models only.

API reference

Request

The LLM Gateway accepts POST requests to https://llm-gateway.assemblyai.com/v1/chat/completions with the following parameters:

Request parameters

KeyTypeRequired?Description
modelstringYesThe model to use for completion. See Available models section for supported values.
messagesarrayYes*An array of message objects representing the conversation history. Either messages or prompt is required.
promptstringYes*A simple string prompt for single request/response interactions. Either messages or prompt is required.
streambooleanNoWhen true, responses are streamed as server-sent events (SSE). Supported on OpenAI models only.
max_tokensnumberNoThe maximum number of tokens to generate. Default: 1000. Range: [1, context_length).
temperaturenumberNoControls randomness in the output. Higher values make output more random. Range: [0, 2].
post_processing_stepsarrayNoAn ordered list of post-processing steps to apply to the response. See Post-processing.
transcript_idstringNoInject an AssemblyAI transcript’s text into the prompt. The first {{ transcript }} tag in the first message that contains it is replaced with the transcript text. See Inject a transcript by ID.
model_regionstringNoOpt into global routing for lower-cost processing. The only accepted value is "global"; omit for default in-region processing. See Global routing.

Message object

KeyTypeRequired?Description
rolestringYesThe role of the message sender. Valid values: "user", "assistant", "system", or "tool".
contentstring or arrayYesThe message content. Can be a string or an array of content parts for the "user" role.
namestringNoAn optional name for the message sender. For non-OpenAI models, this will be prepended as {name}: {content}.

Content part object

KeyTypeRequired?Description
typestringYesThe type of content. Currently only "text" is supported.
textstringYesThe text content.

Response

The API returns a JSON response with the model’s completion:

Response fields

KeyTypeDescription
request_idstringA unique identifier for the request.
choicesarrayAn array of completion choices. Typically contains one choice.
choices[i].messageobjectThe message object containing the model’s response.
choices[i].message.rolestringThe role of the message, typically "assistant".
choices[i].message.contentstringThe text content of the model’s response.
choices[i].finish_reasonstringThe reason the model stopped generating. Common values: "stop", "length".
requestobjectEcho of the request parameters (excluding prompt and messages).
usageobjectToken usage statistics for the request.
usage.input_tokensnumberNumber of tokens in the prompt.
usage.output_tokensnumberNumber of tokens in the completion.
usage.total_tokensnumberTotal tokens used (prompt + completion).

Inject a transcript by ID

Pass transcript_id at the top level of the request to inject a transcript’s text into the prompt. The API replaces the first occurrence of the literal tag {{ transcript }} in the first message containing it with the transcript’s text field, then runs the completion.
Only the first occurrence of {{ transcript }} in the first message that contains it is substituted — additional tags or tags in later messages are left as-is. The tag must be exactly {{ transcript }} (with the spaces); variants like {{transcript}} or {{ TRANSCRIPT }} are not substituted. The endpoint returns 404 if the transcript ID does not exist or belongs to a different account.

Error response

If an error occurs, the API returns an error response:
KeyTypeDescription
codenumberHTTP status code for the error.
messagestringA human-readable description of the error.
request_idstringUnique identifier for the request. Include this when contacting support.
metadataobjectOptional. Present on 400 responses with per-field validation details.
metadata.errorsarrayList of specific validation failure messages.

Common error codes

CodeDescription
400Bad Request - Invalid request parameters
401Unauthorized - Invalid or missing API key
403Forbidden - Insufficient permissions
404Not Found - Invalid endpoint or model
429Too Many Requests - Rate limit exceeded
500Internal Server Error - Server-side error