Skip to main content
POST
Send a message (strict)

Authorizations

Authorization
string
header
required

A workspace API key (oc_…) or organization API key (oc_org_…). Workspace-scoped endpoints called with an organization key also need X-Workspace-Id.

Path Parameters

conversationId
string
required

Body

application/json
message
string
required
Maximum string length: 100000
attachmentIds
string[]

Ids of attachments staged with POST /conversations/{conversationId}/attachments.

Maximum array length: 5

Response

The queued turn

id
string
conversationId
string
status
enum<string>

joining is a follow-up waiting to steer into the active turn; joined means it did.

Available options:
queued,
dispatched,
running,
done,
failed,
aborted,
joining,
joined
source
string

web for API and dashboard turns; a channel provider id for channel turns; cron, watch, agent, greeting, or peer_task for platform-authored turns.

userId
string | null
message
string
error
string | null

Human-readable failure text for failed turns.

errorCode
string | null
usage
object | null

Token usage reported by the harness, when available.

followUpOfTurnId
string | null
startedAt
string<date-time> | null
finishedAt
string<date-time> | null
createdAt
string<date-time>
attachments
object[]