Skip to main content
POST
Create chat

Authorizations

Authorization
string
header
required

Organization or personal API key from Settings → API Keys.

Headers

X-Replicas-Api-Version
enum<string>

API version. 2026-10-07 returns snake_case responses. See versioning.

Available options:
2026-10-07

Path Parameters

id
string<uuid>
required

The unique identifier of the replica

Body

application/json

Request body for creating a new chat

provider
enum<string>
required

Coding agent provider for this chat

Available options:
claude,
codex,
cursor,
muse,
opencode,
pi
id
string<uuid>

Optional client-generated chat ID.

created_at
string<date-time>

Optional client-generated creation time.

title
string

Title for the chat

parent_chat_id
string<uuid>

Optional parent chat ID.

client_request_id
string

Opaque client-chosen id echoed back in the chat.created event, so clients doing optimistic UI can recognize their own create

Response

Chat created successfully

A chat session within a workspace

id
string
required

Unique identifier for the chat

provider
enum<string>
required

Coding agent provider for this chat

Available options:
claude,
codex,
cursor,
muse,
opencode,
pi
title
string
required

Chat title

created_at
string<date-time>
required

When the chat was created

updated_at
string<date-time>
required

When the chat was last updated

processing
boolean
required

Whether the chat is currently doing work — either processing a foreground message or running background/spawned-agent tasks