Skip to main content
POST
Send a message

Authorizations

Authorization
string
header
required

The permit the user approved for your app.

Headers

idempotency-key
string<uuid>

Optional. A UUID your app generates for this request. Send the same value when you retry, and Circuit returns the first result instead of acting twice. Reusing a key with different contents returns 409. Without a key, a retried request can act twice.

Body

application/json
text
string
required

What the user wrote.

Example:

"Start Macro Trend on paper money"

chat
string | null

The chat to continue, starting with chat_. Null starts a new chat.

Example:

null

Response

OK

One message in a chat and Ask's reply to it.

id
string
required

The message's id, starting with msg_.

status
required

Ask is still writing its reply.

Allowed value: "working"
proposals
object[]
required

Trades, agent starts and top-ups that Ask proposed in this reply. Each needs your approval.

chat
string | null

The chat it belongs to, starting with chat_. Null for a message sent before the user linked your app; those messages stand alone.

text
string | null

What the user wrote. Null when Circuit followed up on its own.

reply
string | null

Ask's reply in Markdown. Null while Ask is still working.