Skip to main content
POST
Stop or run an agent

Authorizations

Authorization
string
header
required

The permit the user approved for your app.

Headers

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

Path Parameters

agentId
string
required

Body

application/json
control
enum<string>
required
Available options:
stop,
runNow

Response

OK

id
string
required

Starts with agt_.

name
string
required
state
string
required

running, actionNeeded (see message) or stopped.

startedAt
string<date-time>
required
controls
string[]
required

What your app may send now: stop, runNow.

walletId
string | null

The picked wallet the agent trades; null on paper money.

message
string | null
valueUsd
string | null
pnlUsd
string | null