v54

latestSwagger 2.0AGPL-3.0raw.githubusercontent.com2026-08-03397565628.8 KB
Chats

Create chat

Experimental: this endpoint is subject to change.

post/api/experimental/chats

Request body

client_type'ui' | 'api'
labelsobject
mcp_server_idsstring[]
model_config_idstring uuid
organization_idstring uuid
plan_mode'plan'
reasoning_effortstring
system_promptstring
workspace_idstring uuid

Response

Created

agent_idstring uuid
archivedboolean
build_idstring uuid
client_type'ui' | 'api'
created_atstring date-time
has_unreadboolean

HasUnread is true when assistant messages exist beyond the owner's read cursor, which updates on stream connect and disconnect.

idstring uuid
labelsobject
last_model_config_idstring uuid
last_reasoning_effortstring
last_turn_summarystring
mcp_server_idsstring[]
organization_idstring uuid
owner_idstring uuid
owner_namestring
owner_usernamestring
parent_chat_idstring uuid
pin_orderinteger
plan_mode'plan'
root_chat_idstring uuid
sharedboolean

Shared is true when this chat's root chat has explicit user or group ACL entries.

status'waiting' | 'running' | 'error' | 'requires_action' | 'interrupting'
summarystring

Summary is the persisted whole-chat summary, generated in the background. It is nil until the first summary has been produced.

titlestring
updated_atstring date-time
warningsstring[]
workspace_idstring uuid