{ "openapi": "3.1.0", "info": { "title": "Obra Gateway", "version": "3.7.7" }, "paths": { "/api": { "get": { "tags": [ "discovery" ], "summary": "Get Capabilities", "description": "Return a lightweight capabilities manifest built from registered routes.", "operationId": "get_capabilities_api_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Get Capabilities Api Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/automation/runs": { "post": { "tags": [ "automation" ], "summary": "Launch Automation Run", "operationId": "launch_automation_run_api_automation_runs_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationRunStartRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Launch Automation Run Api Automation Runs Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/automation/runs/{run_id}": { "get": { "tags": [ "automation" ], "summary": "Get Automation Run", "operationId": "get_automation_run_api_automation_runs__run_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Automation Run Api Automation Runs Run Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/automation/runs/{run_id}/events": { "get": { "tags": [ "automation" ], "summary": "Watch Automation Run", "operationId": "watch_automation_run_api_automation_runs__run_id__events_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } }, { "name": "filter", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filter" } }, { "name": "after_sequence", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "After Sequence" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Watch Automation Run Api Automation Runs Run Id Events Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/automation/runs/{run_id}/cancel": { "post": { "tags": [ "automation" ], "summary": "Cancel Automation Run", "operationId": "cancel_automation_run_api_automation_runs__run_id__cancel_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } }, { "name": "X-Obra-Client-Request-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Obra-Client-Request-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Cancel Automation Run Api Automation Runs Run Id Cancel Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/automation/runs/{run_id}/actions": { "post": { "tags": [ "automation" ], "summary": "Act On Automation Run", "operationId": "act_on_automation_run_api_automation_runs__run_id__actions_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } }, { "name": "X-Obra-Client-Request-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Obra-Client-Request-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationActionRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Act On Automation Run Api Automation Runs Run Id Actions Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/automation/derivations": { "post": { "tags": [ "automation" ], "summary": "Launch Automation Derivation", "operationId": "launch_automation_derivation_api_automation_derivations_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationDerivationStartRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Launch Automation Derivation Api Automation Derivations Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/automation/derivations/{derivation_id}": { "get": { "tags": [ "automation" ], "summary": "Get Automation Derivation", "operationId": "get_automation_derivation_api_automation_derivations__derivation_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "derivation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Derivation Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Automation Derivation Api Automation Derivations Derivation Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/automation/derivations/{derivation_id}/events": { "get": { "tags": [ "automation" ], "summary": "Watch Automation Derivation", "operationId": "watch_automation_derivation_api_automation_derivations__derivation_id__events_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "derivation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Derivation Id" } }, { "name": "filter", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filter" } }, { "name": "after_sequence", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "After Sequence" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Watch Automation Derivation Api Automation Derivations Derivation Id Events Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/automation/derivations/{derivation_id}/cancel": { "post": { "tags": [ "automation" ], "summary": "Cancel Automation Derivation", "operationId": "cancel_automation_derivation_api_automation_derivations__derivation_id__cancel_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "derivation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Derivation Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Cancel Automation Derivation Api Automation Derivations Derivation Id Cancel Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/automation/derivations/{derivation_id}/actions": { "post": { "tags": [ "automation" ], "summary": "Act On Automation Derivation", "operationId": "act_on_automation_derivation_api_automation_derivations__derivation_id__actions_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "derivation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Derivation Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationActionRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Act On Automation Derivation Api Automation Derivations Derivation Id Actions Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/automation/bootstrap-template": { "get": { "tags": [ "automation" ], "summary": "Get Automation Bootstrap Template", "operationId": "get_automation_bootstrap_template_api_automation_bootstrap_template_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Get Automation Bootstrap Template Api Automation Bootstrap Template Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/assistant/pipelines": { "get": { "tags": [ "assistant" ], "summary": "List Pipelines", "description": "List built-in assistant pipelines.", "operationId": "list_pipelines_api_assistant_pipelines_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response List Pipelines Api Assistant Pipelines Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/assistant/pipelines/active": { "get": { "tags": [ "assistant" ], "summary": "List Active Pipelines", "description": "List retained pipeline sessions in authoritative server order.", "operationId": "list_active_pipelines_api_assistant_pipelines_active_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "thread_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Thread Id" } }, { "name": "workflow_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workflow Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "title": "Response List Active Pipelines Api Assistant Pipelines Active Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/assistant/proposals/operations": { "get": { "tags": [ "assistant" ], "summary": "List Assistant Proposal Operations", "description": "List workflow-scoped assistant proposal operations.", "operationId": "list_assistant_proposal_operations_api_assistant_proposals_operations_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workflow Id" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Status" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Assistant Proposal Operations Api Assistant Proposals Operations Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/assistant/readiness-health": { "get": { "tags": [ "assistant" ], "summary": "Get Assistant Readiness Health", "description": "Return the read-only assistant readiness canary SLI report.", "operationId": "get_assistant_readiness_health_api_assistant_readiness_health_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Get Assistant Readiness Health Api Assistant Readiness Health Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/assistant/proposals/operations/apply-all": { "post": { "tags": [ "assistant" ], "summary": "Apply All Assistant Proposal Operations", "description": "Apply every pending proposal operation for one workflow server-side.", "operationId": "apply_all_assistant_proposal_operations_api_assistant_proposals_operations_apply_all_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProposalOperationsApplyAllRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Apply All Assistant Proposal Operations Api Assistant Proposals Operations Apply All Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/assistant/proposals/operations/{operation_id}/apply": { "post": { "tags": [ "assistant" ], "summary": "Apply Assistant Proposal Operation", "description": "Apply a projected assistant proposal operation through batch execution.", "operationId": "apply_assistant_proposal_operation_api_assistant_proposals_operations__operation_id__apply_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "operation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Operation Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProposalOperationApplyRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Apply Assistant Proposal Operation Api Assistant Proposals Operations Operation Id Apply Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/assistant/proposals/operations/{operation_id}/re-apply": { "post": { "tags": [ "assistant" ], "summary": "Reapply Assistant Proposal Operation", "description": "Re-apply a projected assistant proposal operation through batch execution.", "operationId": "reapply_assistant_proposal_operation_api_assistant_proposals_operations__operation_id__re_apply_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "operation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Operation Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProposalOperationReApplyRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Reapply Assistant Proposal Operation Api Assistant Proposals Operations Operation Id Re Apply Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/assistant/proposals/operations/{operation_id}/dismiss": { "post": { "tags": [ "assistant" ], "summary": "Dismiss Assistant Proposal Operation", "description": "Dismiss a projected assistant proposal operation.", "operationId": "dismiss_assistant_proposal_operation_api_assistant_proposals_operations__operation_id__dismiss_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "operation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Operation Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProposalOperationDismissRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Dismiss Assistant Proposal Operation Api Assistant Proposals Operations Operation Id Dismiss Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/assistant/pipelines/{pipeline_id}": { "get": { "tags": [ "assistant" ], "summary": "Get Pipeline", "description": "Return one assistant pipeline definition.", "operationId": "get_pipeline_api_assistant_pipelines__pipeline_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "pipeline_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Pipeline Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Pipeline Api Assistant Pipelines Pipeline Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/assistant/threads": { "post": { "tags": [ "assistant" ], "summary": "Create Thread", "operationId": "create_thread_api_assistant_threads_post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateThreadRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Thread Api Assistant Threads Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "assistant" ], "summary": "List Threads", "description": "List threads for an explicit project id or working directory.", "operationId": "list_threads_api_assistant_threads_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Id" } }, { "name": "working_dir", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Working Dir" } }, { "name": "archived", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Archived" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Threads Api Assistant Threads Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/assistant/threads/{thread_id}": { "get": { "tags": [ "assistant" ], "summary": "Get Thread", "operationId": "get_thread_api_assistant_threads__thread_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "thread_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Thread Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Thread Api Assistant Threads Thread Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "assistant" ], "summary": "Update Thread", "operationId": "update_thread_api_assistant_threads__thread_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "thread_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Thread Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateThreadRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Thread Api Assistant Threads Thread Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "assistant" ], "summary": "Delete Thread", "operationId": "delete_thread_api_assistant_threads__thread_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "thread_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Thread Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Thread Api Assistant Threads Thread Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/assistant/threads/{thread_id}/restore": { "post": { "tags": [ "assistant" ], "summary": "Restore Thread", "operationId": "restore_thread_api_assistant_threads__thread_id__restore_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "thread_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Thread Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Restore Thread Api Assistant Threads Thread Id Restore Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/assistant/threads/{thread_id}/carry-forward": { "post": { "tags": [ "assistant" ], "summary": "Carry Forward Thread", "operationId": "carry_forward_thread_api_assistant_threads__thread_id__carry_forward_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "thread_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Thread Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarryForwardThreadRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Carry Forward Thread Api Assistant Threads Thread Id Carry Forward Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/assistant/threads/{thread_id}/turns": { "post": { "tags": [ "assistant" ], "summary": "Submit Turn", "operationId": "submit_turn_api_assistant_threads__thread_id__turns_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "thread_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Thread Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitTurnRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/assistant/models": { "get": { "tags": [ "assistant" ], "summary": "List Models", "description": "List available LLM models with health status.", "operationId": "list_models_api_assistant_models_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response List Models Api Assistant Models Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/assistant/models/refresh": { "post": { "tags": [ "assistant" ], "summary": "Refresh Models", "description": "Clear model health cache and re-probe.", "operationId": "refresh_models_api_assistant_models_refresh_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Refresh Models Api Assistant Models Refresh Post" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/assistant/actions": { "get": { "tags": [ "assistant" ], "summary": "List Assistant Actions", "description": "List the registered assistant action catalog.", "operationId": "list_assistant_actions_api_assistant_actions_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/assistant/actions/{action_id}/execute": { "post": { "tags": [ "assistant" ], "summary": "Execute Action", "operationId": "execute_action_api_assistant_actions__action_id__execute_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "action_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Action Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecuteActionRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Execute Action Api Assistant Actions Action Id Execute Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/assistant/actions/execute-batch": { "post": { "tags": [ "assistant" ], "summary": "Execute Action Batch", "operationId": "execute_action_batch_api_assistant_actions_execute_batch_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchExecuteRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Execute Action Batch Api Assistant Actions Execute Batch Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/assistant/pipelines/execute": { "post": { "tags": [ "assistant" ], "summary": "Execute Pipeline", "description": "Launch a registered assistant pipeline in the background.", "operationId": "execute_pipeline_api_assistant_pipelines_execute_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutePipelineRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/assistant/pipelines/sessions/{session_id}/cancel": { "post": { "tags": [ "assistant" ], "summary": "Cancel Pipeline", "description": "Cancel a running background assistant pipeline session.", "operationId": "cancel_pipeline_api_assistant_pipelines_sessions__session_id__cancel_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/CancelPipelineRequest" }, { "type": "null" } ], "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" }, "title": "Response Cancel Pipeline Api Assistant Pipelines Sessions Session Id Cancel Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/assistant/pipelines/sessions/{session_id}/events": { "get": { "tags": [ "assistant" ], "summary": "Stream Pipeline Events", "description": "Stream one pipeline session's retained and live events over SSE.", "operationId": "stream_pipeline_events_api_assistant_pipelines_sessions__session_id__events_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } }, { "name": "after_sequence", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "After Sequence" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/assistant/threads/{thread_id}/turns/{turn_id}": { "patch": { "tags": [ "assistant" ], "summary": "Update Turn", "operationId": "update_turn_api_assistant_threads__thread_id__turns__turn_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "thread_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Thread Id" } }, { "name": "turn_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Turn Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTurnRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Turn Api Assistant Threads Thread Id Turns Turn Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/assistant/threads/{thread_id}/audit": { "get": { "tags": [ "assistant" ], "summary": "Get Thread Audit", "operationId": "get_thread_audit_api_assistant_threads__thread_id__audit_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "thread_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Thread Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": {}, "title": "Response Get Thread Audit Api Assistant Threads Thread Id Audit Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/assistant/actions/{audit_id}/revert": { "post": { "tags": [ "assistant" ], "summary": "Revert Action", "operationId": "revert_action_api_assistant_actions__audit_id__revert_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "audit_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Audit Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevertActionRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Revert Action Api Assistant Actions Audit Id Revert Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/callbacks/": { "get": { "tags": [ "workflow-studio" ], "summary": "List Callbacks", "operationId": "list_callbacks_api_callbacks__get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response List Callbacks Api Callbacks Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/callbacks/{callback_id}": { "get": { "tags": [ "workflow-studio" ], "summary": "Get Callback", "operationId": "get_callback_api_callbacks__callback_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "callback_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Callback Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Callback Api Callbacks Callback Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/catalog/runners": { "get": { "tags": [ "catalog" ], "summary": "List Catalog Runners", "description": "Return the effective runner catalog for one domain.", "operationId": "list_catalog_runners_api_catalog_runners_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "domain_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Domain Id" } }, { "name": "kind", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kind" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Catalog Runners Api Catalog Runners Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/connectors/credentials/{credential_name}/status": { "get": { "tags": [ "connectors" ], "summary": "Get Credential Status", "operationId": "get_credential_status_api_connectors_credentials__credential_name__status_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "credential_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Credential Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" }, "title": "Response Get Credential Status Api Connectors Credentials Credential Name Status Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/connectors/google-drive/status": { "get": { "tags": [ "connectors" ], "summary": "Get Google Drive Status", "operationId": "get_google_drive_status_api_connectors_google_drive_status_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Get Google Drive Status Api Connectors Google Drive Status Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/connectors/google-drive/disconnect": { "post": { "tags": [ "connectors" ], "summary": "Disconnect Google Drive", "operationId": "disconnect_google_drive_api_connectors_google_drive_disconnect_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Disconnect Google Drive Api Connectors Google Drive Disconnect Post" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/connectors/oauth/google-drive/authorize": { "get": { "tags": [ "connectors" ], "summary": "Get Google Drive Authorize Url", "operationId": "get_google_drive_authorize_url_api_connectors_oauth_google_drive_authorize_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "mode", "in": "query", "required": false, "schema": { "enum": [ "connect", "reconnect" ], "type": "string", "default": "connect", "title": "Mode" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" }, "title": "Response Get Google Drive Authorize Url Api Connectors Oauth Google Drive Authorize Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/connectors/google-drive/export-package": { "post": { "tags": [ "connectors" ], "summary": "Export Workflow Package To Drive", "operationId": "export_workflow_package_to_drive_api_connectors_google_drive_export_package_post", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Payload" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Export Workflow Package To Drive Api Connectors Google Drive Export Package Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/connectors/google-drive/files": { "get": { "tags": [ "connectors" ], "summary": "List Google Drive Files", "operationId": "list_google_drive_files_api_connectors_google_drive_files_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "folder_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Folder Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Google Drive Files Api Connectors Google Drive Files Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/connectors/google-drive/import-package": { "post": { "tags": [ "connectors" ], "summary": "Import Workflow Package From Drive", "operationId": "import_workflow_package_from_drive_api_connectors_google_drive_import_package_post", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Payload" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Import Workflow Package From Drive Api Connectors Google Drive Import Package Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/workflows/{workflow_id}/crosswalk": { "get": { "tags": [ "crosswalk" ], "summary": "Get Workflow Crosswalk", "operationId": "get_workflow_crosswalk_api_workflows__workflow_id__crosswalk_get", "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } }, { "name": "project_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ], "title": "Project Id" } }, { "name": "working_dir", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ], "title": "Working Dir" } }, { "name": "revision_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ], "title": "Revision Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflows/{workflow_id}/crosswalk/confirm": { "post": { "tags": [ "crosswalk" ], "summary": "Confirm Workflow Crosswalk", "operationId": "confirm_workflow_crosswalk_api_workflows__workflow_id__crosswalk_confirm_post", "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } }, { "name": "project_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ], "title": "Project Id" } }, { "name": "working_dir", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ], "title": "Working Dir" } }, { "name": "revision_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ], "title": "Revision Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmCrosswalkRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Confirm Workflow Crosswalk Api Workflows Workflow Id Crosswalk Confirm Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/domains/": { "get": { "tags": [ "discovery" ], "summary": "List Domains", "description": "Return Studio-ready domain manifests.", "operationId": "list_domains_api_domains__get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response List Domains Api Domains Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/filesystem/browse": { "get": { "tags": [ "filesystem" ], "summary": "Browse Directory", "description": "List immediate subdirectories of *path*.\n\nIf *path* is omitted the user's home directory is used. Returns the\nresolved absolute path, its parent (for \"go up\" navigation), and\na sorted list of child directory names.", "operationId": "browse_directory_api_filesystem_browse_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "path", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Path" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Browse Directory Api Filesystem Browse Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/filesystem/mkdir": { "post": { "tags": [ "filesystem" ], "summary": "Create Directory", "description": "Create a directory on the local filesystem.\n\n**Default (``parents=false``)** \u2014 leaf-only mode. Only the final path\nsegment may be new; all ancestor directories must already exist. This\nprevents typos in manually entered paths from silently creating\nunintended directory trees (e.g. ``~/siumtions/\u2026`` instead of\n``~/simulations/\u2026``). The Studio GUI always uses this mode.\n\n**``parents=true``** \u2014 deep-create mode (``mkdir -p`` semantics).\nCreates the target directory *and* any missing intermediate parents.\nIntended for headless / programmatic callers (CLI, CI/CD pipelines,\nremote API scripts, desktop onboarding) where the full path is\ngenerated or validated upstream and there is no human browse step.\n\nReturns the resolved absolute path, its parent, and whether the\ndirectory was newly created.", "operationId": "create_directory_api_filesystem_mkdir_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "path", "in": "query", "required": true, "schema": { "type": "string", "title": "Path" } }, { "name": "parents", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Parents" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Directory Api Filesystem Mkdir Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/filesystem/validate-path": { "get": { "tags": [ "filesystem" ], "summary": "Validate Path", "description": "Check whether a path exists and characterize what is missing.\n\nReturns a status that the frontend uses to display inline hints:\n- ``exists`` \u2014 directory already exists, ready to use.\n- ``leaf_missing`` \u2014 parent exists but the last segment does not;\n safe to create with the New Folder action.\n- ``parent_missing`` \u2014 one or more ancestor directories are missing;\n likely a typo. The response includes the\n deepest ancestor that *does* exist so the\n frontend can highlight where the path diverges.\n- ``is_file`` \u2014 a regular file exists at that path.", "operationId": "validate_path_api_filesystem_validate_path_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "path", "in": "query", "required": true, "schema": { "type": "string", "title": "Path" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Validate Path Api Filesystem Validate Path Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/filesystem/defaults": { "get": { "tags": [ "filesystem" ], "summary": "Filesystem Defaults", "description": "Return the default projects base directory and home directory.\n\n`projects_base` is sourced from the gateway's `allowed_working_dir_base`\nconfig so that any directory the client uses by default is guaranteed to\npass workspace resolution. Falls back to ``~/obra-projects`` when the\ngateway config is unavailable.", "operationId": "filesystem_defaults_api_filesystem_defaults_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Response Filesystem Defaults Api Filesystem Defaults Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/interpolation/validate": { "post": { "tags": [ "authoring" ], "summary": "Validate Interpolation", "description": "Validate interpolation syntax, namespace usage, and optional stage resolution.", "operationId": "validate_interpolation_api_interpolation_validate_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "resolve", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Resolve" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateInterpolationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Validate Interpolation Api Interpolation Validate Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/knowledge/records": { "get": { "tags": [ "knowledge" ], "summary": "List Policy Memory Records", "operationId": "list_policy_memory_records_api_knowledge_records_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Id" } }, { "name": "workflow_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workflow Id" } }, { "name": "family", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Family" } }, { "name": "status_filter", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status Filter" } }, { "name": "include_legacy_sources", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Legacy Sources" } }, { "name": "working_dir", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Working Dir" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Policy Memory Records Api Knowledge Records Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "knowledge" ], "summary": "Create Policy Memory Record", "operationId": "create_policy_memory_record_api_knowledge_records_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Id" } }, { "name": "working_dir", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Working Dir" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyMemoryRecordMutation" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Policy Memory Record Api Knowledge Records Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/knowledge/records/{record_id}": { "get": { "tags": [ "knowledge" ], "summary": "Get Policy Memory Record", "operationId": "get_policy_memory_record_api_knowledge_records__record_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "record_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Record Id" } }, { "name": "project_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Id" } }, { "name": "working_dir", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Working Dir" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Policy Memory Record Api Knowledge Records Record Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "knowledge" ], "summary": "Update Policy Memory Record", "operationId": "update_policy_memory_record_api_knowledge_records__record_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "record_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Record Id" } }, { "name": "project_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Id" } }, { "name": "working_dir", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Working Dir" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyMemoryRecordMutation" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Policy Memory Record Api Knowledge Records Record Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/knowledge/records/{record_id}/status": { "post": { "tags": [ "knowledge" ], "summary": "Set Policy Memory Record Status", "operationId": "set_policy_memory_record_status_api_knowledge_records__record_id__status_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "record_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Record Id" } }, { "name": "project_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Id" } }, { "name": "working_dir", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Working Dir" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyMemoryStatusRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Set Policy Memory Record Status Api Knowledge Records Record Id Status Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/knowledge/resolve": { "get": { "tags": [ "knowledge" ], "summary": "Resolve Policy Memory Records", "operationId": "resolve_policy_memory_records_api_knowledge_resolve_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Id" } }, { "name": "workflow_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workflow Id" } }, { "name": "family", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Family" } }, { "name": "include_draft", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Draft" } }, { "name": "include_legacy_sources", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Legacy Sources" } }, { "name": "working_dir", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Working Dir" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Resolve Policy Memory Records Api Knowledge Resolve Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/knowledge/documents": { "post": { "tags": [ "knowledge" ], "summary": "Upload Document", "operationId": "upload_document_api_knowledge_documents_post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_document_api_knowledge_documents_post" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Upload Document Api Knowledge Documents Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "knowledge" ], "summary": "List Documents", "operationId": "list_documents_api_knowledge_documents_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Id" } }, { "name": "scope", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scope" } }, { "name": "workflow_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workflow Id" } }, { "name": "working_dir", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Working Dir" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Documents Api Knowledge Documents Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/knowledge/documents/{doc_id}": { "get": { "tags": [ "knowledge" ], "summary": "Get Document", "operationId": "get_document_api_knowledge_documents__doc_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "doc_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Doc Id" } }, { "name": "project_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Id" } }, { "name": "working_dir", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Working Dir" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Document Api Knowledge Documents Doc Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "knowledge" ], "summary": "Delete Document", "operationId": "delete_document_api_knowledge_documents__doc_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "doc_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Doc Id" } }, { "name": "project_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Id" } }, { "name": "working_dir", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Working Dir" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/sessions/": { "get": { "tags": [ "sessions" ], "summary": "List Sessions", "description": "List gateway-known sessions.", "operationId": "list_sessions_api_sessions__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Sessions Api Sessions Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/sessions/{session_id}": { "get": { "tags": [ "sessions" ], "summary": "Get Session", "description": "Return remote hybrid session detail when available, else the local gateway snapshot.", "operationId": "get_session_api_sessions__session_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Session Api Sessions Session Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/sessions/{session_id}/repair": { "post": { "tags": [ "sessions" ], "summary": "Repair Session", "description": "Repair a remote hybrid session through the canonical API client.", "operationId": "repair_session_api_sessions__session_id__repair_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Repair Session Api Sessions Session Id Repair Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/sessions/{session_id}/force-complete": { "post": { "tags": [ "sessions" ], "summary": "Force Complete Session", "description": "Force-complete a remote hybrid session.", "operationId": "force_complete_session_api_sessions__session_id__force_complete_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ForceCompleteSessionRequest" }, { "type": "null" } ], "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Force Complete Session Api Sessions Session Id Force Complete Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/sessions/{session_id}/reset-review": { "post": { "tags": [ "sessions" ], "summary": "Reset Review Session", "description": "Reset review state on a remote hybrid session.", "operationId": "reset_review_session_api_sessions__session_id__reset_review_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Reset Review Session Api Sessions Session Id Reset Review Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/settings/catalog": { "get": { "tags": [ "settings" ], "summary": "Get Settings Catalog", "description": "Return the full settings catalog with sections and field metadata.", "operationId": "get_settings_catalog_api_settings_catalog_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Get Settings Catalog Api Settings Catalog Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/settings": { "get": { "tags": [ "settings" ], "summary": "Get Settings", "description": "Return the editable settings subset with layer origins and warnings.", "operationId": "get_settings_api_settings_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Get Settings Api Settings Get" } } } } }, "security": [ { "HTTPBearer": [] } ] }, "patch": { "tags": [ "settings" ], "summary": "Patch Settings", "description": "Persist curated settings to the user config layer.", "operationId": "patch_settings_api_settings_patch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsPatchRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Patch Settings Api Settings Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/settings/runtime-llm": { "get": { "tags": [ "settings" ], "summary": "Get Runtime Llm Settings", "description": "Return the current workflow runtime LLM config and resolved map.", "operationId": "get_runtime_llm_settings_api_settings_runtime_llm_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Get Runtime Llm Settings Api Settings Runtime Llm Get" } } } } }, "security": [ { "HTTPBearer": [] } ] }, "patch": { "tags": [ "settings" ], "summary": "Patch Runtime Llm Settings", "description": "Persist workflow runtime provider/model selection to user config.", "operationId": "patch_runtime_llm_settings_api_settings_runtime_llm_patch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuntimeLLMUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Patch Runtime Llm Settings Api Settings Runtime Llm Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/transcription/transcribe": { "post": { "tags": [ "transcription" ], "summary": "Transcribe Audio", "operationId": "transcribe_audio_api_transcription_transcribe_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_transcribe_audio_api_transcription_transcribe_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Transcribe Audio Api Transcription Transcribe Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/transcription/providers": { "get": { "tags": [ "transcription" ], "summary": "List Providers", "operationId": "list_providers_api_transcription_providers_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response List Providers Api Transcription Providers Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/workflows/": { "get": { "tags": [ "workflow-studio" ], "summary": "List Workflows", "operationId": "list_workflows_api_workflows__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "view", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "active", "archived", "trash" ], "type": "string" }, { "type": "null" } ], "title": "View" } }, { "name": "bindable", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Bindable" } }, { "name": "exclude_workflow_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exclude Workflow Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Workflows Api Workflows Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "workflow-studio" ], "summary": "Create Workflow", "operationId": "create_workflow_api_workflows__post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Payload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Workflow Api Workflows Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflows/export": { "get": { "tags": [ "workflow-studio" ], "summary": "Export Workflows", "operationId": "export_workflows_api_workflows_export_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Export Workflows Api Workflows Export Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/workflows/import": { "post": { "tags": [ "workflow-studio" ], "summary": "Import Workflows", "operationId": "import_workflows_api_workflows_import_post", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Payload" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Import Workflows Api Workflows Import Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/workflows/{workflow_id}/export-package": { "get": { "tags": [ "workflow-studio" ], "summary": "Export Workflow Package", "operationId": "export_workflow_package_api_workflows__workflow_id__export_package_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } }, { "name": "project_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Id" } }, { "name": "working_dir", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Working Dir" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflows/import-package": { "post": { "tags": [ "workflow-studio" ], "summary": "Import Workflow Package", "operationId": "import_workflow_package_api_workflows_import_package_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Id" } }, { "name": "working_dir", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Working Dir" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Payload" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflows/{workflow_id}": { "get": { "tags": [ "workflow-studio" ], "summary": "Get Workflow", "operationId": "get_workflow_api_workflows__workflow_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Workflow Api Workflows Workflow Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "workflow-studio" ], "summary": "Patch Workflow", "operationId": "patch_workflow_api_workflows__workflow_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "If-Match" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Payload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Patch Workflow Api Workflows Workflow Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "workflow-studio" ], "summary": "Delete Workflow", "operationId": "delete_workflow_api_workflows__workflow_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } }, { "name": "X-Force-Delete", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Force-Delete" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflows/{workflow_id}/contract": { "get": { "tags": [ "workflow-studio" ], "summary": "Get Workflow Contract", "operationId": "get_workflow_contract_api_workflows__workflow_id__contract_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Workflow Contract Api Workflows Workflow Id Contract Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflows/{workflow_id}/revisions": { "get": { "tags": [ "workflow-studio" ], "summary": "List Workflow Revisions", "operationId": "list_workflow_revisions_api_workflows__workflow_id__revisions_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Workflow Revisions Api Workflows Workflow Id Revisions Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflows/{workflow_id}/revisions/{revision_id}/diff": { "get": { "tags": [ "workflow-studio" ], "summary": "Diff Workflow Revision", "operationId": "diff_workflow_revision_api_workflows__workflow_id__revisions__revision_id__diff_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } }, { "name": "revision_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Revision Id" } }, { "name": "base", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Base" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Diff Workflow Revision Api Workflows Workflow Id Revisions Revision Id Diff Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflows/{workflow_id}/revisions/{revision_id}": { "get": { "tags": [ "workflow-studio" ], "summary": "Get Workflow Revision", "operationId": "get_workflow_revision_api_workflows__workflow_id__revisions__revision_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } }, { "name": "revision_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Revision Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Workflow Revision Api Workflows Workflow Id Revisions Revision Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflows/{workflow_id}/revisions/{revision_id}/restore": { "post": { "tags": [ "workflow-studio" ], "summary": "Restore Workflow Revision", "operationId": "restore_workflow_revision_api_workflows__workflow_id__revisions__revision_id__restore_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } }, { "name": "revision_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Revision Id" } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "If-Match" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestoreRevisionRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Restore Workflow Revision Api Workflows Workflow Id Revisions Revision Id Restore Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflows/{workflow_id}/template-sets/apply": { "post": { "tags": [ "workflow-studio" ], "summary": "Apply Workflow Template Set", "description": "Re-bind stored template-asset versions onto the workflow head.", "operationId": "apply_workflow_template_set_api_workflows__workflow_id__template_sets_apply_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "If-Match" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplyTemplateSetRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Apply Workflow Template Set Api Workflows Workflow Id Template Sets Apply Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflows/{workflow_id}/validate": { "post": { "tags": [ "workflow-studio" ], "summary": "Validate Workflow", "operationId": "validate_workflow_api_workflows__workflow_id__validate_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "If-Match" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Payload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Validate Workflow Api Workflows Workflow Id Validate Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflows/{workflow_id}/archive": { "post": { "tags": [ "workflow-studio" ], "summary": "Archive Workflow", "operationId": "archive_workflow_api_workflows__workflow_id__archive_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Archive Workflow Api Workflows Workflow Id Archive Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflows/{workflow_id}/restore": { "post": { "tags": [ "workflow-studio" ], "summary": "Restore Workflow", "operationId": "restore_workflow_api_workflows__workflow_id__restore_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Restore Workflow Api Workflows Workflow Id Restore Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflows/{workflow_id}/labels/{name}": { "put": { "tags": [ "workflow-studio" ], "summary": "Set Workflow Label", "operationId": "set_workflow_label_api_workflows__workflow_id__labels__name__put", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowLabelRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Set Workflow Label Api Workflows Workflow Id Labels Name Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "workflow-studio" ], "summary": "Delete Workflow Label", "operationId": "delete_workflow_label_api_workflows__workflow_id__labels__name__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Workflow Label Api Workflows Workflow Id Labels Name Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflows/{workflow_id}/sync/resolve": { "post": { "tags": [ "workflow-studio" ], "summary": "Resolve Workflow Sync", "operationId": "resolve_workflow_sync_api_workflows__workflow_id__sync_resolve_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowSyncResolveRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Resolve Workflow Sync Api Workflows Workflow Id Sync Resolve Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflows/{workflow_id}/stages/{stage_id}/bind-child-workflow": { "post": { "tags": [ "workflow-studio" ], "summary": "Bind Workflow Stage Child", "operationId": "bind_workflow_stage_child_api_workflows__workflow_id__stages__stage_id__bind_child_workflow_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } }, { "name": "stage_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Stage Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BindChildWorkflowRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Bind Workflow Stage Child Api Workflows Workflow Id Stages Stage Id Bind Child Workflow Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/artifacts/": { "get": { "tags": [ "workflow-studio" ], "summary": "List Artifacts", "operationId": "list_artifacts_api_artifacts__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Run Id" } }, { "name": "stage_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stage Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Artifacts Api Artifacts Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/artifacts/{artifact_id}": { "get": { "tags": [ "workflow-studio" ], "summary": "Get Artifact", "operationId": "get_artifact_api_artifacts__artifact_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "artifact_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Artifact Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Artifact Api Artifacts Artifact Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/artifacts/{artifact_id}/content": { "get": { "tags": [ "workflow-studio" ], "summary": "Get Artifact Content", "operationId": "get_artifact_content_api_artifacts__artifact_id__content_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "artifact_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Artifact Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Artifact Content Api Artifacts Artifact Id Content Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/artifacts/{artifact_id}/references": { "get": { "tags": [ "workflow-studio" ], "summary": "Get Artifact References", "operationId": "get_artifact_references_api_artifacts__artifact_id__references_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "artifact_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Artifact Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Artifact References Api Artifacts Artifact Id References Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/artifacts/{artifact_id}/provenance": { "get": { "tags": [ "workflow-studio" ], "summary": "Get Artifact Provenance", "operationId": "get_artifact_provenance_api_artifacts__artifact_id__provenance_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "artifact_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Artifact Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Artifact Provenance Api Artifacts Artifact Id Provenance Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/template-assets/": { "get": { "tags": [ "workflow-studio" ], "summary": "List Template Assets", "operationId": "list_template_assets_api_template_assets__get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response List Template Assets Api Template Assets Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/template-assets/{asset_id}/revisions": { "get": { "tags": [ "workflow-studio" ], "summary": "List Template Asset Revisions", "operationId": "list_template_asset_revisions_api_template_assets__asset_id__revisions_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "asset_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Asset Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Template Asset Revisions Api Template Assets Asset Id Revisions Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/template-assets/{asset_id}/bindings": { "get": { "tags": [ "workflow-studio" ], "summary": "List Template Asset Bindings", "operationId": "list_template_asset_bindings_api_template_assets__asset_id__bindings_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "asset_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Asset Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Template Asset Bindings Api Template Assets Asset Id Bindings Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/template-assets/{asset_id}": { "get": { "tags": [ "workflow-studio" ], "summary": "Get Template Asset", "operationId": "get_template_asset_api_template_assets__asset_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "asset_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Asset Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Template Asset Api Template Assets Asset Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflows/{workflow_id}/template-assets": { "get": { "tags": [ "workflow-studio" ], "summary": "List Workflow Template Assets", "operationId": "list_workflow_template_assets_api_workflows__workflow_id__template_assets_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Workflow Template Assets Api Workflows Workflow Id Template Assets Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflows/{workflow_id}/template-assets/{stage_id}/{role}": { "get": { "tags": [ "workflow-studio" ], "summary": "Get Workflow Template Asset", "operationId": "get_workflow_template_asset_api_workflows__workflow_id__template_assets__stage_id___role__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } }, { "name": "stage_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Stage Id" } }, { "name": "role", "in": "path", "required": true, "schema": { "type": "string", "title": "Role" } }, { "name": "version", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Workflow Template Asset Api Workflows Workflow Id Template Assets Stage Id Role Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "workflow-studio" ], "summary": "Put Workflow Template Asset", "operationId": "put_workflow_template_asset_api_workflows__workflow_id__template_assets__stage_id___role__put", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } }, { "name": "stage_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Stage Id" } }, { "name": "role", "in": "path", "required": true, "schema": { "type": "string", "title": "Role" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Payload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Put Workflow Template Asset Api Workflows Workflow Id Template Assets Stage Id Role Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/runners/": { "get": { "tags": [ "workflow-studio" ], "summary": "List Runners", "operationId": "list_runners_api_runners__get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response List Runners Api Runners Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/runners/kinds": { "get": { "tags": [ "workflow-studio" ], "summary": "List Runner Kinds", "operationId": "list_runner_kinds_api_runners_kinds_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response List Runner Kinds Api Runners Kinds Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/runners/kinds/{runner_kind}/config-schema": { "get": { "tags": [ "workflow-studio" ], "summary": "Get Runner Config Schema", "operationId": "get_runner_config_schema_api_runners_kinds__runner_kind__config_schema_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "runner_kind", "in": "path", "required": true, "schema": { "type": "string", "title": "Runner Kind" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Runner Config Schema Api Runners Kinds Runner Kind Config Schema Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/runners/{runner_id}": { "get": { "tags": [ "workflow-studio" ], "summary": "Get Runner", "operationId": "get_runner_api_runners__runner_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "runner_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Runner Id" } }, { "name": "runner_version", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Runner Version" } }, { "name": "runner_selector", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Runner Selector" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Runner Api Runners Runner Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/runners/compatibility-check": { "post": { "tags": [ "workflow-studio" ], "summary": "Check Runner Compatibility", "operationId": "check_runner_compatibility_api_runners_compatibility_check_post", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Payload" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Check Runner Compatibility Api Runners Compatibility Check Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/schemas/": { "get": { "tags": [ "schemas" ], "summary": "List Schemas", "description": "List the published data-contract schemas.", "operationId": "list_schemas_api_schemas__get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response List Schemas Api Schemas Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/schemas/{name}": { "get": { "tags": [ "schemas" ], "summary": "Get Schema", "description": "Return one published schema by name.", "operationId": "get_schema_api_schemas__name__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Schema Api Schemas Name Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/webhooks/": { "post": { "tags": [ "webhooks" ], "summary": "Create Webhook", "operationId": "create_webhook_api_webhooks__post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhookRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Webhook Api Webhooks Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "webhooks" ], "summary": "List Webhooks", "operationId": "list_webhooks_api_webhooks__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Webhooks Api Webhooks Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/webhooks/{webhook_id}": { "get": { "tags": [ "webhooks" ], "summary": "Get Webhook Detail", "operationId": "get_webhook_detail_api_webhooks__webhook_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Webhook Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Webhook Detail Api Webhooks Webhook Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "webhooks" ], "summary": "Delete Webhook", "operationId": "delete_webhook_api_webhooks__webhook_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Webhook Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/webhooks/{webhook_id}/test": { "post": { "tags": [ "webhooks" ], "summary": "Send Test Webhook", "operationId": "send_test_webhook_api_webhooks__webhook_id__test_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Webhook Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Send Test Webhook Api Webhooks Webhook Id Test Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflow-derivations/": { "get": { "tags": [ "workflow-studio" ], "summary": "List Workflow Derivations", "operationId": "list_workflow_derivations_api_workflow_derivations__get", "security": [ { "HTTPBearer": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Workflow Derivations Api Workflow Derivations Get" } } } } } }, "post": { "tags": [ "workflow-studio" ], "summary": "Create Workflow Derivation", "operationId": "create_workflow_derivation_api_workflow_derivations__post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWorkflowDerivationRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Workflow Derivation Api Workflow Derivations Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflow-derivations/{derivation_id}": { "get": { "tags": [ "workflow-studio" ], "summary": "Get Workflow Derivation", "operationId": "get_workflow_derivation_api_workflow_derivations__derivation_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "derivation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Derivation Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Workflow Derivation Api Workflow Derivations Derivation Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflow-derivations/{derivation_id}/cancel": { "post": { "tags": [ "workflow-studio" ], "summary": "Cancel Workflow Derivation", "operationId": "cancel_workflow_derivation_api_workflow_derivations__derivation_id__cancel_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "derivation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Derivation Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Cancel Workflow Derivation Api Workflow Derivations Derivation Id Cancel Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflow-derivations/{derivation_id}/resume": { "post": { "tags": [ "workflow-studio" ], "summary": "Resume Workflow Derivation", "operationId": "resume_workflow_derivation_api_workflow_derivations__derivation_id__resume_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "derivation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Derivation Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResumeWorkflowDerivationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Resume Workflow Derivation Api Workflow Derivations Derivation Id Resume Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflow-derivations/{derivation_id}/operator-actions": { "post": { "tags": [ "workflow-studio" ], "summary": "Perform Derivation Operator Action", "operationId": "perform_derivation_operator_action_api_workflow_derivations__derivation_id__operator_actions_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "derivation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Derivation Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/obra__gateway__routes__workflow_derivations__OperatorActionRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Perform Derivation Operator Action Api Workflow Derivations Derivation Id Operator Actions Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflow-derivations/{derivation_id}/accept": { "post": { "tags": [ "workflow-studio" ], "summary": "Accept Workflow Derivation", "operationId": "accept_workflow_derivation_api_workflow_derivations__derivation_id__accept_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "derivation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Derivation Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcceptWorkflowDerivationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Accept Workflow Derivation Api Workflow Derivations Derivation Id Accept Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflow-runs/": { "get": { "tags": [ "workflow-studio" ], "summary": "List Workflow Runs", "operationId": "list_workflow_runs_api_workflow_runs__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ], "title": "Workflow Id" } }, { "name": "revision_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ], "title": "Revision Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Workflow Runs Api Workflow Runs Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "workflow-studio" ], "summary": "Create Workflow Run", "operationId": "create_workflow_run_api_workflow_runs__post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWorkflowRunRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Workflow Run Api Workflow Runs Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflow-runs/compare": { "get": { "tags": [ "workflow-studio" ], "summary": "Compare Workflow Runs", "operationId": "compare_workflow_runs_api_workflow_runs_compare_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_ids", "in": "query", "required": true, "schema": { "type": "string", "description": "Comma-separated run IDs", "title": "Run Ids" }, "description": "Comma-separated run IDs" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Compare Workflow Runs Api Workflow Runs Compare Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflow-runs/batch": { "post": { "tags": [ "workflow-studio" ], "summary": "Create Workflow Run Batch", "operationId": "create_workflow_run_batch_api_workflow_runs_batch_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchCreateWorkflowRunRequest" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Create Workflow Run Batch Api Workflow Runs Batch Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/workflow-runs/validate-input": { "post": { "tags": [ "workflow-studio" ], "summary": "Validate Input", "operationId": "validate_input_api_workflow_runs_validate_input_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateInputRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Validate Input Api Workflow Runs Validate Input Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/workflow-runs/{run_id}": { "get": { "tags": [ "workflow-studio" ], "summary": "Get Workflow Run", "operationId": "get_workflow_run_api_workflow_runs__run_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Workflow Run Api Workflow Runs Run Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflow-runs/{run_id}/wait": { "get": { "tags": [ "workflow-studio" ], "summary": "Wait For Workflow Run", "description": "Long-poll for a workflow-run status change with a configured timeout cap.\n\nThe cap prevents indefinite request occupation under load while matching\nLLM-operator clients that wait with a reasonable upper bound and then\nre-poll when needed.", "operationId": "wait_for_workflow_run_api_workflow_runs__run_id__wait_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } }, { "name": "since_status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Since Status" } }, { "name": "timeout_s", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Timeout S" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Wait For Workflow Run Api Workflow Runs Run Id Wait Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflow-runs/{run_id}/lineage": { "get": { "tags": [ "workflow-studio" ], "summary": "Get Workflow Run Lineage", "operationId": "get_workflow_run_lineage_api_workflow_runs__run_id__lineage_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Workflow Run Lineage Api Workflow Runs Run Id Lineage Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflow-runs/{run_id}/cancel": { "post": { "tags": [ "workflow-studio" ], "summary": "Cancel Workflow Run", "operationId": "cancel_workflow_run_api_workflow_runs__run_id__cancel_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Cancel Workflow Run Api Workflow Runs Run Id Cancel Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflow-runs/{run_id}/resume": { "post": { "tags": [ "workflow-studio" ], "summary": "Resume Workflow Run", "operationId": "resume_workflow_run_api_workflow_runs__run_id__resume_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResumeWorkflowRunRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Resume Workflow Run Api Workflow Runs Run Id Resume Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflow-runs/{run_id}/operator-actions": { "post": { "tags": [ "workflow-studio" ], "summary": "Perform Operator Action", "operationId": "perform_operator_action_api_workflow_runs__run_id__operator_actions_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/obra__gateway__routes__workflow_runs__OperatorActionRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Perform Operator Action Api Workflow Runs Run Id Operator Actions Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflow-runs/{run_id}/escalations/{escalation_id}/resolve": { "post": { "tags": [ "workflow-studio" ], "summary": "Resolve Workflow Run Escalation", "operationId": "resolve_workflow_run_escalation_api_workflow_runs__run_id__escalations__escalation_id__resolve_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } }, { "name": "escalation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Escalation Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolveEscalationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Resolve Workflow Run Escalation Api Workflow Runs Run Id Escalations Escalation Id Resolve Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflow-runs/{run_id}/stages": { "get": { "tags": [ "workflow-studio" ], "summary": "List Run Stages", "operationId": "list_run_stages_api_workflow_runs__run_id__stages_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Run Stages Api Workflow Runs Run Id Stages Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflow-runs/{run_id}/stages/{stage_name}": { "get": { "tags": [ "workflow-studio" ], "summary": "Get Run Stage", "operationId": "get_run_stage_api_workflow_runs__run_id__stages__stage_name__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } }, { "name": "stage_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Stage Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Run Stage Api Workflow Runs Run Id Stages Stage Name Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflow-runs/{run_id}/summary": { "get": { "tags": [ "workflow-studio" ], "summary": "Get Run Summary", "operationId": "get_run_summary_api_workflow_runs__run_id__summary_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Run Summary Api Workflow Runs Run Id Summary Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflow-runs/{run_id}/escalations": { "get": { "tags": [ "workflow-studio" ], "summary": "List Run Escalations", "operationId": "list_run_escalations_api_workflow_runs__run_id__escalations_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Run Escalations Api Workflow Runs Run Id Escalations Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflow-runs/{run_id}/review-state": { "get": { "tags": [ "workflow-studio" ], "summary": "Get Run Review State", "operationId": "get_run_review_state_api_workflow_runs__run_id__review_state_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Run Review State Api Workflow Runs Run Id Review State Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflow-runs/{run_id}/outputs": { "get": { "tags": [ "workflow-studio" ], "summary": "Get Run Outputs", "operationId": "get_run_outputs_api_workflow_runs__run_id__outputs_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Run Outputs Api Workflow Runs Run Id Outputs Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflow-runs/{run_id}/manifest": { "get": { "tags": [ "workflow-studio" ], "summary": "Get Run Manifest", "description": "ADR-118 GET /api/workflow-runs/{run_id}/manifest.\n\nReturns the parsed run-manifest body. Out-of-scope and unknown runs\nreturn an indistinguishable 404. Integrity drift surfaces as a typed 500\nso operators triage instead of receiving a silently corrupt body.", "operationId": "get_run_manifest_api_workflow_runs__run_id__manifest_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Run Manifest Api Workflow Runs Run Id Manifest Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflow-runs/{run_id}/verify": { "post": { "tags": [ "workflow-studio" ], "summary": "Verify Run Manifest", "description": "Recompute every sha256 and the integrity hash; report drift.", "operationId": "verify_run_manifest_api_workflow_runs__run_id__verify_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Verify Run Manifest Api Workflow Runs Run Id Verify Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflow-runs/{run_id}/tombstone": { "post": { "tags": [ "workflow-studio" ], "summary": "Tombstone Workflow Run", "description": "Apply the ADR-118 hard-delete tombstone to a run.", "operationId": "tombstone_workflow_run_api_workflow_runs__run_id__tombstone_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TombstoneRunRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tombstone Workflow Run Api Workflow Runs Run Id Tombstone Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflow-runs/{run_id}/legal-hold": { "post": { "tags": [ "workflow-studio" ], "summary": "Set Run Legal Hold", "description": "Set or clear legal hold on an ADR-118 run.", "operationId": "set_run_legal_hold_api_workflow_runs__run_id__legal_hold_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegalHoldRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Set Run Legal Hold Api Workflow Runs Run Id Legal Hold Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflow-runs/exports": { "post": { "tags": [ "workflow-studio" ], "summary": "Create Export Bundle", "description": "Generate a redacted support bundle plus its export-manifest.json.", "operationId": "create_export_bundle_api_workflow_runs_exports_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportBundleRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Create Export Bundle Api Workflow Runs Exports Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/workflow-runs/index/rebuild": { "post": { "tags": [ "workflow-studio" ], "summary": "Rebuild Run Indexes", "description": "Rebuild ``.obra/run-index/`` partitions from on-disk manifests.\n\nBody: ``{\"workflow_id\"?: str, \"workspace\"?: str}``. ADMIN may target any\nworkspace; non-ADMIN principals are limited to manifests whose tenant id\nappears in their ``allowed_tenant_ids`` set.", "operationId": "rebuild_run_indexes_api_workflow_runs_index_rebuild_post", "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Rebuild Run Indexes Api Workflow Runs Index Rebuild Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/workflows/{workflow_id}/changes": { "get": { "tags": [ "workflow-studio" ], "summary": "List Workflow Changes", "operationId": "list_workflow_changes_api_workflows__workflow_id__changes_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Since" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Workflow Changes Api Workflows Workflow Id Changes Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflows/{workflow_id}/changes/{change_id}/revert": { "post": { "tags": [ "workflow-studio" ], "summary": "Revert Workflow Change", "operationId": "revert_workflow_change_api_workflows__workflow_id__changes__change_id__revert_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } }, { "name": "change_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Change Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Revert Workflow Change Api Workflows Workflow Id Changes Change Id Revert Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflow-runs/{run_id}/events": { "get": { "tags": [ "workflow-studio" ], "summary": "Stream Workflow Run Events", "operationId": "stream_workflow_run_events_api_workflow_runs__run_id__events_get", "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } }, { "name": "filter", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated event names", "title": "Filter" }, "description": "Comma-separated event names" }, { "name": "after_sequence", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "After Sequence" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflow-derivations/{derivation_id}/events": { "get": { "tags": [ "workflow-studio" ], "summary": "Stream Workflow Derivation Events", "operationId": "stream_workflow_derivation_events_api_workflow_derivations__derivation_id__events_get", "parameters": [ { "name": "derivation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Derivation Id" } }, { "name": "filter", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated event names", "title": "Filter" }, "description": "Comma-separated event names" }, { "name": "after_sequence", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "After Sequence" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflows/{workflow_id}/events": { "get": { "tags": [ "workflow-studio" ], "summary": "Stream Workflow Events", "operationId": "stream_workflow_events_api_workflows__workflow_id__events_get", "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } }, { "name": "filter", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated event names", "title": "Filter" }, "description": "Comma-separated event names" }, { "name": "after_sequence", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "After Sequence" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/workflow-runs/{run_id}/replay": { "get": { "tags": [ "workflow-studio" ], "summary": "Get Workflow Run Replay", "operationId": "get_workflow_run_replay_api_workflow_runs__run_id__replay_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Workflow Run Replay Api Workflow Runs Run Id Replay Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/logs/api/auth/session": { "get": { "tags": [ "logs" ], "summary": "Get Log Auth Session", "description": "Return auth-session status for gateway log viewer browsers.", "operationId": "get_log_auth_session_logs_api_auth_session_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } }, "post": { "tags": [ "logs" ], "summary": "Create Log Auth Session", "description": "Create an HttpOnly browser auth session for the log viewer.", "operationId": "create_log_auth_session_logs_api_auth_session_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } }, "delete": { "tags": [ "logs" ], "summary": "Delete Log Auth Session", "description": "Invalidate browser auth session cookie for the log viewer.", "operationId": "delete_log_auth_session_logs_api_auth_session_delete", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/logs/api/snapshot": { "get": { "tags": [ "logs" ], "summary": "Get Snapshot", "description": "Return current merged log snapshot.", "operationId": "get_snapshot_logs_api_snapshot_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 5000, "minimum": 1, "default": 500, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/logs/api/stream": { "get": { "tags": [ "logs" ], "summary": "Stream Logs", "description": "Stream live log events and periodic source status updates as SSE.", "operationId": "stream_logs_logs_api_stream_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/logs/api/plan_snapshot": { "get": { "tags": [ "logs" ], "summary": "Get Plan Snapshot", "description": "Return a stored plan snapshot by reference.", "operationId": "get_plan_snapshot_logs_api_plan_snapshot_get", "parameters": [ { "name": "ref", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ref" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/logs/api/intent_snapshot": { "get": { "tags": [ "logs" ], "summary": "Get Intent Snapshot", "description": "Return a stored intent snapshot by reference.", "operationId": "get_intent_snapshot_logs_api_intent_snapshot_get", "parameters": [ { "name": "ref", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ref" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/connectors/oauth/google-drive/callback": { "get": { "tags": [ "connectors-oauth-callback" ], "summary": "Google Drive Oauth Callback", "operationId": "google_drive_oauth_callback_api_connectors_oauth_google_drive_callback_get", "parameters": [ { "name": "code", "in": "query", "required": true, "schema": { "type": "string", "title": "Code" } }, { "name": "state", "in": "query", "required": true, "schema": { "type": "string", "title": "State" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/onboarding/status": { "get": { "tags": [ "onboarding" ], "summary": "Onboarding Status", "description": "Overall onboarding status with per-provider state and UI timing hints.\n\nProvider checks run concurrently in the thread pool so they don't\nblock the async event loop (each provider may spawn subprocesses or\nmake network calls that take several seconds).\n\nWhen ``?force=1`` is supplied and the rate-limit window has elapsed,\nthe cached health entries are invalidated before fanning out. This\nlets the client recover from a stale \"needs setup\" banner after the\nuser authenticates in a terminal without waiting for the cache TTL.", "operationId": "onboarding_status_api_onboarding_status_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/onboarding/providers": { "get": { "tags": [ "onboarding" ], "summary": "List Providers", "description": "List available providers with metadata.\n\nIncludes detection diagnostics (``install_issue``, ``binary_path``,\n``probe_output``, ``probe_exit_code``) so the UI can differentiate\n\"nothing on PATH\" from \"wrong binary found\" from \"binary failed to\nexecute\" \u2014 each needs different remediation copy.", "operationId": "list_providers_api_onboarding_providers_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/onboarding/providers/{provider_id}/authenticate": { "post": { "tags": [ "onboarding" ], "summary": "Authenticate Provider", "description": "Trigger the provider's auth flow.", "operationId": "authenticate_provider_api_onboarding_providers__provider_id__authenticate_post", "parameters": [ { "name": "provider_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Provider Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/onboarding/providers/{provider_id}/auth-status": { "get": { "tags": [ "onboarding" ], "summary": "Provider Auth Status", "description": "Check auth completion status for a provider.\n\nHonors ``?force=1`` (subject to the global force-refresh rate limit)\nso the banner's post-handoff polling loop can see newly-authenticated\nstate without waiting for the cache TTL.", "operationId": "provider_auth_status_api_onboarding_providers__provider_id__auth_status_get", "parameters": [ { "name": "provider_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Provider Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/onboarding/providers/{provider_id}/dismiss": { "post": { "tags": [ "onboarding" ], "summary": "Dismiss Provider", "description": "Dismiss a provider for the current session.\n\nStops auth health checks until the gateway is restarted (next\n``obra studio`` launch).", "operationId": "dismiss_provider_api_onboarding_providers__provider_id__dismiss_post", "parameters": [ { "name": "provider_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Provider Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/onboarding/providers/{provider_id}/undismiss": { "post": { "tags": [ "onboarding" ], "summary": "Undismiss Provider", "description": "Re-enable auth checks for a previously dismissed provider.", "operationId": "undismiss_provider_api_onboarding_providers__provider_id__undismiss_post", "parameters": [ { "name": "provider_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Provider Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/onboarding/complete": { "post": { "tags": [ "onboarding" ], "summary": "Complete Onboarding", "description": "Mark onboarding as complete.", "operationId": "complete_onboarding_api_onboarding_complete_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/onboarding/pairing": { "post": { "tags": [ "onboarding" ], "summary": "Create Pairing", "description": "Stand up tailnet exposure, mint a per-device token, and return the bundle.\n\nThe bundle (tailnet URL + token) is rendered client-side as a QR + copyable\nstring for the operator to scan into the Obra Companion app. Pairing is\noptional and does not gate onboarding completion. See ADR-135, PRD FR-5.", "operationId": "create_pairing_api_onboarding_pairing_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/onboarding/pairing/status": { "get": { "tags": [ "onboarding" ], "summary": "Pairing Status", "description": "Return the currently recorded Companion pairings (no token values).", "operationId": "pairing_status_api_onboarding_pairing_status_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/onboarding/pairing/{token_hash}": { "delete": { "tags": [ "onboarding" ], "summary": "Revoke Pairing", "description": "Revoke a paired device's token by its hash.", "operationId": "revoke_pairing_api_onboarding_pairing__token_hash__delete", "parameters": [ { "name": "token_hash", "in": "path", "required": true, "schema": { "type": "string", "title": "Token Hash" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/studio/api/auth/session": { "get": { "tags": [ "studio" ], "summary": "Get Studio Browser Session", "description": "Report whether the browser currently has a valid Studio session cookie.", "operationId": "get_studio_browser_session_studio_api_auth_session_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } }, "put": { "tags": [ "studio" ], "summary": "Refresh Studio Browser Session Route", "description": "Extend an existing Studio browser session cookie.", "operationId": "refresh_studio_browser_session_route_studio_api_auth_session_put", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } }, "post": { "tags": [ "studio" ], "summary": "Create Studio Browser Session", "description": "Create a browser session cookie for same-origin Studio usage.", "operationId": "create_studio_browser_session_studio_api_auth_session_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } }, "delete": { "tags": [ "studio" ], "summary": "Delete Studio Browser Session", "description": "Clear the current Studio browser session.", "operationId": "delete_studio_browser_session_studio_api_auth_session_delete", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/studio/api/bootstrap-links": { "post": { "tags": [ "studio" ], "summary": "Create Studio Bootstrap Link", "description": "Mint a one-time Studio launch link for the CLI-owned browser bootstrap path.", "operationId": "create_studio_bootstrap_link_studio_api_bootstrap_links_post", "parameters": [ { "name": "next", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/health": { "get": { "summary": "Health", "operationId": "health_health_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Health Health Get" } } } } } } }, "/ready": { "get": { "summary": "Ready", "operationId": "ready_ready_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Ready Ready Get" } } } } } } }, "/api/health/details": { "get": { "summary": "Health Details", "operationId": "health_details_api_health_details_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Health Details Api Health Details Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } } }, "components": { "schemas": { "AcceptWorkflowDerivationRequest": { "properties": { "expected_baseline_ref": { "additionalProperties": true, "type": "object", "title": "Expected Baseline Ref" } }, "type": "object", "title": "AcceptWorkflowDerivationRequest", "description": "Request body for guarded derivation acceptance." }, "ApplyTemplateSetRequest": { "properties": { "reason": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "title": "Reason" }, "actor": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ], "title": "Actor" }, "selections": { "anyOf": [ { "items": { "$ref": "#/components/schemas/TemplateSetSelection" }, "type": "array" }, { "type": "null" } ], "title": "Selections" } }, "additionalProperties": false, "type": "object", "title": "ApplyTemplateSetRequest", "description": "Request body for re-binding stored template assets onto the head." }, "AutomationActionRequest": { "properties": { "action": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Action" }, "payload": { "additionalProperties": true, "type": "object", "title": "Payload" } }, "additionalProperties": false, "type": "object", "required": [ "action" ], "title": "AutomationActionRequest", "description": "Automation-facing operator action request." }, "AutomationDerivationStartRequest": { "properties": { "mission": { "type": "string", "maxLength": 10000, "minLength": 1, "title": "Mission" }, "surface": { "type": "string", "maxLength": 32, "title": "Surface", "default": "unknown" }, "project_id": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Project Id" }, "working_dir": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ], "title": "Working Dir" }, "domain_id": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ], "title": "Domain Id" }, "input_spec_refs": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Input Spec Refs" }, "output_spec_refs": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Output Spec Refs" }, "rule_pack_refs": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Rule Pack Refs" }, "quality_pack_refs": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Quality Pack Refs" }, "baseline_workflow_ref": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Baseline Workflow Ref" }, "example_case_refs": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Example Case Refs" }, "exception_case_refs": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Exception Case Refs" }, "policy_precedence_overrides": { "additionalProperties": true, "type": "object", "title": "Policy Precedence Overrides" }, "operator_constraints": { "additionalProperties": true, "type": "object", "title": "Operator Constraints" } }, "additionalProperties": false, "type": "object", "required": [ "mission" ], "title": "AutomationDerivationStartRequest", "description": "Automation-facing request body for workflow derivations." }, "AutomationRunStartRequest": { "properties": { "objective": { "type": "string", "maxLength": 10000, "minLength": 1, "title": "Objective" }, "project_id": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Project Id" }, "working_dir": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ], "title": "Working Dir" }, "workflow_id": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ], "title": "Workflow Id" }, "revision_id": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ], "title": "Revision Id" }, "domain_id": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ], "title": "Domain Id" }, "surface": { "type": "string", "maxLength": 32, "title": "Surface", "default": "unknown" }, "input_manifest": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Input Manifest" }, "input_payload": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Input Payload" } }, "additionalProperties": false, "type": "object", "required": [ "objective" ], "title": "AutomationRunStartRequest", "description": "Automation-facing request body for workflow runs." }, "BatchCreateWorkflowRunRequest": { "properties": { "items": { "items": { "$ref": "#/components/schemas/CreateWorkflowRunRequest" }, "type": "array", "maxItems": 50, "minItems": 1, "title": "Items" } }, "additionalProperties": false, "type": "object", "required": [ "items" ], "title": "BatchCreateWorkflowRunRequest", "description": "Request body for batch workflow run creation." }, "BatchExecuteRecord": { "properties": { "source_record_index": { "type": "integer", "minimum": 0.0, "title": "Source Record Index" }, "action_id": { "type": "string", "minLength": 1, "title": "Action Id" }, "action_inputs": { "additionalProperties": true, "type": "object", "title": "Action Inputs" }, "workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workflow Id" }, "expected_revision_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expected Revision Id" }, "working_dir": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Working Dir" } }, "type": "object", "required": [ "source_record_index", "action_id" ], "title": "BatchExecuteRecord", "description": "One action item within a batch execute request." }, "BatchExecuteRequest": { "properties": { "thread_id": { "type": "string", "minLength": 1, "title": "Thread Id" }, "turn_id": { "type": "string", "minLength": 1, "title": "Turn Id" }, "safety_mode": { "type": "string", "minLength": 1, "title": "Safety Mode" }, "records": { "items": { "$ref": "#/components/schemas/BatchExecuteRecord" }, "type": "array", "minItems": 1, "title": "Records" }, "working_dir": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Working Dir" }, "expected_workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expected Workflow Id" } }, "type": "object", "required": [ "thread_id", "turn_id", "safety_mode", "records" ], "title": "BatchExecuteRequest", "description": "Execute multiple assistant actions in order." }, "BindChildWorkflowRequest": { "properties": { "child_workflow_id": { "type": "string", "maxLength": 256, "minLength": 1, "title": "Child Workflow Id" }, "project_id": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Project Id" }, "working_dir": { "anyOf": [ { "type": "string", "maxLength": 4096, "minLength": 1 }, { "type": "null" } ], "title": "Working Dir" }, "revision_id": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ], "title": "Revision Id" } }, "additionalProperties": false, "type": "object", "required": [ "child_workflow_id" ], "title": "BindChildWorkflowRequest", "description": "Request body for binding a workflow_runner child workflow." }, "Body_transcribe_audio_api_transcription_transcribe_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_transcribe_audio_api_transcription_transcribe_post" }, "Body_upload_document_api_knowledge_documents_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" }, "name": { "type": "string", "title": "Name" }, "scope": { "type": "string", "title": "Scope" }, "project_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Id" }, "workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workflow Id" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "working_dir": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Working Dir" } }, "type": "object", "required": [ "file", "name", "scope" ], "title": "Body_upload_document_api_knowledge_documents_post" }, "CancelPipelineRequest": { "properties": { "reason": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "title": "Reason" }, "silent": { "type": "boolean", "title": "Silent", "default": false } }, "type": "object", "title": "CancelPipelineRequest", "description": "Optional cancellation metadata supplied by the caller." }, "CarryForwardThreadRequest": { "properties": { "project_id": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Project Id" }, "working_dir": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Working Dir" }, "name": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Name" }, "safety_mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Safety Mode" } }, "type": "object", "required": [ "name" ], "title": "CarryForwardThreadRequest", "description": "Create a new thread from an archived or older summary." }, "ConfirmCrosswalkRequest": { "properties": { "selections": { "items": { "$ref": "#/components/schemas/CrosswalkSelectionInput" }, "type": "array", "maxItems": 3, "minItems": 1, "title": "Selections" } }, "additionalProperties": false, "type": "object", "required": [ "selections" ], "title": "ConfirmCrosswalkRequest" }, "ContextAttachment": { "properties": { "project_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Id" }, "safety_mode": { "type": "string", "title": "Safety Mode", "default": "guided" }, "working_dir": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Working Dir" }, "domain_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Domain Id" }, "workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workflow Id" }, "revision_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Revision Id" }, "run_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Run Id" }, "artifact_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Artifact Id" }, "derivation_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Derivation Id" }, "selected_nodes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Selected Nodes" }, "current_route": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Current Route" }, "ui_state": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Ui State" }, "recent_runs": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Recent Runs" }, "attachments": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Attachments" } }, "type": "object", "title": "ContextAttachment", "description": "Client-supplied context for a conversation turn." }, "CreateThreadRequest": { "properties": { "project_id": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Project Id" }, "working_dir": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Working Dir" }, "name": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Name" }, "safety_mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Safety Mode" }, "carry_forward_thread_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Carry Forward Thread Id" } }, "type": "object", "required": [ "name" ], "title": "CreateThreadRequest", "description": "Create a new assistant thread." }, "CreateWebhookRequest": { "properties": { "callback_url": { "type": "string", "minLength": 1, "title": "Callback Url" }, "resource_type": { "type": "string", "minLength": 1, "title": "Resource Type" }, "resource_id": { "type": "string", "minLength": 1, "title": "Resource Id" }, "events": { "items": { "type": "string" }, "type": "array", "minItems": 1, "title": "Events" }, "secret": { "type": "string", "minLength": 1, "title": "Secret" } }, "additionalProperties": false, "type": "object", "required": [ "callback_url", "resource_type", "resource_id", "events", "secret" ], "title": "CreateWebhookRequest", "description": "Request body for webhook registration." }, "CreateWorkflowDerivationRequest": { "properties": { "project_id": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Project Id" }, "working_dir": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ], "title": "Working Dir" }, "mission": { "type": "string", "maxLength": 10000, "minLength": 1, "title": "Mission" }, "domain_id": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ], "title": "Domain Id" }, "input_spec_refs": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Input Spec Refs" }, "output_spec_refs": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Output Spec Refs" }, "rule_pack_refs": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Rule Pack Refs" }, "quality_pack_refs": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Quality Pack Refs" }, "baseline_workflow_ref": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Baseline Workflow Ref" }, "example_case_refs": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Example Case Refs" }, "exception_case_refs": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Exception Case Refs" }, "policy_precedence_overrides": { "additionalProperties": true, "type": "object", "title": "Policy Precedence Overrides" }, "operator_constraints": { "additionalProperties": true, "type": "object", "title": "Operator Constraints" } }, "type": "object", "required": [ "mission" ], "title": "CreateWorkflowDerivationRequest", "description": "Canonical public request body for derivation creation." }, "CreateWorkflowRunRequest": { "properties": { "objective": { "type": "string", "maxLength": 10000, "title": "Objective" }, "project_id": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ], "title": "Project Id" }, "working_dir": { "anyOf": [ { "type": "string", "maxLength": 4096, "minLength": 1 }, { "type": "null" } ], "title": "Working Dir" }, "workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workflow Id" }, "revision_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Revision Id" }, "domain_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Domain Id" }, "parent_payload": { "additionalProperties": true, "type": "object", "title": "Parent Payload" }, "launch_metadata": { "additionalProperties": true, "type": "object", "title": "Launch Metadata" }, "input_manifest": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Input Manifest" }, "input_payload": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Input Payload" }, "idempotency_key": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ], "title": "Idempotency Key" }, "output_destination": { "anyOf": [ { "$ref": "#/components/schemas/OutputDestination" }, { "type": "null" } ] }, "execution_subject": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Execution Subject" }, "allowed_tenant_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Allowed Tenant Ids" }, "correlation_refs": { "anyOf": [ { "items": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Correlation Refs" } }, "additionalProperties": false, "type": "object", "required": [ "objective" ], "title": "CreateWorkflowRunRequest", "description": "Request body for creating a canonical workflow run." }, "CrosswalkSelectionInput": { "properties": { "grade": { "type": "string", "enum": [ "low", "medium", "high" ], "title": "Grade" }, "provider": { "type": "string", "maxLength": 256, "minLength": 1, "title": "Provider" }, "model": { "type": "string", "maxLength": 256, "minLength": 1, "title": "Model" }, "reasoning_level": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "Reasoning Level" }, "auth_method": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "Auth Method" } }, "additionalProperties": false, "type": "object", "required": [ "grade", "provider", "model" ], "title": "CrosswalkSelectionInput" }, "ExecuteActionRequest": { "properties": { "thread_id": { "type": "string", "minLength": 1, "title": "Thread Id" }, "turn_id": { "type": "string", "minLength": 1, "title": "Turn Id" }, "safety_mode": { "type": "string", "minLength": 1, "title": "Safety Mode" }, "action_inputs": { "additionalProperties": true, "type": "object", "title": "Action Inputs" }, "workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workflow Id" }, "expected_revision_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expected Revision Id" }, "working_dir": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Working Dir" } }, "type": "object", "required": [ "thread_id", "turn_id", "safety_mode" ], "title": "ExecuteActionRequest", "description": "Execute an assistant action." }, "ExecutePipelineRequest": { "properties": { "pipeline_id": { "type": "string", "minLength": 1, "title": "Pipeline Id" }, "thread_id": { "type": "string", "minLength": 1, "title": "Thread Id" }, "turn_id": { "type": "string", "minLength": 1, "title": "Turn Id" }, "trigger_source": { "type": "string", "enum": [ "system_auto", "llm_proposed", "user_explicit" ], "title": "Trigger Source", "default": "user_explicit" }, "workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workflow Id" }, "model_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Id" }, "workflow_context": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Workflow Context" }, "params": { "additionalProperties": true, "type": "object", "title": "Params" }, "working_dir": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Working Dir" }, "expected_workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expected Workflow Id" } }, "type": "object", "required": [ "pipeline_id", "thread_id", "turn_id" ], "title": "ExecutePipelineRequest", "description": "Execute an assistant pipeline." }, "ExportBundleRequest": { "properties": { "run_ids": { "items": { "type": "string" }, "type": "array", "maxItems": 200, "minItems": 1, "title": "Run Ids" }, "output_path": { "type": "string", "maxLength": 4096, "minLength": 1, "title": "Output Path" }, "redaction_policy": { "type": "string", "maxLength": 64, "title": "Redaction Policy", "default": "default_customer_safe" }, "recipient": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "title": "Recipient" }, "tenant_scope": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tenant Scope" }, "purpose": { "type": "string", "maxLength": 64, "title": "Purpose", "default": "support_bundle" } }, "additionalProperties": false, "type": "object", "required": [ "run_ids", "output_path" ], "title": "ExportBundleRequest", "description": "Request body for the support-bundle export endpoint (ADR-118)." }, "ForceCompleteSessionRequest": { "properties": { "reason": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Reason" } }, "type": "object", "title": "ForceCompleteSessionRequest", "description": "Optional force-complete payload." }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "LegalHoldRequest": { "properties": { "value": { "type": "boolean", "title": "Value" } }, "additionalProperties": false, "type": "object", "required": [ "value" ], "title": "LegalHoldRequest", "description": "Request body for toggling run retention legal hold." }, "OutputDestination": { "properties": { "type": { "type": "string", "enum": [ "webhook", "http_push" ], "title": "Type" }, "url": { "type": "string", "minLength": 1, "title": "Url" }, "headers": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Headers" }, "secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Secret" } }, "additionalProperties": false, "type": "object", "required": [ "type", "url" ], "title": "OutputDestination", "description": "Destination that receives workflow-run outputs on terminal completion." }, "PolicyMemoryFreshness": { "properties": { "reviewed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reviewed At" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expires At" } }, "additionalProperties": false, "type": "object", "title": "PolicyMemoryFreshness", "description": "Optional review and expiry metadata." }, "PolicyMemoryProvenance": { "properties": { "source_kind": { "type": "string", "enum": [ "manual_entry", "knowledge_document", "legacy_import" ], "title": "Source Kind", "default": "manual_entry" }, "source_document_ids": { "items": { "type": "string" }, "type": "array", "title": "Source Document Ids" }, "source_note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Note" }, "imported_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Imported From" } }, "additionalProperties": false, "type": "object", "title": "PolicyMemoryProvenance", "description": "Tracks where a typed policy/memory record came from." }, "PolicyMemoryRecordMutation": { "properties": { "title": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Title" }, "family": { "type": "string", "enum": [ "approval_policy", "business_rule", "runtime_guidance", "workflow_heuristic", "review_expectation", "escalation_guidance" ], "title": "Family" }, "scope": { "type": "string", "enum": [ "org", "project", "workflow" ], "title": "Scope" }, "project_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Id" }, "workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workflow Id" }, "status": { "type": "string", "enum": [ "draft", "active", "superseded", "archived" ], "title": "Status", "default": "draft" }, "enforcement": { "type": "string", "enum": [ "advisory", "required" ], "title": "Enforcement", "default": "advisory" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Summary" }, "guidance": { "type": "string", "minLength": 1, "title": "Guidance" }, "rationale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rationale" }, "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags" }, "attachment_document_ids": { "items": { "type": "string" }, "type": "array", "title": "Attachment Document Ids" }, "provenance": { "anyOf": [ { "$ref": "#/components/schemas/PolicyMemoryProvenance" }, { "type": "null" } ] }, "freshness": { "anyOf": [ { "$ref": "#/components/schemas/PolicyMemoryFreshness" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "title", "family", "scope", "guidance" ], "title": "PolicyMemoryRecordMutation", "description": "Create/update payload for policy/memory records." }, "PolicyMemoryStatusRequest": { "properties": { "status": { "type": "string", "maxLength": 64, "minLength": 1, "title": "Status" } }, "additionalProperties": false, "type": "object", "required": [ "status" ], "title": "PolicyMemoryStatusRequest", "description": "Status transition body for typed policy/memory records." }, "ProposalOperationApplyRequest": { "properties": { "safety_mode": { "type": "string", "minLength": 1, "title": "Safety Mode" }, "working_dir": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Working Dir" }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key" }, "revision_override": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Revision Override" }, "record_indexes": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Record Indexes" }, "expected_workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expected Workflow Id" } }, "type": "object", "required": [ "safety_mode" ], "title": "ProposalOperationApplyRequest", "description": "Apply a workflow-scoped assistant proposal operation." }, "ProposalOperationDismissRequest": { "properties": { "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "expected_workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expected Workflow Id" } }, "type": "object", "title": "ProposalOperationDismissRequest", "description": "Dismiss a workflow-scoped assistant proposal operation." }, "ProposalOperationReApplyRequest": { "properties": { "safety_mode": { "type": "string", "minLength": 1, "title": "Safety Mode" }, "working_dir": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Working Dir" }, "revision_override": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Revision Override" }, "record_indexes": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Record Indexes" }, "expected_workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expected Workflow Id" } }, "type": "object", "required": [ "safety_mode" ], "title": "ProposalOperationReApplyRequest", "description": "Re-apply a workflow-scoped assistant proposal operation." }, "ProposalOperationsApplyAllRequest": { "properties": { "workflow_id": { "type": "string", "minLength": 1, "title": "Workflow Id" }, "safety_mode": { "type": "string", "minLength": 1, "title": "Safety Mode", "default": "guided" }, "working_dir": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Working Dir" }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key" } }, "type": "object", "required": [ "workflow_id" ], "title": "ProposalOperationsApplyAllRequest", "description": "Apply all pending workflow-scoped assistant proposal operations." }, "ResolveEscalationRequest": { "properties": { "choice": { "type": "string", "maxLength": 128, "title": "Choice" }, "was_timeout": { "type": "boolean", "title": "Was Timeout", "default": false } }, "type": "object", "required": [ "choice" ], "title": "ResolveEscalationRequest", "description": "Request body for escalation resolution." }, "RestoreRevisionRequest": { "properties": { "reason": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "title": "Reason" }, "actor": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ], "title": "Actor" }, "contract_clears": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Contract Clears" }, "stage_removals_confirmed": { "items": { "type": "string" }, "type": "array", "title": "Stage Removals Confirmed" } }, "additionalProperties": false, "type": "object", "title": "RestoreRevisionRequest", "description": "Request body for restoring a workflow revision as a new head." }, "ResumeWorkflowDerivationRequest": { "properties": { "resume_target": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resume Target" } }, "type": "object", "title": "ResumeWorkflowDerivationRequest", "description": "Request body for derivation resume." }, "ResumeWorkflowRunRequest": { "properties": { "resume_target": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resume Target" } }, "type": "object", "title": "ResumeWorkflowRunRequest", "description": "Request body for resuming a workflow run." }, "RevertActionRequest": { "properties": { "safety_mode": { "type": "string", "minLength": 1, "title": "Safety Mode" }, "working_dir": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Working Dir" } }, "type": "object", "required": [ "safety_mode" ], "title": "RevertActionRequest", "description": "Revert a checkpoint-backed assistant file action." }, "RuntimeLLMUpdateRequest": { "properties": { "provider": { "type": "string", "minLength": 1, "title": "Provider" }, "model": { "type": "string", "minLength": 1, "title": "Model", "default": "default" } }, "type": "object", "required": [ "provider" ], "title": "RuntimeLLMUpdateRequest", "description": "Request payload for changing the workflow runtime model config." }, "SettingsPatchRequest": { "properties": { "settings": { "additionalProperties": true, "type": "object", "title": "Settings" } }, "type": "object", "title": "SettingsPatchRequest", "description": "PATCH request payload for curated settings updates." }, "SubmitTurnRequest": { "properties": { "message": { "type": "string", "maxLength": 50000, "minLength": 1, "title": "Message" }, "context": { "$ref": "#/components/schemas/ContextAttachment" }, "model_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Id" } }, "type": "object", "required": [ "message", "context" ], "title": "SubmitTurnRequest", "description": "Submit a user turn to the assistant." }, "TemplateSetSelection": { "properties": { "stage_id": { "type": "string", "maxLength": 256, "minLength": 1, "title": "Stage Id" }, "role": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Role", "default": "primary_stage_instruction" }, "version": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "Version" } }, "additionalProperties": false, "type": "object", "required": [ "stage_id" ], "title": "TemplateSetSelection", "description": "One per-stage template-asset version selection." }, "TombstoneRunRequest": { "properties": { "reason": { "type": "string", "maxLength": 128, "title": "Reason" }, "purge_mode": { "type": "string", "maxLength": 64, "title": "Purge Mode", "default": "content_purged" } }, "additionalProperties": false, "type": "object", "required": [ "reason" ], "title": "TombstoneRunRequest", "description": "Request body for the hard-delete tombstone endpoint (ADR-118)." }, "UpdateThreadRequest": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "title": "Name" }, "archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Archived" }, "safety_mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Safety Mode" }, "workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workflow Id" }, "current_route": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Current Route" } }, "type": "object", "title": "UpdateThreadRequest", "description": "Update mutable thread fields." }, "UpdateTurnRequest": { "properties": { "outcome": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Outcome" }, "action_records": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Action Records" } }, "type": "object", "title": "UpdateTurnRequest", "description": "Persist client-observed turn outcome or record status changes." }, "ValidateInputRequest": { "properties": { "workflow_id": { "type": "string", "maxLength": 256, "title": "Workflow Id" }, "input_payload": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Input Payload" } }, "additionalProperties": false, "type": "object", "required": [ "workflow_id" ], "title": "ValidateInputRequest", "description": "Request body for workflow input pre-flight validation." }, "ValidateInterpolationRequest": { "properties": { "expression": { "type": "string", "maxLength": 1000, "title": "Expression" }, "context_hint": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Context Hint" } }, "type": "object", "required": [ "expression" ], "title": "ValidateInterpolationRequest", "description": "Interpolation validation request." }, "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" }, "WorkflowLabelRequest": { "properties": { "revision_id": { "type": "string", "maxLength": 256, "minLength": 1, "title": "Revision Id" }, "actor": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ], "title": "Actor" }, "reason": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "title": "Reason" } }, "additionalProperties": false, "type": "object", "required": [ "revision_id" ], "title": "WorkflowLabelRequest", "description": "Request body for assigning a workflow revision label." }, "WorkflowSyncResolveRequest": { "properties": { "strategy": { "type": "string", "enum": [ "adopt_remote", "keep_local" ], "title": "Strategy" }, "actor": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ], "title": "Actor" }, "reason": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "title": "Reason" } }, "additionalProperties": false, "type": "object", "required": [ "strategy" ], "title": "WorkflowSyncResolveRequest", "description": "Request body for resolving workflow sync divergence." }, "obra__gateway__routes__workflow_derivations__OperatorActionRequest": { "properties": { "action": { "type": "string", "maxLength": 128, "title": "Action" }, "payload": { "additionalProperties": true, "type": "object", "title": "Payload" } }, "type": "object", "required": [ "action" ], "title": "OperatorActionRequest", "description": "Request body for derivation operator actions." }, "obra__gateway__routes__workflow_runs__OperatorActionRequest": { "properties": { "action": { "type": "string", "maxLength": 128, "title": "Action" }, "payload": { "additionalProperties": true, "type": "object", "title": "Payload" } }, "type": "object", "required": [ "action" ], "title": "OperatorActionRequest", "description": "Request body for operator actions." } }, "securitySchemes": { "HTTPBearer": { "type": "http", "scheme": "bearer" } } } }