workos-office / AgentRuntime /openapi.json
dellweb3's picture
Work OS validated demo local-v0.8
99caad5 verified
Raw History Blame Contribute Delete
71.6 kB
{ "openapi": "3.1.0", "info": { "title": "Work OS Demo API Gateway", "description": "Local demo: persistent Workspace, Knowledge and Agent Runtime; fixture Identity/LLM/Tool/Notification", "version": "0.1.1" }, "paths": { "/health/live": { "get": { "summary": "Live", "operationId": "live_health_live_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/health/ready": { "get": { "summary": "Ready", "operationId": "ready_health_ready_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/v1/auth/login": { "post": { "summary": "Login", "operationId": "login_api_v1_auth_login_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Login" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/auth/logout": { "post": { "summary": "Logout", "operationId": "logout_api_v1_auth_logout_post", "responses": { "204": { "description": "Successful Response" } } } }, "/api/v1/me": { "get": { "summary": "Me", "operationId": "me_api_v1_me_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/v1/capabilities": { "get": { "summary": "Capabilities", "operationId": "capabilities_api_v1_capabilities_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/v1/workspaces": { "get": { "summary": "Workspaces", "operationId": "workspaces_api_v1_workspaces_get", "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "summary": "Create Workspace", "operationId": "create_workspace_api_v1_workspaces_post", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workspaces/{workspace_id}": { "get": { "summary": "Get Workspace", "operationId": "get_workspace_api_v1_workspaces__workspace_id__get", "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workspace Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "summary": "Rename Workspace", "operationId": "rename_workspace_api_v1_workspaces__workspace_id__patch", "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workspace Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspacePatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workspaces/{workspace_id}/messages": { "get": { "summary": "Messages", "operationId": "messages_api_v1_workspaces__workspace_id__messages_get", "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workspace Id" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Cursor" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 100, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "summary": "Create Message", "operationId": "create_message_api_v1_workspaces__workspace_id__messages_post", "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workspace Id" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workspaces/{workspace_id}/chat": { "post": { "summary": "Direct Chat", "operationId": "direct_chat_api_v1_workspaces__workspace_id__chat_post", "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workspace Id" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectChatInput" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workspaces/{workspace_id}/attachments": { "get": { "summary": "Attachments", "operationId": "attachments_api_v1_workspaces__workspace_id__attachments_get", "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workspace Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "summary": "Upload", "operationId": "upload_api_v1_workspaces__workspace_id__attachments_post", "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workspace Id" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_api_v1_workspaces__workspace_id__attachments_post" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/attachments/{attachment_id}/content": { "get": { "summary": "Attachment Content", "operationId": "attachment_content_api_v1_attachments__attachment_id__content_get", "parameters": [ { "name": "attachment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Attachment Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workspaces/{workspace_id}/context": { "get": { "summary": "Context", "operationId": "context_api_v1_workspaces__workspace_id__context_get", "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workspace Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workspaces/{workspace_id}/skills": { "put": { "summary": "Bind Skills", "operationId": "bind_skills_api_v1_workspaces__workspace_id__skills_put", "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workspace Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceSkillsInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/knowledge-bases": { "get": { "summary": "Knowledge Bases", "operationId": "knowledge_bases_api_v1_knowledge_bases_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/v1/workspaces/{workspace_id}/knowledge-documents": { "get": { "summary": "Knowledge Documents", "operationId": "knowledge_documents_api_v1_workspaces__workspace_id__knowledge_documents_get", "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workspace Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/knowledge/search": { "post": { "summary": "Search", "operationId": "search_api_v1_knowledge_search_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchInput" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/citations/{citation_id}": { "get": { "summary": "Citation", "operationId": "citation_api_v1_citations__citation_id__get", "parameters": [ { "name": "citation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Citation Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/employees": { "get": { "summary": "Employees", "operationId": "employees_api_v1_employees_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/v1/skills": { "get": { "summary": "Skills", "operationId": "skills_api_v1_skills_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } }, "post": { "summary": "Create Skill", "operationId": "create_skill_api_v1_skills_post", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/skills/{skill_id}": { "put": { "summary": "Update Skill", "operationId": "update_skill_api_v1_skills__skill_id__put", "parameters": [ { "name": "skill_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Skill Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workspaces/{workspace_id}/runs": { "post": { "summary": "Start Run", "operationId": "start_run_api_v1_workspaces__workspace_id__runs_post", "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workspace Id" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartRun" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/runs/{run_id}": { "get": { "summary": "Get Run", "operationId": "get_run_api_v1_runs__run_id__get", "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/runs/{run_id}/events": { "get": { "summary": "Events", "operationId": "events_api_v1_runs__run_id__events_get", "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } }, { "name": "after_sequence", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "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/v1/runs/{run_id}/cancel": { "post": { "summary": "Cancel Run", "operationId": "cancel_run_api_v1_runs__run_id__cancel_post", "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Idempotency-Key" } } ], "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/runs/{run_id}/approval": { "post": { "summary": "Approve Run", "operationId": "approve_run_api_v1_runs__run_id__approval_post", "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovalInput" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/artifacts/{artifact_id}": { "get": { "summary": "Artifact", "operationId": "artifact_api_v1_artifacts__artifact_id__get", "parameters": [ { "name": "artifact_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Artifact Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "summary": "Edit Artifact", "operationId": "edit_artifact_api_v1_artifacts__artifact_id__patch", "parameters": [ { "name": "artifact_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Artifact Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/artifacts/{artifact_id}/versions/{version}/content": { "get": { "summary": "Artifact Content", "operationId": "artifact_content_api_v1_artifacts__artifact_id__versions__version__content_get", "parameters": [ { "name": "artifact_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Artifact Id" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "integer", "title": "Version" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/tools": { "get": { "summary": "Tools", "operationId": "tools_api_v1_tools_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/v1/tool-receipts/{receipt_id}": { "get": { "summary": "Receipt", "operationId": "receipt_api_v1_tool_receipts__receipt_id__get", "parameters": [ { "name": "receipt_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Receipt Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/notifications": { "get": { "summary": "Notifications", "operationId": "notifications_api_v1_notifications_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/v1/notifications/{notification_id}/read": { "post": { "summary": "Read Notification", "operationId": "read_notification_api_v1_notifications__notification_id__read_post", "parameters": [ { "name": "notification_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Notification Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/operations": { "get": { "summary": "Operations", "operationId": "operations_api_v1_admin_operations_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } }, "post": { "summary": "Create Operation", "operationId": "create_operation_api_v1_admin_operations_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationInput" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/operations/{operation_id}": { "put": { "summary": "Edit Operation", "operationId": "edit_operation_api_v1_admin_operations__operation_id__put", "parameters": [ { "name": "operation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Operation Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "summary": "Delete Operation", "operationId": "delete_operation_api_v1_admin_operations__operation_id__delete", "parameters": [ { "name": "operation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Operation Id" } }, { "name": "expected_version", "in": "query", "required": true, "schema": { "type": "integer", "minimum": 1, "title": "Expected Version" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/workflows": { "get": { "summary": "Workflows", "operationId": "workflows_api_v1_admin_workflows_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } }, "post": { "summary": "Create Workflow", "operationId": "create_workflow_api_v1_admin_workflows_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowInput" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/workflows/{workflow_id}": { "get": { "summary": "Get Workflow", "operationId": "get_workflow_api_v1_admin_workflows__workflow_id__get", "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "summary": "Save Workflow", "operationId": "save_workflow_api_v1_admin_workflows__workflow_id__put", "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/workflows/{workflow_id}/validate": { "post": { "summary": "Validate Workflow", "operationId": "validate_workflow_api_v1_admin_workflows__workflow_id__validate_post", "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/workflows/{workflow_id}/publish": { "post": { "summary": "Publish Workflow", "operationId": "publish_workflow_api_v1_admin_workflows__workflow_id__publish_post", "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionInput" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/workspaces": { "get": { "summary": "Admin Workspaces", "operationId": "admin_workspaces_api_v1_admin_workspaces_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/v1/admin/workspaces/{workspace_id}/runtime": { "get": { "summary": "Get Binding", "operationId": "get_binding_api_v1_admin_workspaces__workspace_id__runtime_get", "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workspace Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "summary": "Bind", "operationId": "bind_api_v1_admin_workspaces__workspace_id__runtime_put", "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workspace Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BindingInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/workflows/{workflow_id}/runs": { "post": { "summary": "Trial", "operationId": "trial_api_v1_admin_workflows__workflow_id__runs_post", "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestRunInput" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/runs": { "get": { "summary": "Runs", "operationId": "runs_api_v1_admin_runs_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/v1/admin/runs/{run_id}": { "get": { "summary": "Run", "operationId": "run_api_v1_admin_runs__run_id__get", "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/runs/{run_id}/events": { "get": { "summary": "Events", "operationId": "events_api_v1_admin_runs__run_id__events_get", "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } }, { "name": "after_sequence", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "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/v1/admin/audit": { "get": { "summary": "Audit", "operationId": "audit_api_v1_admin_audit_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } } }, "components": { "schemas": { "ApprovalInput": { "properties": { "artifact_id": { "type": "string", "title": "Artifact Id" }, "expected_version": { "type": "integer", "minimum": 1.0, "title": "Expected Version" }, "content_hash": { "type": "string", "pattern": "^[a-f0-9]{64}$", "title": "Content Hash" } }, "additionalProperties": false, "type": "object", "required": [ "artifact_id", "expected_version", "content_hash" ], "title": "ApprovalInput" }, "ArtifactPatch": { "properties": { "content": { "type": "string", "maxLength": 65536, "minLength": 1, "title": "Content" }, "expected_version": { "type": "integer", "minimum": 1.0, "title": "Expected Version" } }, "additionalProperties": false, "type": "object", "required": [ "content", "expected_version" ], "title": "ArtifactPatch" }, "BindingInput": { "properties": { "workflow_id": { "type": "string", "maxLength": 80, "minLength": 1, "title": "Workflow Id" }, "workflow_version": { "type": "integer", "minimum": 1.0, "title": "Workflow Version" }, "base_ids": { "items": { "type": "string" }, "type": "array", "maxItems": 10, "title": "Base Ids" }, "expected_version": { "type": "integer", "minimum": 0.0, "title": "Expected Version" } }, "additionalProperties": false, "type": "object", "required": [ "workflow_id", "workflow_version", "base_ids", "expected_version" ], "title": "BindingInput" }, "Body_upload_api_v1_workspaces__workspace_id__attachments_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_upload_api_v1_workspaces__workspace_id__attachments_post" }, "DirectChatInput": { "properties": { "content": { "type": "string", "maxLength": 8192, "minLength": 1, "title": "Content" } }, "additionalProperties": false, "type": "object", "required": [ "content" ], "title": "DirectChatInput" }, "Edge": { "properties": { "source": { "type": "string", "maxLength": 80, "minLength": 1, "title": "Source" }, "target": { "type": "string", "maxLength": 80, "minLength": 1, "title": "Target" } }, "additionalProperties": false, "type": "object", "required": [ "source", "target" ], "title": "Edge" }, "Graph": { "properties": { "nodes": { "items": { "$ref": "#/components/schemas/Node" }, "type": "array", "maxItems": 40, "title": "Nodes" }, "edges": { "items": { "$ref": "#/components/schemas/Edge" }, "type": "array", "maxItems": 120, "title": "Edges" } }, "additionalProperties": false, "type": "object", "required": [ "nodes", "edges" ], "title": "Graph" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "Login": { "properties": { "username": { "type": "string", "maxLength": 80, "minLength": 1, "title": "Username" }, "password": { "type": "string", "maxLength": 256, "minLength": 1, "title": "Password" } }, "additionalProperties": false, "type": "object", "required": [ "username", "password" ], "title": "Login" }, "MessageCreate": { "properties": { "content": { "type": "string", "maxLength": 8192, "minLength": 1, "title": "Content" } }, "additionalProperties": false, "type": "object", "required": [ "content" ], "title": "MessageCreate" }, "Node": { "properties": { "id": { "type": "string", "maxLength": 80, "minLength": 1, "pattern": "^[A-Za-z0-9_-]+$", "title": "Id" }, "operation_id": { "type": "string", "maxLength": 80, "minLength": 1, "title": "Operation Id" }, "label": { "type": "string", "maxLength": 120, "minLength": 1, "title": "Label" }, "x": { "type": "number", "maximum": 10000.0, "minimum": -10000.0, "title": "X", "default": 0 }, "y": { "type": "number", "maximum": 10000.0, "minimum": -10000.0, "title": "Y", "default": 0 }, "config": { "additionalProperties": true, "type": "object", "title": "Config" } }, "additionalProperties": false, "type": "object", "required": [ "id", "operation_id", "label" ], "title": "Node" }, "OperationInput": { "properties": { "name": { "type": "string", "maxLength": 120, "minLength": 1, "title": "Name" }, "description": { "type": "string", "maxLength": 2000, "title": "Description", "default": "" }, "kind": { "type": "string", "enum": [ "start", "context", "knowledge", "llm", "review", "approval", "tool", "notification", "transform", "end" ], "title": "Kind" }, "config": { "additionalProperties": true, "type": "object", "title": "Config" }, "expected_version": { "anyOf": [ { "type": "integer", "minimum": 1.0 }, { "type": "null" } ], "title": "Expected Version" } }, "additionalProperties": false, "type": "object", "required": [ "name", "kind" ], "title": "OperationInput" }, "SearchInput": { "properties": { "workspace_id": { "type": "string", "title": "Workspace Id" }, "query": { "type": "string", "maxLength": 2000, "minLength": 1, "title": "Query" }, "base_ids": { "items": { "type": "string" }, "type": "array", "title": "Base Ids" }, "top_k": { "type": "integer", "maximum": 10.0, "minimum": 1.0, "title": "Top K", "default": 5 } }, "additionalProperties": false, "type": "object", "required": [ "workspace_id", "query" ], "title": "SearchInput" }, "SkillCreate": { "properties": { "name": { "type": "string", "maxLength": 120, "minLength": 1, "title": "Name" }, "category": { "type": "string", "pattern": "^(document|knowledge)$", "title": "Category" }, "content": { "type": "string", "maxLength": 32768, "minLength": 1, "title": "Content" } }, "additionalProperties": false, "type": "object", "required": [ "name", "category", "content" ], "title": "SkillCreate" }, "SkillUpdate": { "properties": { "name": { "type": "string", "maxLength": 120, "minLength": 1, "title": "Name" }, "category": { "type": "string", "pattern": "^(document|knowledge)$", "title": "Category" }, "content": { "type": "string", "maxLength": 32768, "minLength": 1, "title": "Content" }, "expected_version": { "type": "integer", "minimum": 1.0, "title": "Expected Version" } }, "additionalProperties": false, "type": "object", "required": [ "name", "category", "content", "expected_version" ], "title": "SkillUpdate" }, "StartRun": { "properties": { "employee_id": { "type": "string", "title": "Employee Id" }, "input_message_id": { "type": "string", "title": "Input Message Id" }, "skill_ids": { "items": { "type": "string" }, "type": "array", "title": "Skill Ids" } }, "additionalProperties": false, "type": "object", "required": [ "employee_id", "input_message_id" ], "title": "StartRun" }, "TestRunInput": { "properties": { "workspace_id": { "type": "string", "maxLength": 80, "minLength": 1, "title": "Workspace Id" }, "content": { "type": "string", "maxLength": 8192, "minLength": 1, "title": "Content" } }, "additionalProperties": false, "type": "object", "required": [ "workspace_id", "content" ], "title": "TestRunInput" }, "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" }, "VersionInput": { "properties": { "expected_version": { "type": "integer", "minimum": 1.0, "title": "Expected Version" } }, "additionalProperties": false, "type": "object", "required": [ "expected_version" ], "title": "VersionInput" }, "WorkflowInput": { "properties": { "name": { "type": "string", "maxLength": 120, "minLength": 1, "title": "Name" }, "description": { "type": "string", "maxLength": 2000, "title": "Description", "default": "" }, "graph": { "$ref": "#/components/schemas/Graph" }, "base_ids": { "items": { "type": "string" }, "type": "array", "maxItems": 10, "title": "Base Ids" }, "expected_version": { "anyOf": [ { "type": "integer", "minimum": 1.0 }, { "type": "null" } ], "title": "Expected Version" } }, "additionalProperties": false, "type": "object", "required": [ "name", "graph" ], "title": "WorkflowInput" }, "WorkspaceCreate": { "properties": { "title": { "type": "string", "maxLength": 120, "minLength": 1, "title": "Title" } }, "additionalProperties": false, "type": "object", "required": [ "title" ], "title": "WorkspaceCreate" }, "WorkspacePatch": { "properties": { "title": { "type": "string", "maxLength": 120, "minLength": 1, "title": "Title" }, "expected_version": { "type": "integer", "minimum": 1.0, "title": "Expected Version" } }, "additionalProperties": false, "type": "object", "required": [ "title", "expected_version" ], "title": "WorkspacePatch" }, "WorkspaceSkillsInput": { "properties": { "skill_ids": { "items": { "type": "string" }, "type": "array", "title": "Skill Ids" }, "expected_version": { "type": "integer", "minimum": 1.0, "title": "Expected Version" } }, "additionalProperties": false, "type": "object", "required": [ "skill_ids", "expected_version" ], "title": "WorkspaceSkillsInput" } } } }
{
"openapi": "3.1.0",
"info": {
"title": "Work OS Demo API Gateway",
"description": "Local demo: persistent Workspace, Knowledge and Agent Runtime; fixture Identity/LLM/Tool/Notification",
"version": "0.1.1"
},
"paths": {
"/health/live": {
"get": {
"summary": "Live",
"operationId": "live_health_live_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
}
}
},
"/health/ready": {
"get": {
"summary": "Ready",
"operationId": "ready_health_ready_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
}
}
},
"/api/v1/auth/login": {
"post": {
"summary": "Login",
"operationId": "login_api_v1_auth_login_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Login"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/auth/logout": {
"post": {
"summary": "Logout",
"operationId": "logout_api_v1_auth_logout_post",
"responses": {
"204": {
"description": "Successful Response"
}
}
}
},
"/api/v1/me": {
"get": {
"summary": "Me",
"operationId": "me_api_v1_me_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}