Start an agent chat on a project (and optionally a branch) with an opening message
Creates the chat and, when messages is given, starts the agent on it. Answers as soon as the chat exists — its status is streaming while the agent works and ready once it has answered — unless wait: true holds the request until the opening turn has finished. Poll GET /ai/trigger/runs?agent_ids= (the same poll as for an automation run) or GET /ai/agents/ for the transcript.
Authorizations
Headers
Workspace identifier
Body
Model to answer this chat with, instead of the project's.
The opening turn. Each message is { "role": "user", "content": "…" }; given, the agent starts answering as soon as the chat exists. Omitted, the chat is created idle and POST /ai/agents/{id}/messages starts it.
The caller's own labels for the chat, kept on it as sent. api_key_id is always the calling key, whatever the body says.
private, shared Hold the request open until the opening turn has finished and return the complete transcript. Off, the response comes back as soon as the chat exists with status: "streaming"; poll GET /ai/trigger/runs or GET /ai/agents/{id} for the outcome, exactly as for an automation run.
Response
branch, endpoint, import, schedule, slack, github, gitlab, onshape, webhook, assistant, entity_edit, manual, impact_analysis, what_if_analysis, subagent