API ReferenceAgents

Stop a run

Stops the run, explicitly and on the record. This is the only control an api key has over its own run, by design: stopping only ever reduces what an agent does, so it cannot be used to escalate. Approving and resuming stay member-token operations.

POST
/{appUid}/agent/runs/{runUid}/abort

Authorization

bearerAuth
AuthorizationBearer <token>

Authorization for API

In: header

Path Parameters

runUid*string

The run handle returned by POST /agent/invoke.

appUid*string

Your app's unique id. Find it in the console under the app's Settings, or in the URL of any app page.

Formatuuid

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/497f6eca-6276-4993-bfeb-53cbbbba6f08/agent/runs/string/abort"
{  "runUid": "string",  "status": "string",  "resumable": true,  "message": "string",  "pendingSteps": [    {      "stepIndex": 0,      "tool": "string",      "riskLevel": "string",      "input": {}    }  ],  "steps": [    {      "stepIndex": 0,      "tool": "string",      "status": "string",      "output": {},      "detail": "string"    }  ],  "actions": {    "poll": "string",    "dashboard": "string"  }}

Get a run

Follow a long-running task, and fetch its outcome after an administrator approves a paused step.

List tools

The key's toolbox — the same set the agent itself sees, derived from the policies bound to its role. Nothing here is configured as a tool list: it is what the agent is *permitted* to do, projected into tool descriptors. Equivalent to MCP `tools/list`.