Skip to main content
POST
Send a message to Ask Circuit

Authorizations

Authorization
string
header
required

The permit the user approved for your app.

Headers

circuit-partner-version
string
required
Allowed value: "0.1"

Body

application/json
conversationId
string<uuid>
required

A UUID your app picks per conversation; later messages with it continue it.

messageId
string<uuid>
required

A UUID your app picks once per message and reuses on retries.

text
string
required

Response

OK

id
string<uuid>
required

The messageId that asked, or Circuit's own follow-up.

state
string
required

pending, done or failed.

actions
object[]
required
text
string | null

What the user asked; null on Circuit's own follow-ups.

message
string | null

Circuit's reply or why it failed, in Markdown; null while it is working.