{"openapi":"3.1.0","info":{"title":"GET /api/v1/agents/engines","version":"1.0.0","description":"Engine status (superuser)"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/agents/engines":{"get":{"tags":["agents"],"summary":"Engine status (superuser)","description":"Which engines the agents worker can run, whether each is signed in, and whether a worker is online. Superusers only.","operationId":"agents_engines","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_EnginesStatusResponse_"}}}},"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"}}}},"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_engines_api_v1_agents_engines_get"}}},"components":{"schemas":{"EngineAccountOut":{"properties":{"engine":{"type":"string","enum":["native","claude_code","codex"],"title":"Engine"},"status":{"type":"string","enum":["none","pending","connected","error","revoked"],"title":"Status","default":"none"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"source":{"anyOf":[{"type":"string","enum":["worker","pasted","env"]},{"type":"null"}],"title":"Source"},"credential_kind":{"anyOf":[{"type":"string","enum":["token","api_key"]},{"type":"null"}],"title":"Credential Kind"},"connected_by_user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Connected By User Id"},"connected_by_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Connected By Name"},"connected_by_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Connected By Email"},"connected_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Connected At"},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At"},"last_used_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Used At"},"last_refreshed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Refreshed At"},"last_error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Error"},"sign_in":{"anyOf":[{"$ref":"#/components/schemas/EngineSignInState"},{"type":"null"}]},"credential_source":{"type":"string","enum":["account","environment","none"],"title":"Credential Source","description":"What the engine's runs use now.\n\n``account``: the stored, connected row. ``environment``: the worker's\nenvironment token (only when there is no row at all). ``none``:\nnothing usable; a disconnected, failed or pending row blocks runs\nuntil someone reconnects.","readOnly":true}},"type":"object","required":["engine","credential_source"],"title":"EngineAccountOut","description":"The firm's stored sign-in for a CLI engine (never the credential itself)."},"EngineSignInState":{"properties":{"verification_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Verification Url","description":"Open this in a browser and sign in to the firm account."},"user_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Code","description":"Codex: the one-time code to enter on that page."},"awaiting_code":{"type":"boolean","title":"Awaiting Code","description":"Claude Code: the browser showed a code instead of redirecting; paste it with POST /engines/{engine}/sign-in/code.","default":false},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Started At"}},"type":"object","title":"EngineSignInState","description":"What a person must do to finish a sign-in running on the worker."},"EngineStatus":{"properties":{"engine":{"type":"string","enum":["native","claude_code","codex"],"title":"Engine"},"label":{"type":"string","title":"Label"},"available":{"type":"boolean","title":"Available","description":"The engine's CLI is installed on the worker (native: always)."},"signed_in":{"type":"boolean","title":"Signed In","description":"A firm account or key is configured for it."},"account_label":{"type":"string","title":"Account Label","default":""},"default_model":{"type":"string","title":"Default Model"},"models":{"items":{"type":"string"},"type":"array","title":"Models"},"staff_only":{"type":"boolean","title":"Staff Only","default":false},"detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Detail"},"token_expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Token Expires At"},"version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version"},"account":{"anyOf":[{"$ref":"#/components/schemas/EngineAccountOut"},{"type":"null"}]}},"type":"object","required":["engine","label","available","signed_in","default_model"],"title":"EngineStatus"},"EnginesStatusResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/EngineStatus"},"type":"array","title":"Items"},"worker_online":{"type":"boolean","title":"Worker Online"},"worker_detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Worker Detail"},"default_model":{"type":"string","title":"Default Model"},"workers":{"items":{"$ref":"#/components/schemas/WorkerStatus"},"type":"array","title":"Workers"}},"type":"object","required":["items","worker_online","default_model"],"title":"EnginesStatusResponse"},"SuccessEnvelope_EnginesStatusResponse_":{"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/EnginesStatusResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[EnginesStatusResponse]"},"WorkerStatus":{"properties":{"profile":{"type":"string","enum":["agents","browser"],"title":"Profile"},"host":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Host"},"at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"At","description":"Last heartbeat."},"online":{"type":"boolean","title":"Online","default":false},"browser_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Browser Version","description":"Chromium version (browser worker only)."}},"type":"object","required":["profile"],"title":"WorkerStatus","description":"One agents worker profile's last heartbeat."},"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":[]}]}