Skip to main content
POST
Create a chat

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
title
string

Chat title. Defaults to New Chat.

organization_id
string

Organization the chat belongs to.

chat_id
string

Client-supplied UUID to create the chat under.

workspace_id
string

Workspace the chat belongs to. Required with agent_name.

agent_name
string

Name of a subagent defined in the workspace's .agents/ folder. Every turn of the chat then runs with that agent's instructions and tool allowlist instead of the default assistant.

Response

Successful response

The response is of type object.