Sign in

v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-01979563.0 MB
Chats

Create Chat (OpenAI Compatible)

post/chat/responses

Request body

assistantIdstring

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

squadIdstring

This is the squad that will be used for the chat. To use a transient squad, use squad instead.

namestring

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

sessionIdstring

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

streamboolean

Whether to stream the response or not.

previousChatIdstring

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

OR
OR
OR
OR

Example response

{
  "code": "ERR_SOMETHING",
  "message": "Something went wrong",
  "sequence_number": 1
}