{"openapi":"3.1.0","info":{"title":"POST /api/v1/agents/roles/{role_id}/run","version":"1.0.0","description":"Hand a job to a role"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/agents/roles/{role_id}/run":{"post":{"tags":["agents"],"summary":"Hand a job to a role","description":"Start a run of this role. Refused when the role is disabled or paused (AGENT_004) or over its monthly spend cap (AGENT_006).","operationId":"agents_run_role","parameters":[{"name":"role_id","in":"path","required":true,"schema":{"type":"string","title":"Role Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-business-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Business-Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentRoleRunRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_AgentRunOut_"}}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"example":{"error":"validation_error","message":"Validation failed: due_date: Input should be a valid date","errors":{"due_date":"Input should be a valid date"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business","content":{"application/json":{"example":{"error":"unauthorized","message":"Authentication required","code":"AUTH_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"error":"forbidden","message":"You don't have permission to access this resource","code":"AUTH_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found - Resource does not exist","content":{"application/json":{"example":{"error":"not_found","message":"Resource not found","code":"NOT_FOUND_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict - Resource already exists or is in an incompatible state","content":{"application/json":{"example":{"error":"conflict","message":"Resource already exists","code":"CONFLICT_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"example":{"error":"service_unavailable","message":"The service is temporarily unavailable. Please try again later.","code":"GEN_004","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"validation_error","message":"Validation failed: amount: Input should be a valid integer","errors":{"amount":"Input should be a valid integer"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"}}}}},"x-fastapi-operation-id":"agents_run_role_api_v1_agents_roles__role_id__run_post"}}},"components":{"schemas":{"AgentRoleRunRequest":{"properties":{"brief":{"type":"string","maxLength":20000,"minLength":1,"title":"Brief"},"title":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Title"},"done_when":{"anyOf":[{"type":"string","maxLength":4000},{"type":"null"}],"title":"Done When"},"conversation_id":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Conversation Id"},"origin":{"type":"string","enum":["chat","regent","team","schedule","workflow","procedure","api","channel","handoff"],"title":"Origin","default":"api"},"period_id":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Period Id"},"checklist_item_key":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"Checklist Item Key"},"workflow_run_id":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Workflow Run Id"},"max_cost_usd":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Max Cost Usd","description":"Stop the run before a turn once it has cost this much (USD)."},"parent_run_id":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Parent Run Id","description":"An earlier run of this role this one follows up (bot chat)."}},"type":"object","required":["brief"],"title":"AgentRoleRunRequest","description":"``AgentRunCreate`` without ``role_id`` (the role is in the path)."},"AgentRunOut":{"properties":{"id":{"type":"string","title":"Id"},"business_id":{"type":"string","title":"Business Id"},"role_id":{"type":"string","title":"Role Id"},"role_name":{"type":"string","title":"Role Name","default":""},"requester_user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Requester User Id"},"conversation_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Conversation Id"},"origin":{"type":"string","enum":["chat","regent","team","schedule","workflow","procedure","api","channel","handoff"],"title":"Origin"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"brief":{"type":"string","title":"Brief"},"done_when":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Done When"},"status":{"type":"string","enum":["queued","running","needs_input","completed","failed","cancelled"],"title":"Status"},"outcome":{"anyOf":[{"type":"string","enum":["ok","error","stalled","expired","refused","interrupted","stopped","budget"]},{"type":"null"}],"title":"Outcome"},"outcome_detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Outcome Detail"},"result":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Result"},"verification":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Verification"},"engine":{"type":"string","enum":["native","claude_code","codex"],"title":"Engine"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model"},"account_label":{"type":"string","title":"Account Label","default":""},"cost_usd":{"type":"string","title":"Cost Usd","default":"0"},"max_cost_usd":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Max Cost Usd"},"tokens_prompt":{"type":"integer","title":"Tokens Prompt","default":0},"tokens_completion":{"type":"integer","title":"Tokens Completion","default":0},"tool_calls":{"type":"integer","title":"Tool Calls","default":0},"pending_change_ids":{"items":{"type":"string"},"type":"array","title":"Pending Change Ids"},"executions":{"type":"integer","title":"Executions","default":0},"question":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Question"},"period_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Period Id"},"checklist_item_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Checklist Item Key"},"workflow_run_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workflow Run Id"},"parent_run_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Run Id"},"open_cards":{"type":"integer","title":"Open Cards","default":0},"started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Started At"},"finished_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Finished At"},"last_event_seq":{"type":"integer","title":"Last Event Seq","default":0},"chat_message_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Chat Message Id"},"chat_message_persisted":{"type":"boolean","title":"Chat Message Persisted","default":false},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"activity":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Activity","description":"What an open run is doing now: its latest progress line, tool call or proposal, or the question it waits on. Null once closed."},"activity_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Activity At"},"channel_post_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Channel Post Id","description":"The Team chat post that shows this run (follow-ups share their root's)."},"handoff_from_run_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Handoff From Run Id","description":"The run a teammate handed this job from (origin handoff)."}},"type":"object","required":["id","business_id","role_id","origin","brief","status","engine","created_at","updated_at"],"title":"AgentRunOut"},"SuccessEnvelope_AgentRunOut_":{"properties":{"success":{"type":"boolean","title":"Success","default":true},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"data":{"anyOf":[{"$ref":"#/components/schemas/AgentRunOut"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[AgentRunOut]"},"ErrorResponse":{"title":"ErrorResponse","type":"object","description":"Envelope returned by every non-2xx response. Branch on `code` (stable) rather than `message` (human-readable, may change).","required":["error","message","code"],"properties":{"error":{"type":"string","description":"Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`."},"message":{"type":"string","description":"Human-readable explanation, safe to show to end users."},"code":{"type":"string","description":"Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`)."},"request_id":{"type":"string","description":"Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied."},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"Field-level validation messages keyed by field name. Present on 400/422 validation failures only."}}}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}