Skip to main content
POST
Create Chat (OpenAI Compatible)

Authorizations

Authorization
string
header
required

Retrieve your API Key from Dashboard [blocked].

Body

application/json
input
required

This is the input text for the chat. Can be a string or an array of chat messages. This field is REQUIRED for chat creation.

Example:
assistantId
string

This is the assistant that will be used for the chat. To use an existing assistant, use assistantId instead.

assistant
object

This is the assistant that will be used for the chat. To use an existing assistant, use assistantId instead.

assistantOverrides
object

These are the variable values that will be used to replace template variables in the assistant messages. Only variable substitution is supported in chat contexts - other assistant properties cannot be overridden.

name
string

This is the name of the chat. This is just for your own reference.

Maximum string length: 40
sessionId
string

This is the ID of the session that will be used for the chat. Mutually exclusive with previousChatId.

stream
boolean
default:true

Whether to stream the response or not.

previousChatId
string

This is the ID of the chat that will be used as context for the new chat. The messages from the previous chat will be used as context. Mutually exclusive with sessionId.

Response

OpenAI Responses API format - either non-streaming or streaming

id
string
required

Unique identifier for this Response

object
enum<string>
default:response
required

The object type

Available options:
response
created_at
number
required

Unix timestamp (in seconds) of when this Response was created

status
enum<string>
required

Status of the response

Available options:
completed,
failed,
in_progress,
incomplete
output
object[]
required

Output messages from the model

error
string | null

Error message if the response failed