Skip to main content
GET
Get a proposal

Authorizations

Authorization
string
header
required

The permit the user approved for your app.

Path Parameters

proposal_id
string
required
Example:

"prop_cd968859-fe26-4c0a-953e-34a3ab68171b"

Response

OK

Something Ask proposed, such as a trade or an agent start, that waits for your approval.

id
string
required

The proposal's id, starting with prop_.

title
string
required

What it does, starting with a verb, such as "Buy 0.04 ETH on Lighter" or "Start Macro Trend".

status
required

Waiting for you to approve or decline it.

Allowed value: "review"
amounts
object[]
required

The amounts it shows the user on Circuit: what it moves, or for USD what it spends or its notional. Empty when it shows none.

error
string | null

Why it failed when status is failed. Null otherwise.

session
string | null

The session it started or changed, starting with ses_. Null for trades.

retry_after_ms
integer<uint64> | null

While Circuit is carrying it out, how many milliseconds to wait before reading it again. Null otherwise.

Required range: x >= 0