API ReferenceAgents
Run an agent now
Starts a run and returns 202 with it; poll GET /v1/agent-runs/{id}?wait=25 until it is COMPLETED, FAILED or CANCELLED. Spends AI credits (only what the run uses). What the agent makes lands as posts waiting for approval — nothing is published without an approve call. Inbox agents cannot be run by hand. Paid plans and trials only. Needs a workspace owner, admin or editor.
Authorization
api-key AuthorizationBearer <token>
Workspace API key (nim_live_...)
In: header
Path Parameters
id*string
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/v1/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08/runs" \ -H "Content-Type: application/json" \ -d '{}'{ "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
Empty
Empty
Empty