Skip to main content
POST
Create a conversation

Authorizations

Authorization
string
header
required

A Custral secret API key (sk_…), created in Settings → Applications. Sent as Authorization: Bearer sk_…. The X-Api-Key: sk_… header is also accepted and takes precedence. Never expose a secret key in a browser.

Body

application/json

The body of a create-conversation request.

title
string
Example:

"Jane Doe"

sourceType
string

Free-form source label. Defaults to api.

Example:

"imessage"

channelId
string | null

A channel (chan_…) to attach to.

status
enum<string>
default:open
Available options:
open,
closed,
completed
participants
object[]
messages
object[]

Response

The created conversation (detail shape).

data
object

A conversation. messages + participants are present on retrieve/create and absent from list rows.

reqId
string

A per-request id (req_…). Quote it to support when reporting a problem.

Example:

"req_2a1f9c8e7b6d5"