API ReferenceAgent runs
Cancel an agent run
A queued run stops now and its held credits are given back. A running one stops at its next checkpoint; credits for the work already done are charged. A finished run is returned unchanged.
Authorization
api-key AuthorizationBearer <token>
Workspace API key (nim_live_...)
In: header
Path Parameters
id*string
Format
uuidResponse Body
application/json
curl -X POST "https://example.com/v1/agent-runs/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel"{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "agentId": "bc309ecf-5f66-4057-93c5-6611cc9cb7b2", "status": "PENDING", "trigger": "MANUAL", "creditsLocked": 0, "creditsUsed": 0, "error": "string", "startedAt": "string", "completedAt": "string", "createdAt": "string", "outputs": { "postIds": [ "string" ], "designIds": [ "string" ], "ideaIds": [ "string" ] }}Empty
Empty
Empty