Skip to main content
POST
Stop an agent

Authorizations

Authorization
string
header
required

The permit the user approved for your app.

Path Parameters

session_id
string
required
Example:

"ses_2f81c0de-5a7b-4c3d-9e1f-0a2b3c4d5e6f"

Response

OK

An agent running for the user on one wallet or on paper money.

id
string
required

The session's id, starting with ses_.

agent
string
required

The agent it runs, starting with agt_.

name
string
required

The agent's name.

status
required

The agent is running on its own schedule.

Allowed value: "running"
started_at
string<date-time>
required

When the session started.

wallet
string | null

The wallet it trades, starting with wal_. Null when it runs on paper money.

value_usd
string | null

The current value of what the session holds, in USD as a decimal string. Null until Circuit first values a new session, about a minute after it starts, or when a holding can't be priced.

pnl_usd
string | null

Profit or loss since the session started, in USD as a decimal string. Null when unknown.

error
string | null

What the user needs to do when status is needs_user. Null otherwise.