{ "openapi": "3.1.0", "info": { "title": "LightHouse API", "version": "0.1.0", "description": "LightHouse's HTTP API, served by the Atlantic Agentic Labs control plane. Each client's portal is `https://.atlanticagenticlabs.com`; every request is authenticated by Cloudflare Access (people) or a machine key, and scoped to one tenant by row-level security. Approvals and payments are people-only: a machine key is refused on every approving or paying route." }, "paths": { "/api/v1/runs/active": { "get": { "summary": "Active Runs", "operationId": "active_runs_api_v1_runs_active_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": {}, "example": { "as_of": "2026-10-30T09:00:00Z", "stall_after_s": 300, "live": { "available": true, "deployments": [ { "deployment": "example-air-prod", "live": true, "last_live_at": "2026-10-30T08:59:58Z" } ], "needs": { "engine": "0.34.0", "revision": "1.12" } }, "runs": [ { "run_id_hash": "3f9a0c1e", "agent": "research:summary", "pack": "research", "card": "summary", "deployment": "example-air-prod", "started_at": "2026-10-30T08:58:10Z", "last_seen_at": "2026-10-30T08:59:55Z", "elapsed_ms": 110000, "state": "running", "status": null, "attempt": 1, "trigger": "schedule", "by_hash": null, "current_step": { "name": "summarise", "kind": "model_call", "span": "a1b2", "started_at": "2026-10-30T08:59:40Z" }, "steps": { "started": 4, "finished": 3 }, "tokens": { "input": 5210, "output": 840, "cache_read": 4096, "cache_write": 0 }, "cost_usd": 0.0213, "estimated": false, "calls": 3, "approvals_waiting": 0 } ] } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/runs/active/stream": { "get": { "summary": "Active Stream", "operationId": "active_stream_api_v1_runs_active_stream_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": {} } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/agents/last-runs": { "get": { "summary": "Last Runs", "operationId": "last_runs_api_v1_agents_last_runs_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Last Runs Api V1 Agents Last Runs Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/runs/{run_id_hash}/map": { "get": { "summary": "Run Map", "operationId": "run_map_api_v1_runs__run_id_hash__map_get", "parameters": [ { "name": "run_id_hash", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id Hash" } } ], "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Run Map Api V1 Runs Run Id Hash Map Get" } } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/me": { "get": { "summary": "Me", "operationId": "me_api_v1_me_get", "responses": { "200": { "description": "The client, the viewer and more (example abridged)", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Me Api V1 Me Get" }, "example": { "contract": 1, "contract_revision": "1.15", "client": { "slug": "example-air", "name": "Example Air", "logo_url": null, "tenant_id": "k7q2m9xw", "portal_host": "k7q2m9xw", "hostname": "k7q2m9xw.atlanticagenticlabs.com", "portal_url": "https://k7q2m9xw.atlanticagenticlabs.com/" }, "viewer": { "email": "ops@example.test", "name": "Ops Viewer", "provider": { "kind": "microsoft", "name": "Microsoft" }, "kind": "client", "role": "viewer", "mfa": { "verified": true, "source": "provider" } }, "deployments": [] } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "People and preferences" ] } }, "/api/v1/usage": { "get": { "summary": "Usage", "operationId": "usage_api_v1_usage_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Usage Api V1 Usage Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/runs": { "get": { "summary": "Runs", "operationId": "runs_api_v1_runs_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Runs Api V1 Runs Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/runs/{run_id_hash}": { "get": { "summary": "One Run", "operationId": "one_run_api_v1_runs__run_id_hash__get", "parameters": [ { "name": "run_id_hash", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id Hash" } } ], "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response One Run Api V1 Runs Run Id Hash Get" } } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/runs/{run_id_hash}/trace": { "get": { "summary": "Trace", "operationId": "trace_api_v1_runs__run_id_hash__trace_get", "parameters": [ { "name": "run_id_hash", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id Hash" } } ], "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Trace Api V1 Runs Run Id Hash Trace Get" } } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/refusals": { "get": { "summary": "Refusals", "operationId": "refusals_api_v1_refusals_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Refusals Api V1 Refusals Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/evals": { "get": { "summary": "Evals", "operationId": "evals_api_v1_evals_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Evals Api V1 Evals Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/releases": { "get": { "summary": "Releases", "operationId": "releases_api_v1_releases_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Releases Api V1 Releases Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/health": { "get": { "summary": "Health", "operationId": "health_api_v1_health_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Health Api V1 Health Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/reports/{kind}": { "get": { "summary": "Report", "operationId": "report_api_v1_reports__kind__get", "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "title": "Kind" } } ], "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Report Api V1 Reports Kind Get" } } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/budgets": { "get": { "summary": "Budgets", "operationId": "budgets_api_v1_budgets_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Budgets Api V1 Budgets Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/preapprovals": { "get": { "summary": "Preapprovals", "operationId": "preapprovals_api_v1_preapprovals_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Preapprovals Api V1 Preapprovals Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/kills": { "get": { "summary": "Kills", "operationId": "kills_api_v1_kills_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Kills Api V1 Kills Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/grounding": { "get": { "summary": "Grounding", "operationId": "grounding_api_v1_grounding_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Grounding Api V1 Grounding Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/savings/retrieval": { "get": { "summary": "Retrieval Savings", "operationId": "retrieval_savings_api_v1_savings_retrieval_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Retrieval Savings Api V1 Savings Retrieval Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Savings and caching" ] } }, "/api/v1/retrieval": { "get": { "summary": "Retrieval Read", "operationId": "retrieval_read_api_v1_retrieval_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Retrieval Read Api V1 Retrieval Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/knowledge-bases": { "get": { "summary": "Kb List", "operationId": "kb_list_api_v1_knowledge_bases_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Kb List Api V1 Knowledge Bases Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/knowledge-bases/{index}": { "get": { "summary": "Kb One", "operationId": "kb_one_api_v1_knowledge_bases__index__get", "parameters": [ { "name": "index", "in": "path", "required": true, "schema": { "type": "string", "title": "Index" } } ], "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Kb One Api V1 Knowledge Bases Index Get" } } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/evidence": { "get": { "summary": "Evidence Read", "operationId": "evidence_read_api_v1_evidence_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Evidence Read Api V1 Evidence Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/forecast": { "get": { "summary": "Month Forecast", "operationId": "month_forecast_api_v1_forecast_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Month Forecast Api V1 Forecast Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/savings": { "get": { "summary": "Savings Ledger", "operationId": "savings_ledger_api_v1_savings_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Savings Ledger Api V1 Savings Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Savings and caching" ] } }, "/api/v1/savings/headline": { "get": { "summary": "Savings Headline", "operationId": "savings_headline_api_v1_savings_headline_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Savings Headline Api V1 Savings Headline Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Savings and caching" ] } }, "/api/v1/savings/settings": { "get": { "summary": "Get Savings Settings", "operationId": "get_savings_settings_api_v1_savings_settings_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Get Savings Settings Api V1 Savings Settings Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Savings and caching" ] }, "put": { "summary": "Put Savings Settings", "operationId": "put_savings_settings_api_v1_savings_settings_put", "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": { "title": "Response Put Savings Settings Api V1 Savings Settings Put" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Savings and caching" ] } }, "/api/v1/caching": { "get": { "summary": "Caching Read", "operationId": "caching_read_api_v1_caching_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Caching Read Api V1 Caching Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Savings and caching" ] } }, "/api/v1/rate-limits": { "get": { "summary": "Rate Limits Read", "operationId": "rate_limits_read_api_v1_rate_limits_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Rate Limits Read Api V1 Rate Limits Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Savings and caching" ] } }, "/api/v1/recommendations": { "get": { "summary": "Recs", "operationId": "recs_api_v1_recommendations_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Recs Api V1 Recommendations Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/change-requests": { "get": { "summary": "Change Requests", "operationId": "change_requests_api_v1_change_requests_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Change Requests Api V1 Change Requests Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] }, "post": { "summary": "Raise Change", "operationId": "raise_change_api_v1_change_requests_post", "responses": { "201": { "description": "Created: the new resource, as JSON.", "content": { "application/json": { "schema": { "title": "Response Raise Change Api V1 Change Requests Post" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/deployments/profiles": { "get": { "summary": "Deployment Profiles", "operationId": "deployment_profiles_api_v1_deployments_profiles_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Deployment Profiles Api V1 Deployments Profiles Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Deployments" ] } }, "/api/v1/deployments/profile-requests": { "get": { "summary": "Profile Requests", "operationId": "profile_requests_api_v1_deployments_profile_requests_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Profile Requests Api V1 Deployments Profile Requests Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Deployments" ] } }, "/api/v1/deployments/{deployment}/profile-requests": { "post": { "summary": "Request Profile", "operationId": "request_profile_api_v1_deployments__deployment__profile_requests_post", "parameters": [ { "name": "deployment", "in": "path", "required": true, "schema": { "type": "string", "title": "Deployment" } } ], "responses": { "201": { "description": "Created: the new resource, as JSON.", "content": { "application/json": { "schema": { "title": "Response Request Profile Api V1 Deployments Deployment Profile Requests Post" } } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Deployments" ] } }, "/api/v1/content/{resource}": { "get": { "summary": "Content List", "operationId": "content_list_api_v1_content__resource__get", "parameters": [ { "name": "resource", "in": "path", "required": true, "schema": { "type": "string", "title": "Resource" } } ], "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Content in place" ] } }, "/api/v1/content/{resource}/{item_id}": { "get": { "summary": "Content Item", "operationId": "content_item_api_v1_content__resource___item_id__get", "parameters": [ { "name": "resource", "in": "path", "required": true, "schema": { "type": "string", "title": "Resource" } }, { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Item Id" } } ], "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Content in place" ] } }, "/api/v1/agents/{agent_id}/commands": { "post": { "summary": "Issue Command", "operationId": "issue_command_api_v1_agents__agent_id__commands_post", "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } } ], "responses": { "202": { "description": "Accepted: recorded and queued. It is carried out after this answer, not before it.", "content": { "application/json": { "schema": {}, "example": { "command_id": "0f1e2d3c4b5a69788796a5b4c3d2e1f0", "status": "queued", "agent": "research:summary", "deployment": "example-air-prod", "type": "agent.pause", "params": { "reason": "Supplier feed down" }, "reason": null, "detail": null, "issued_by": { "email": "handler@example.test", "role": "handler", "kind": "client" }, "flagged": false, "issued_at": "2026-10-30T09:00:00Z", "expires_at": "2026-10-30T09:05:00Z", "updated_at": "2026-10-30T09:00:00Z" } } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Handler commands" ], "requestBody": { "required": true, "content": { "application/json": { "example": { "type": "agent.pause", "params": { "reason": "Supplier feed down" }, "deployment": "example-air-prod", "ttl_s": 300 } } } } }, "get": { "summary": "Agent Commands", "operationId": "agent_commands_api_v1_agents__agent_id__commands_get", "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } } ], "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Agent Commands Api V1 Agents Agent Id Commands Get" } } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Handler commands" ] } }, "/api/v1/agents/{agent_id}/commands/{command_id}": { "get": { "summary": "One Command", "operationId": "one_command_api_v1_agents__agent_id__commands__command_id__get", "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "command_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Command Id" } } ], "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response One Command Api V1 Agents Agent Id Commands Command Id Get" } } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Handler commands" ] } }, "/api/v1/commands": { "get": { "summary": "All Commands", "operationId": "all_commands_api_v1_commands_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response All Commands Api V1 Commands Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Handler commands" ] } }, "/api/v1/commands/{command_id}": { "get": { "summary": "A Command", "operationId": "a_command_api_v1_commands__command_id__get", "parameters": [ { "name": "command_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Command Id" } } ], "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response A Command Api V1 Commands Command Id Get" } } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Handler commands" ] } }, "/api/v1/approvals/decisions": { "post": { "summary": "Decide", "description": "An approval screen that is not per agent: the same command as\n`approval.decide` on `/agents/{agent}/commands`.", "operationId": "decide_api_v1_approvals_decisions_post", "responses": { "202": { "description": "Accepted: recorded and queued. It is carried out after this answer, not before it.", "content": { "application/json": { "schema": {} } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Handler commands" ], "requestBody": { "required": true, "content": { "application/json": { "example": { "agent": "research:summary", "run_id": "run-0001", "decision": "approve", "reason": "Checked against the source pack", "evidence_sha256": "9f86d081884c7d65...", "deployment": "example-air-prod", "ttl_s": 300 } } } } } }, "/api/v1/command-settings": { "get": { "summary": "Get Command Settings", "operationId": "get_command_settings_api_v1_command_settings_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Get Command Settings Api V1 Command Settings Get" }, "example": { "enabled": true, "types": { "agent.pause": true, "approval.decide": true }, "staff_may_issue": false, "version": "3", "available": true, "key_id": "cmd-2026-10", "types_known": [ "agent.pause", "agent.resume", "approval.decide" ], "deployments": [] } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Handler commands" ] }, "put": { "summary": "Put Command Settings", "operationId": "put_command_settings_api_v1_command_settings_put", "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": { "title": "Response Put Command Settings Api V1 Command Settings Put" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Handler commands" ] } }, "/api/v1/access": { "get": { "summary": "Get Access", "operationId": "get_access_api_v1_access_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Get Access Api V1 Access Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Access and keys" ] }, "put": { "summary": "Put Access", "operationId": "put_access_api_v1_access_put", "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": { "title": "Response Put Access Api V1 Access Put" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Access and keys" ] } }, "/api/v1/access/review": { "get": { "summary": "Review", "operationId": "review_api_v1_access_review_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": {} } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Access and keys" ] } }, "/api/v1/keys": { "get": { "summary": "List Keys", "operationId": "list_keys_api_v1_keys_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response List Keys Api V1 Keys Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Access and keys" ] }, "post": { "summary": "Issue Key", "operationId": "issue_key_api_v1_keys_post", "responses": { "201": { "description": "Created: the new resource, as JSON.", "content": { "application/json": { "schema": {} } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Access and keys" ] } }, "/api/v1/keys/{key_id}": { "delete": { "summary": "Revoke Key", "operationId": "revoke_key_api_v1_keys__key_id__delete", "parameters": [ { "name": "key_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Key Id" } } ], "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": { "title": "Response Revoke Key Api V1 Keys Key Id Delete" } } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Access and keys" ] } }, "/api/v1/agents": { "get": { "summary": "Agents List", "operationId": "agents_list_api_v1_agents_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Agents List Api V1 Agents Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/agents/graph": { "get": { "summary": "Agents Graph", "operationId": "agents_graph_api_v1_agents_graph_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Agents Graph Api V1 Agents Graph Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/agents/{agent_id}": { "get": { "summary": "Agent One", "operationId": "agent_one_api_v1_agents__agent_id__get", "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } } ], "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Agent One Api V1 Agents Agent Id Get" } } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/agent-map": { "get": { "summary": "Agent Map", "operationId": "agent_map_api_v1_agent_map_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Agent Map Api V1 Agent Map Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/attention": { "get": { "summary": "Attention", "operationId": "attention_api_v1_attention_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Attention Api V1 Attention Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/library": { "get": { "summary": "Library List", "operationId": "library_list_api_v1_library_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Library List Api V1 Library Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Marketplace" ] } }, "/api/v1/library/{namespace}/{name}": { "get": { "summary": "Library Card", "operationId": "library_card_api_v1_library__namespace___name__get", "parameters": [ { "name": "namespace", "in": "path", "required": true, "schema": { "type": "string", "title": "Namespace" } }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } } ], "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Library Card Api V1 Library Namespace Name Get" } } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Marketplace" ] } }, "/api/v1/library/{namespace}/{name}/add": { "post": { "summary": "Library Add", "operationId": "library_add_api_v1_library__namespace___name__add_post", "parameters": [ { "name": "namespace", "in": "path", "required": true, "schema": { "type": "string", "title": "Namespace" } }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } } ], "responses": { "201": { "description": "Created: the new resource, as JSON.", "content": { "application/json": { "schema": { "title": "Response Library Add Api V1 Library Namespace Name Add Post" } } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Marketplace" ] } }, "/api/v1/agent-requests": { "get": { "summary": "Agent Requests", "operationId": "agent_requests_api_v1_agent_requests_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Agent Requests Api V1 Agent Requests Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/models": { "get": { "summary": "Models", "operationId": "models_api_v1_models_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Models Api V1 Models Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/market/listings": { "get": { "summary": "Market Mine", "operationId": "market_mine_api_v1_market_listings_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Market Mine Api V1 Market Listings Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Marketplace" ] }, "post": { "summary": "Market Submit", "operationId": "market_submit_api_v1_market_listings_post", "responses": { "201": { "description": "Created: the new resource, as JSON.", "content": { "application/json": { "schema": { "title": "Response Market Submit Api V1 Market Listings Post" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Marketplace" ] } }, "/api/v1/market/listings/{listing_id}": { "get": { "summary": "Market Listing", "operationId": "market_listing_api_v1_market_listings__listing_id__get", "parameters": [ { "name": "listing_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Listing Id" } } ], "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Market Listing Api V1 Market Listings Listing Id Get" } } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Marketplace" ] } }, "/api/v1/market/listings/{listing_id}/logo": { "get": { "summary": "Market Logo", "operationId": "market_logo_api_v1_market_listings__listing_id__logo_get", "parameters": [ { "name": "listing_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Listing Id" } } ], "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Marketplace" ] } }, "/api/v1/market/listings/{listing_id}/withdraw": { "post": { "summary": "Market Withdraw", "operationId": "market_withdraw_api_v1_market_listings__listing_id__withdraw_post", "parameters": [ { "name": "listing_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Listing Id" } } ], "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": { "title": "Response Market Withdraw Api V1 Market Listings Listing Id Withdraw Post" } } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Marketplace" ] } }, "/api/v1/market/ledger": { "get": { "summary": "Market Ledger", "operationId": "market_ledger_api_v1_market_ledger_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Market Ledger Api V1 Market Ledger Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Marketplace" ] } }, "/api/v1/audit": { "get": { "summary": "Audit", "operationId": "audit_api_v1_audit_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Audit Api V1 Audit Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/branding": { "get": { "summary": "Get", "operationId": "get_api_v1_branding_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Get Api V1 Branding Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Branding" ] }, "put": { "summary": "Put", "operationId": "put_api_v1_branding_put", "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": { "title": "Response Put Api V1 Branding Put" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Branding" ] } }, "/api/v1/branding/preview": { "post": { "summary": "Preview", "description": "What a set of values would become, without saving: the colours as\nused in each theme and the stylesheet the portal would load.", "operationId": "preview_api_v1_branding_preview_post", "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": { "title": "Response Preview Api V1 Branding Preview Post" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Branding" ] } }, "/api/v1/branding/tokens.css": { "get": { "summary": "Tokens", "operationId": "tokens_api_v1_branding_tokens_css_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": {} } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Branding" ] } }, "/api/v1/branding/assets/{kind}": { "get": { "summary": "Asset", "operationId": "asset_api_v1_branding_assets__kind__get", "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "title": "Kind" } } ], "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Branding" ] }, "put": { "summary": "Put Asset", "operationId": "put_asset_api_v1_branding_assets__kind__put", "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "title": "Kind" } } ], "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": { "title": "Response Put Asset Api V1 Branding Assets Kind Put" } } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Branding" ] }, "delete": { "summary": "Delete Asset", "operationId": "delete_asset_api_v1_branding_assets__kind__delete", "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "title": "Kind" } } ], "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": { "title": "Response Delete Asset Api V1 Branding Assets Kind Delete" } } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Branding" ] } }, "/api/v1/billing": { "get": { "summary": "Summary", "operationId": "summary_api_v1_billing_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Summary Api V1 Billing Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Billing" ] } }, "/api/v1/billing/usage": { "get": { "summary": "Usage", "operationId": "usage_api_v1_billing_usage_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Usage Api V1 Billing Usage Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Billing" ] } }, "/api/v1/billing/reconciliation": { "get": { "summary": "Reconciliation", "operationId": "reconciliation_api_v1_billing_reconciliation_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Reconciliation Api V1 Billing Reconciliation Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Billing" ] } }, "/api/v1/billing/series": { "get": { "summary": "Spend Series", "operationId": "spend_series_api_v1_billing_series_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Spend Series Api V1 Billing Series Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Billing" ] } }, "/api/v1/billing/overview": { "get": { "summary": "Spend Overview", "operationId": "spend_overview_api_v1_billing_overview_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Spend Overview Api V1 Billing Overview Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Billing" ] } }, "/api/v1/billing/details": { "get": { "summary": "Details", "operationId": "details_api_v1_billing_details_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Details Api V1 Billing Details Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Billing" ] }, "put": { "summary": "Save Details", "operationId": "save_details_api_v1_billing_details_put", "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": { "title": "Response Save Details Api V1 Billing Details Put" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Billing" ] } }, "/api/v1/billing/tax-preview": { "post": { "summary": "Tax Preview", "operationId": "tax_preview_api_v1_billing_tax_preview_post", "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": { "title": "Response Tax Preview Api V1 Billing Tax Preview Post" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Billing" ] } }, "/api/v1/billing/checkout": { "post": { "summary": "Checkout", "operationId": "checkout_api_v1_billing_checkout_post", "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": { "title": "Response Checkout Api V1 Billing Checkout Post" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Billing" ] } }, "/api/v1/billing/checkout/{sid}": { "get": { "summary": "Checkout Status", "operationId": "checkout_status_api_v1_billing_checkout__sid__get", "parameters": [ { "name": "sid", "in": "path", "required": true, "schema": { "type": "string", "title": "Sid" } } ], "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Checkout Status Api V1 Billing Checkout Sid Get" } } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Billing" ] } }, "/api/v1/billing/payment-methods": { "get": { "summary": "Pms", "operationId": "pms_api_v1_billing_payment_methods_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Pms Api V1 Billing Payment Methods Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Billing" ] } }, "/api/v1/billing/payment-methods/{pm}/default": { "post": { "summary": "Pm Default", "operationId": "pm_default_api_v1_billing_payment_methods__pm__default_post", "parameters": [ { "name": "pm", "in": "path", "required": true, "schema": { "type": "string", "title": "Pm" } } ], "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": { "title": "Response Pm Default Api V1 Billing Payment Methods Pm Default Post" } } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Billing" ] } }, "/api/v1/billing/payment-methods/{pm}": { "delete": { "summary": "Pm Remove", "operationId": "pm_remove_api_v1_billing_payment_methods__pm__delete", "parameters": [ { "name": "pm", "in": "path", "required": true, "schema": { "type": "string", "title": "Pm" } } ], "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": { "title": "Response Pm Remove Api V1 Billing Payment Methods Pm Delete" } } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Billing" ] } }, "/api/v1/billing/invoices": { "get": { "summary": "Invoices", "operationId": "invoices_api_v1_billing_invoices_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Invoices Api V1 Billing Invoices Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Billing" ] } }, "/api/v1/billing/invoices/{iid}/pdf": { "get": { "summary": "Invoice Pdf", "operationId": "invoice_pdf_api_v1_billing_invoices__iid__pdf_get", "parameters": [ { "name": "iid", "in": "path", "required": true, "schema": { "type": "string", "title": "Iid" } } ], "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Invoice Pdf Api V1 Billing Invoices Iid Pdf Get" } } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Billing" ] } }, "/api/v1/billing/bank-transfer": { "get": { "summary": "Bank Transfer", "operationId": "bank_transfer_api_v1_billing_bank_transfer_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Bank Transfer Api V1 Billing Bank Transfer Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Billing" ] } }, "/api/v1/billing/receivables": { "get": { "summary": "Receivables", "operationId": "receivables_api_v1_billing_receivables_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Receivables Api V1 Billing Receivables Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Billing" ] } }, "/api/v1/billing/credits": { "get": { "summary": "Credits", "operationId": "credits_api_v1_billing_credits_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Credits Api V1 Billing Credits Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Billing" ] } }, "/api/v1/billing/credits/auto-recharge": { "put": { "summary": "Auto Recharge", "operationId": "auto_recharge_api_v1_billing_credits_auto_recharge_put", "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": { "title": "Response Auto Recharge Api V1 Billing Credits Auto Recharge Put" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Billing" ] } }, "/api/v1/billing/terms": { "get": { "summary": "Terms Read", "operationId": "terms_read_api_v1_billing_terms_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Terms Read Api V1 Billing Terms Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Billing" ] } }, "/api/v1/billing/terms/requests": { "post": { "summary": "Terms Request", "operationId": "terms_request_api_v1_billing_terms_requests_post", "responses": { "201": { "description": "Created: the new resource, as JSON.", "content": { "application/json": { "schema": { "title": "Response Terms Request Api V1 Billing Terms Requests Post" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Billing" ] } }, "/api/v1/billing/terms/{key}/accept": { "post": { "summary": "Terms Accept", "operationId": "terms_accept_api_v1_billing_terms__key__accept_post", "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string", "title": "Key" } } ], "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": { "title": "Response Terms Accept Api V1 Billing Terms Key Accept Post" } } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Billing" ] } }, "/api/v1/billing/vat": { "put": { "summary": "Vat Save", "operationId": "vat_save_api_v1_billing_vat_put", "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": { "title": "Response Vat Save Api V1 Billing Vat Put" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Billing" ] } }, "/api/v1/limits": { "get": { "summary": "Limits", "operationId": "limits_api_v1_limits_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Limits Api V1 Limits Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Billing" ] }, "post": { "summary": "Limit Add", "operationId": "limit_add_api_v1_limits_post", "responses": { "201": { "description": "Created: the new resource, as JSON.", "content": { "application/json": { "schema": { "title": "Response Limit Add Api V1 Limits Post" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Billing" ] } }, "/api/v1/limits/{lid}": { "put": { "summary": "Limit Change", "operationId": "limit_change_api_v1_limits__lid__put", "parameters": [ { "name": "lid", "in": "path", "required": true, "schema": { "type": "string", "title": "Lid" } } ], "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": { "title": "Response Limit Change Api V1 Limits Lid Put" } } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Billing" ] }, "delete": { "summary": "Limit Clear", "operationId": "limit_clear_api_v1_limits__lid__delete", "parameters": [ { "name": "lid", "in": "path", "required": true, "schema": { "type": "string", "title": "Lid" } } ], "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": { "title": "Response Limit Clear Api V1 Limits Lid Delete" } } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Billing" ] } }, "/api/v1/limits/{lid}/send": { "post": { "summary": "Limit Send", "operationId": "limit_send_api_v1_limits__lid__send_post", "parameters": [ { "name": "lid", "in": "path", "required": true, "schema": { "type": "string", "title": "Lid" } } ], "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": { "title": "Response Limit Send Api V1 Limits Lid Send Post" } } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Billing" ] } }, "/api/v1/limits/{lid}/mirror-confirmed": { "post": { "summary": "Limit Mirror", "operationId": "limit_mirror_api_v1_limits__lid__mirror_confirmed_post", "parameters": [ { "name": "lid", "in": "path", "required": true, "schema": { "type": "string", "title": "Lid" } } ], "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": { "title": "Response Limit Mirror Api V1 Limits Lid Mirror Confirmed Post" } } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Billing" ] } }, "/api/v1/providers": { "get": { "summary": "Provider List", "operationId": "provider_list_api_v1_providers_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Provider List Api V1 Providers Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Billing" ] }, "post": { "summary": "Provider Add", "operationId": "provider_add_api_v1_providers_post", "responses": { "201": { "description": "Created: the new resource, as JSON.", "content": { "application/json": { "schema": { "title": "Response Provider Add Api V1 Providers Post" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Billing" ] } }, "/api/v1/providers/{cid}": { "put": { "summary": "Provider Change", "operationId": "provider_change_api_v1_providers__cid__put", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } } ], "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": { "title": "Response Provider Change Api V1 Providers Cid Put" } } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Billing" ] }, "delete": { "summary": "Provider Remove", "operationId": "provider_remove_api_v1_providers__cid__delete", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } } ], "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": { "title": "Response Provider Remove Api V1 Providers Cid Delete" } } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Billing" ] } }, "/api/v1/providers/{cid}/test": { "post": { "summary": "Provider Test", "operationId": "provider_test_api_v1_providers__cid__test_post", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } } ], "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": { "title": "Response Provider Test Api V1 Providers Cid Test Post" } } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Billing" ] } }, "/api/v1/exports": { "get": { "summary": "Exports", "operationId": "exports_api_v1_exports_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": { "title": "Response Exports Api V1 Exports Get" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Exports" ] }, "post": { "summary": "Export", "operationId": "export_api_v1_exports_post", "responses": { "202": { "description": "Accepted: recorded and queued. It is carried out after this answer, not before it.", "content": { "application/json": { "schema": {} } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Exports" ] } }, "/api/v1/exports/{eid}": { "get": { "summary": "One", "operationId": "one_api_v1_exports__eid__get", "parameters": [ { "name": "eid", "in": "path", "required": true, "schema": { "type": "string", "title": "Eid" } } ], "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Exports" ] } }, "/api/v1/me/tours": { "get": { "summary": "Mine", "operationId": "mine_api_v1_me_tours_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": {} } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "People and preferences" ] } }, "/api/v1/me/tours/{tour}": { "put": { "summary": "Save", "operationId": "save_api_v1_me_tours__tour__put", "parameters": [ { "name": "tour", "in": "path", "required": true, "schema": { "type": "string", "title": "Tour" } } ], "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "People and preferences" ] } }, "/api/v1/me/profile": { "get": { "summary": "Mine", "operationId": "mine_api_v1_me_profile_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": {} } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "People and preferences" ] }, "put": { "summary": "Put Profile", "operationId": "put_profile_api_v1_me_profile_put", "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": {} } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "People and preferences" ] } }, "/api/v1/me/avatar": { "put": { "summary": "Put Avatar", "operationId": "put_avatar_api_v1_me_avatar_put", "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": {} } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "People and preferences" ] }, "delete": { "summary": "Delete Avatar", "operationId": "delete_avatar_api_v1_me_avatar_delete", "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": {} } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "People and preferences" ] } }, "/api/v1/people": { "get": { "summary": "List People", "operationId": "list_people_api_v1_people_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": {} } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "People and preferences" ] } }, "/api/v1/people/{pid}/avatar": { "get": { "summary": "Avatar", "operationId": "avatar_api_v1_people__pid__avatar_get", "parameters": [ { "name": "pid", "in": "path", "required": true, "schema": { "type": "string", "title": "Pid" } } ], "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "People and preferences" ] } }, "/api/v1/profile-settings": { "get": { "summary": "Get Settings", "operationId": "get_settings_api_v1_profile_settings_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": {} } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "People and preferences" ] }, "put": { "summary": "Put Settings", "operationId": "put_settings_api_v1_profile_settings_put", "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": {} } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "People and preferences" ] } }, "/api/v1/me/preferences": { "get": { "summary": "Mine", "operationId": "mine_api_v1_me_preferences_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": {} } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "People and preferences" ] }, "put": { "summary": "Save", "operationId": "save_api_v1_me_preferences_put", "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": {} } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "People and preferences" ] } }, "/api/v1/tenant/settings/locale": { "get": { "summary": "Tenant Get", "operationId": "tenant_get_api_v1_tenant_settings_locale_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": {} } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "People and preferences" ] }, "put": { "summary": "Tenant Put", "operationId": "tenant_put_api_v1_tenant_settings_locale_put", "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": {} } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "People and preferences" ] } }, "/api/v1/assistant": { "get": { "summary": "Status", "operationId": "status_api_v1_assistant_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": {} } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Assistant" ] } }, "/api/v1/assistant/settings": { "put": { "summary": "Save", "operationId": "save_api_v1_assistant_settings_put", "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": {} } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Assistant" ] } }, "/api/v1/assistant/chat": { "post": { "summary": "Chat", "operationId": "chat_api_v1_assistant_chat_post", "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": {} } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Assistant" ] } }, "/api/v1/run-targets": { "get": { "summary": "Get Targets", "operationId": "get_targets_api_v1_run_targets_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": {} } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] }, "put": { "summary": "Put Targets", "operationId": "put_targets_api_v1_run_targets_put", "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": {} } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/run-targets/stack": { "get": { "summary": "Get Stack", "operationId": "get_stack_api_v1_run_targets_stack_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": {} } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/run-targets/hosted-requests": { "get": { "summary": "Get Hosted", "operationId": "get_hosted_api_v1_run_targets_hosted_requests_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": {} } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] }, "post": { "summary": "Post Hosted", "operationId": "post_hosted_api_v1_run_targets_hosted_requests_post", "responses": { "201": { "description": "Created: the new resource, as JSON.", "content": { "application/json": { "schema": {} } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/run-targets/hosted-requests/{rid}": { "delete": { "summary": "Delete Hosted", "operationId": "delete_hosted_api_v1_run_targets_hosted_requests__rid__delete", "parameters": [ { "name": "rid", "in": "path", "required": true, "schema": { "type": "string", "title": "Rid" } } ], "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/models/picker": { "get": { "summary": "Get Picker", "operationId": "get_picker_api_v1_models_picker_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": {} } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] }, "put": { "summary": "Put Picker", "operationId": "put_picker_api_v1_models_picker_put", "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": {} } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/models/residency": { "put": { "summary": "Put Residency", "operationId": "put_residency_api_v1_models_residency_put", "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": {} } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/connectors": { "get": { "summary": "Get Connectors", "operationId": "get_connectors_api_v1_connectors_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": {} } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/connectors/callback": { "get": { "summary": "Get Callback", "operationId": "get_callback_api_v1_connectors_callback_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": {} } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/connectors/{connector}": { "get": { "summary": "Get Connector", "operationId": "get_connector_api_v1_connectors__connector__get", "parameters": [ { "name": "connector", "in": "path", "required": true, "schema": { "type": "string", "title": "Connector" } } ], "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/connectors/{connector}/approval": { "post": { "summary": "Post Approval", "operationId": "post_approval_api_v1_connectors__connector__approval_post", "parameters": [ { "name": "connector", "in": "path", "required": true, "schema": { "type": "string", "title": "Connector" } } ], "responses": { "201": { "description": "Created: the new resource, as JSON.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/connectors/{connector}/device": { "post": { "summary": "Post Device", "operationId": "post_device_api_v1_connectors__connector__device_post", "parameters": [ { "name": "connector", "in": "path", "required": true, "schema": { "type": "string", "title": "Connector" } } ], "responses": { "201": { "description": "Created: the new resource, as JSON.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/connectors/device/{user_code}": { "post": { "summary": "Post Device Approve", "operationId": "post_device_approve_api_v1_connectors_device__user_code__post", "parameters": [ { "name": "user_code", "in": "path", "required": true, "schema": { "type": "string", "title": "User Code" } } ], "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/connectors/{connector}/token": { "post": { "summary": "Post Token", "operationId": "post_token_api_v1_connectors__connector__token_post", "parameters": [ { "name": "connector", "in": "path", "required": true, "schema": { "type": "string", "title": "Connector" } } ], "responses": { "201": { "description": "Created: the new resource, as JSON.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/connections/{cid}/health": { "post": { "summary": "Post Health", "operationId": "post_health_api_v1_connections__cid__health_post", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } } ], "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/connections/{cid}/sync": { "post": { "summary": "Post Sync", "operationId": "post_sync_api_v1_connections__cid__sync_post", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } } ], "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/connections/{cid}": { "delete": { "summary": "Delete Connection", "operationId": "delete_connection_api_v1_connections__cid__delete", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } } ], "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/connections/{cid}/outbound": { "put": { "summary": "Put Outbound", "operationId": "put_outbound_api_v1_connections__cid__outbound_put", "parameters": [ { "name": "cid", "in": "path", "required": true, "schema": { "type": "string", "title": "Cid" } } ], "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/setup": { "get": { "summary": "Get Setup", "operationId": "get_setup_api_v1_setup_get", "responses": { "200": { "description": "OK: the JSON document this route reads.", "content": { "application/json": { "schema": {} } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } }, "/api/v1/setup/{step}": { "put": { "summary": "Put Setup", "operationId": "put_setup_api_v1_setup__step__put", "parameters": [ { "name": "step", "in": "path", "required": true, "schema": { "type": "string", "title": "Step" } } ], "responses": { "200": { "description": "OK: the request was carried out. The answer is JSON.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad request, `bad_query`: a path or query parameter, or a body field, is missing or not valid.", "content": { "application/json": { "example": { "error": "bad_query", "message": "a parameter is not valid" } } } }, "4XX": { "description": "Refused: `{error, message}` with a fixed `error` code, listed under Errors.", "content": { "application/json": { "example": { "error": "role_required", "message": "this needs the client_admin role" } } } } }, "tags": [ "Read" ] } } }, "components": { "schemas": { "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" } }, "securitySchemes": { "cloudflareAccess": { "type": "apiKey", "in": "header", "name": "Cf-Access-Jwt-Assertion", "description": "A person's session: Cloudflare Access, MFA required." }, "machineKey": { "type": "http", "scheme": "bearer", "description": "A per-client key `aalcp-...` (viewer or content_viewer), with the client's Access service token at the edge. Never approves, decides or pays." } } }, "servers": [ { "url": "https://{client}.atlanticagenticlabs.com", "variables": { "client": { "default": "example-air" } } } ], "security": [ { "cloudflareAccess": [] }, { "machineKey": [] } ] }