Create Chat (OpenAI Compatible)

Authentication

AuthorizationBearer

Retrieve your API Key from Dashboard.

Request

This endpoint expects an object.

inputstring or list of objectsRequired

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.

assistantIdstringOptional

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

assistantobjectOptional

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

assistantOverridesobjectOptional

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.

squadIdstringOptional

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

squadobjectOptional

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

namestringOptional<=40 characters

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

sessionIdstringOptional

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

streambooleanOptionalDefaults to true

Whether to stream the response or not.

previousChatIdstringOptional

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.

transportobjectOptional

This is used to send the chat through a transport like SMS. If transport.phoneNumberId and transport.customer are provided, creates a new session. If sessionId is provided without transport fields, uses existing session data. Cannot specify both sessionId and transport fields (phoneNumberId/customer) together.

Response

OpenAI Responses API format - either non-streaming or streaming

ResponseObjectobject

ResponseTextDeltaEventobject

ResponseTextDoneEventobject

ResponseCompletedEventobject

ResponseErrorEventobject

1	from vapi import Vapi
2
3	client = Vapi(
4	token="YOUR_TOKEN",
5	)
6	client.chats.create_response(
7	input="input",
8	)

1	{
2	"id": "string",
3	"object": "response",
4	"created_at": 1.1,
5	"status": "completed",
6	"error": "string",
7	"output": [
8	{
9	"id": "string",
10	"content": [
11	{
12	"annotations": [
13	{}
14	],
15	"text": "string",
16	"type": "output_text"
17	}
18	],
19	"role": "assistant",
20	"status": "in_progress",
21	"type": "message"
22	}
23	]
24	}