{ "components": { "responses": { "RateLimited": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnifiedErrorEnvelope" } } }, "description": "Rate limit exceeded", "headers": { "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "integer" } }, "X-RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Remaining requests in the current window", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Unix timestamp when the rate limit window resets", "schema": { "type": "integer" } } } }, "UnifiedError": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnifiedErrorEnvelope" } } }, "description": "Structured error envelope. Retryability is a hint; callers must also apply the documented operation/idempotency policy.", "headers": { "X-Operation-ID": { "schema": { "type": "string" } }, "X-Q-Retryable": { "description": "When present, false overrides all retry hints", "schema": { "enum": [ "true", "false" ], "type": "string" } } } } }, "schemas": { "A2A_A2ARequest": { "properties": { "id": { "oneOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] }, "jsonrpc": { "enum": [ "2.0" ], "type": "string" }, "method": { "enum": [ "SendMessage", "SendStreamingMessage", "GetTask", "ListTasks", "CancelTask", "CreateTaskPushNotificationConfig", "GetTaskPushNotificationConfig", "ListTaskPushNotificationConfigs", "DeleteTaskPushNotificationConfig", "SubscribeToTask", "GetExtendedAgentCard" ], "type": "string" }, "params": { "oneOf": [ { "$ref": "#/components/schemas/A2A_SendMessageRequest" }, { "$ref": "#/components/schemas/A2A_GetTaskRequest" }, { "$ref": "#/components/schemas/A2A_ListTasksRequest" }, { "$ref": "#/components/schemas/A2A_CancelTaskRequest" }, { "$ref": "#/components/schemas/A2A_TaskPushNotificationConfig" }, { "$ref": "#/components/schemas/A2A_GetTaskPushNotificationConfigRequest" }, { "$ref": "#/components/schemas/A2A_ListTaskPushNotificationConfigsRequest" }, { "$ref": "#/components/schemas/A2A_DeleteTaskPushNotificationConfigRequest" }, { "$ref": "#/components/schemas/A2A_SubscribeToTaskRequest" }, { "$ref": "#/components/schemas/A2A_GetExtendedAgentCardRequest" } ] } }, "required": [ "jsonrpc", "method", "id" ], "type": "object" }, "A2A_Artifact": { "properties": { "artifact_id": { "example": "artifact_id", "type": "string" }, "description": { "example": "", "type": "string" }, "extensions": { "example": [ "" ], "items": { "example": "", "type": "string" }, "type": "array" }, "metadata": { "type": "object" }, "name": { "example": "", "type": "string" }, "parts": { "example": [ { "text": "" } ], "items": { "$ref": "#/components/schemas/A2A_Part" }, "type": "array" } }, "type": "object" }, "A2A_AuthenticationInfo": { "properties": { "credentials": { "example": "", "type": "string" }, "scheme": { "example": "scheme", "type": "string" } }, "type": "object" }, "A2A_CancelTaskRequest": { "properties": { "id": { "example": "id", "type": "string" }, "metadata": { "type": "object" }, "tenant": { "example": "", "type": "string" } }, "type": "object" }, "A2A_DeleteTaskPushNotificationConfigRequest": { "properties": { "id": { "example": "id", "type": "string" }, "task_id": { "example": "task_id", "type": "string" }, "tenant": { "example": "", "type": "string" } }, "type": "object" }, "A2A_GetExtendedAgentCardRequest": { "properties": { "tenant": { "example": "", "type": "string" } }, "type": "object" }, "A2A_GetTaskPushNotificationConfigRequest": { "properties": { "id": { "example": "id", "type": "string" }, "task_id": { "example": "task_id", "type": "string" }, "tenant": { "example": "", "type": "string" } }, "type": "object" }, "A2A_GetTaskRequest": { "properties": { "history_length": { "format": "int32", "type": "integer" }, "id": { "example": "id", "type": "string" }, "tenant": { "example": "", "type": "string" } }, "type": "object" }, "A2A_ListTaskPushNotificationConfigsRequest": { "properties": { "page_size": { "format": "int32", "type": "integer" }, "page_token": { "example": "", "type": "string" }, "task_id": { "example": "task_id", "type": "string" }, "tenant": { "example": "", "type": "string" } }, "type": "object" }, "A2A_ListTasksRequest": { "properties": { "context_id": { "example": "", "type": "string" }, "history_length": { "format": "int32", "type": "integer" }, "include_artifacts": { "example": false, "type": "boolean" }, "page_size": { "format": "int32", "type": "integer" }, "page_token": { "example": "", "type": "string" }, "status": { "enum": [ "TASK_STATE_UNSPECIFIED", "TASK_STATE_SUBMITTED", "TASK_STATE_WORKING", "TASK_STATE_COMPLETED", "TASK_STATE_FAILED", "TASK_STATE_CANCELED", "TASK_STATE_INPUT_REQUIRED", "TASK_STATE_REJECTED", "TASK_STATE_AUTH_REQUIRED" ], "example": "TASK_STATE_SUBMITTED", "type": "string" }, "status_timestamp_after": { "format": "date-time", "type": "string" }, "tenant": { "example": "", "type": "string" } }, "type": "object" }, "A2A_ListTasksResponse": { "properties": { "next_page_token": { "example": "next_page_token", "type": "string" }, "page_size": { "format": "int32", "type": "integer" }, "tasks": { "items": { "$ref": "#/components/schemas/A2A_Task" }, "type": "array" }, "total_size": { "format": "int32", "type": "integer" } }, "type": "object" }, "A2A_Message": { "properties": { "context_id": { "example": "", "type": "string" }, "extensions": { "example": [ "" ], "items": { "example": "", "type": "string" }, "type": "array" }, "message_id": { "example": "message_id", "type": "string" }, "metadata": { "type": "object" }, "parts": { "example": [ { "text": "" } ], "items": { "$ref": "#/components/schemas/A2A_Part" }, "type": "array" }, "reference_task_ids": { "example": [ "" ], "items": { "example": "", "type": "string" }, "type": "array" }, "role": { "enum": [ "ROLE_UNSPECIFIED", "ROLE_USER", "ROLE_AGENT" ], "example": "ROLE_USER", "type": "string" }, "task_id": { "example": "", "type": "string" } }, "type": "object" }, "A2A_Part": { "allOf": [ { "properties": { "filename": { "example": "", "type": "string" }, "media_type": { "example": "", "type": "string" }, "metadata": { "type": "object" } }, "type": "object" }, { "oneOf": [ { "properties": { "text": { "example": "", "type": "string" } }, "required": [ "text" ], "type": "object" }, { "properties": { "raw": { "format": "byte", "type": "string" } }, "required": [ "raw" ], "type": "object" }, { "properties": { "url": { "example": "", "type": "string" } }, "required": [ "url" ], "type": "object" }, { "properties": { "data": {} }, "required": [ "data" ], "type": "object" } ] } ], "example": { "text": "" } }, "A2A_Result": { "properties": { "id": { "type": [ "string", "integer" ] }, "jsonrpc": { "const": "2.0", "type": "string" }, "result": { "anyOf": [ { "$ref": "#/components/schemas/A2A_Task" }, { "$ref": "#/components/schemas/A2A_SendMessageResponse" }, { "$ref": "#/components/schemas/A2A_ListTasksResponse" }, { "$ref": "#/components/schemas/A2A_StreamResponse" } ] } }, "required": [ "jsonrpc", "id", "result" ], "type": "object" }, "A2A_SendMessageConfiguration": { "properties": { "accepted_output_modes": { "example": [ "" ], "items": { "example": "", "type": "string" }, "type": "array" }, "history_length": { "format": "int32", "type": "integer" }, "return_immediately": { "example": false, "type": "boolean" }, "task_push_notification_config": { "example": null, "oneOf": [ { "$ref": "#/components/schemas/A2A_TaskPushNotificationConfig" }, { "type": "null" } ] } }, "type": "object" }, "A2A_SendMessageRequest": { "properties": { "configuration": { "example": null, "oneOf": [ { "$ref": "#/components/schemas/A2A_SendMessageConfiguration" }, { "type": "null" } ] }, "message": { "$ref": "#/components/schemas/A2A_Message" }, "metadata": { "type": "object" }, "tenant": { "example": "", "type": "string" } }, "type": "object" }, "A2A_SendMessageResponse": { "example": { "task": null }, "oneOf": [ { "properties": { "task": { "example": null, "oneOf": [ { "$ref": "#/components/schemas/A2A_Task" }, { "type": "null" } ] } }, "required": [ "task" ], "type": "object" }, { "properties": { "message": { "example": null, "oneOf": [ { "$ref": "#/components/schemas/A2A_Message" }, { "type": "null" } ] } }, "required": [ "message" ], "type": "object" } ] }, "A2A_StreamResponse": { "example": { "task": null }, "oneOf": [ { "properties": { "task": { "example": null, "oneOf": [ { "$ref": "#/components/schemas/A2A_Task" }, { "type": "null" } ] } }, "required": [ "task" ], "type": "object" }, { "properties": { "message": { "example": null, "oneOf": [ { "$ref": "#/components/schemas/A2A_Message" }, { "type": "null" } ] } }, "required": [ "message" ], "type": "object" }, { "properties": { "status_update": { "example": null, "oneOf": [ { "$ref": "#/components/schemas/A2A_TaskStatusUpdateEvent" }, { "type": "null" } ] } }, "required": [ "status_update" ], "type": "object" }, { "properties": { "artifact_update": { "example": null, "oneOf": [ { "$ref": "#/components/schemas/A2A_TaskArtifactUpdateEvent" }, { "type": "null" } ] } }, "required": [ "artifact_update" ], "type": "object" } ] }, "A2A_SubscribeToTaskRequest": { "properties": { "id": { "example": "id", "type": "string" }, "tenant": { "example": "", "type": "string" } }, "type": "object" }, "A2A_Task": { "properties": { "artifacts": { "items": { "$ref": "#/components/schemas/A2A_Artifact" }, "type": "array" }, "context_id": { "example": "", "type": "string" }, "history": { "items": { "$ref": "#/components/schemas/A2A_Message" }, "type": "array" }, "id": { "example": "id", "type": "string" }, "metadata": { "type": "object" }, "status": { "$ref": "#/components/schemas/A2A_TaskStatus" } }, "type": "object" }, "A2A_TaskArtifactUpdateEvent": { "properties": { "append": { "example": false, "type": "boolean" }, "artifact": { "$ref": "#/components/schemas/A2A_Artifact" }, "context_id": { "example": "context_id", "type": "string" }, "last_chunk": { "example": false, "type": "boolean" }, "metadata": { "type": "object" }, "task_id": { "example": "task_id", "type": "string" } }, "type": "object" }, "A2A_TaskPushNotificationConfig": { "properties": { "authentication": { "example": null, "oneOf": [ { "$ref": "#/components/schemas/A2A_AuthenticationInfo" }, { "type": "null" } ] }, "id": { "example": "", "type": "string" }, "task_id": { "example": "", "type": "string" }, "tenant": { "example": "", "type": "string" }, "token": { "example": "", "type": "string" }, "url": { "example": "url", "type": "string" } }, "type": "object" }, "A2A_TaskStatus": { "properties": { "message": { "example": null, "oneOf": [ { "$ref": "#/components/schemas/A2A_Message" }, { "type": "null" } ] }, "state": { "enum": [ "TASK_STATE_UNSPECIFIED", "TASK_STATE_SUBMITTED", "TASK_STATE_WORKING", "TASK_STATE_COMPLETED", "TASK_STATE_FAILED", "TASK_STATE_CANCELED", "TASK_STATE_INPUT_REQUIRED", "TASK_STATE_REJECTED", "TASK_STATE_AUTH_REQUIRED" ], "example": "TASK_STATE_SUBMITTED", "type": "string" }, "timestamp": { "format": "date-time", "type": "string" } }, "type": "object" }, "A2A_TaskStatusUpdateEvent": { "properties": { "context_id": { "example": "context_id", "type": "string" }, "metadata": { "type": "object" }, "status": { "$ref": "#/components/schemas/A2A_TaskStatus" }, "task_id": { "example": "task_id", "type": "string" } }, "type": "object" }, "AgentCapabilities": { "properties": { "extendedAgentCard": { "default": false, "title": "Extendedagentcard", "type": "boolean" }, "extensions": { "items": { "additionalProperties": true, "type": "object" }, "title": "Extensions", "type": "array" }, "pushNotifications": { "default": false, "title": "Pushnotifications", "type": "boolean" }, "streaming": { "title": "Streaming", "type": "boolean" } }, "required": [ "streaming" ], "title": "AgentCapabilities", "type": "object" }, "AgentCard": { "properties": { "capabilities": { "$ref": "#/components/schemas/AgentCapabilities" }, "defaultInputModes": { "items": { "type": "string" }, "title": "Defaultinputmodes", "type": "array" }, "defaultOutputModes": { "items": { "type": "string" }, "title": "Defaultoutputmodes", "type": "array" }, "description": { "title": "Description", "type": "string" }, "documentationUrl": { "default": "", "title": "Documentationurl", "type": "string" }, "iconUrl": { "default": "", "title": "Iconurl", "type": "string" }, "name": { "title": "Name", "type": "string" }, "securityRequirements": { "items": { "additionalProperties": true, "type": "object" }, "title": "Securityrequirements", "type": "array" }, "securitySchemes": { "additionalProperties": { "additionalProperties": true, "type": "object" }, "title": "Securityschemes", "type": "object" }, "signatures": { "items": { "additionalProperties": true, "type": "object" }, "title": "Signatures", "type": "array" }, "skills": { "items": { "$ref": "#/components/schemas/AgentSkill" }, "title": "Skills", "type": "array" }, "supportedInterfaces": { "items": { "$ref": "#/components/schemas/AgentInterface" }, "title": "Supportedinterfaces", "type": "array" }, "version": { "title": "Version", "type": "string" } }, "required": [ "name", "description", "supportedInterfaces", "version", "capabilities", "defaultInputModes", "defaultOutputModes", "securitySchemes", "securityRequirements", "skills" ], "title": "AgentCard", "type": "object" }, "AgentCreated": { "additionalProperties": true, "properties": { "agent_type": { "title": "Agent Type", "type": "string" }, "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "status": { "title": "Status", "type": "string" }, "tenant_id": { "title": "Tenant Id", "type": "string" } }, "required": [ "id", "tenant_id", "name", "agent_type", "status" ], "title": "AgentCreated", "type": "object" }, "AgentExecuteRequest": { "additionalProperties": false, "properties": { "agent_id": { "maxLength": 64, "minLength": 1, "title": "Agent Id", "type": "string" }, "config": { "additionalProperties": true, "title": "Config", "type": "object" }, "input": { "additionalProperties": true, "title": "Input", "type": "object" }, "mode": { "default": "async", "enum": [ "sync", "async", "stream" ], "title": "Mode", "type": "string" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id" } }, "required": [ "agent_id", "input" ], "title": "AgentExecuteRequest", "type": "object" }, "AgentExecuteResponse": { "properties": { "agent_id": { "title": "Agent Id", "type": "string" }, "execution_id": { "title": "Execution Id", "type": "string" }, "poll_url": { "title": "Poll Url", "type": "string" }, "result": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Result" }, "status": { "enum": [ "pending", "running", "completed", "failed", "cancelled" ], "title": "Status", "type": "string" }, "stream_url": { "title": "Stream Url", "type": "string" } }, "required": [ "execution_id", "status", "agent_id", "poll_url", "stream_url" ], "title": "AgentExecuteResponse", "type": "object" }, "AgentExecutionResponse": { "properties": { "agent_id": { "title": "Agent Id", "type": "string" }, "error": { "anyOf": [ { "$ref": "#/components/schemas/JobError" }, { "type": "null" } ] }, "id": { "title": "Id", "type": "string" }, "progress": { "anyOf": [ { "$ref": "#/components/schemas/AgentProgress" }, { "type": "null" } ] }, "quality": { "$ref": "#/components/schemas/ResultQuality" }, "result": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Result" }, "status": { "enum": [ "pending", "running", "completed", "failed", "cancelled" ], "title": "Status", "type": "string" } }, "required": [ "id", "agent_id", "status" ], "title": "AgentExecutionResponse", "type": "object" }, "AgentInterface": { "properties": { "protocolBinding": { "title": "Protocolbinding", "type": "string" }, "protocolVersion": { "title": "Protocolversion", "type": "string" }, "tenant": { "default": "", "title": "Tenant", "type": "string" }, "url": { "title": "Url", "type": "string" } }, "required": [ "url", "protocolBinding", "protocolVersion" ], "title": "AgentInterface", "type": "object" }, "AgentMessage": { "properties": { "content": { "title": "Content", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "role": { "enum": [ "system", "user", "assistant", "tool" ], "title": "Role", "type": "string" } }, "required": [ "role", "content" ], "title": "AgentMessage", "type": "object" }, "AgentProgress": { "properties": { "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "percent": { "default": 0, "title": "Percent", "type": "integer" }, "stage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stage" } }, "title": "AgentProgress", "type": "object" }, "AgentRegistration": { "additionalProperties": false, "properties": { "agentId": { "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", "title": "Agentid", "type": "string" }, "bearer_token": { "anyOf": [ { "format": "password", "maxLength": 8192, "type": "string", "writeOnly": true }, { "type": "null" } ], "title": "Bearer Token" }, "description": { "default": "", "title": "Description", "type": "string" }, "endpoint": { "default": "", "title": "Endpoint", "type": "string" }, "name": { "maxLength": 200, "title": "Name", "type": "string" }, "protocols": { "items": { "type": "string" }, "title": "Protocols", "type": "array" }, "skills": { "items": { "$ref": "#/components/schemas/AgentSkillSchema" }, "title": "Skills", "type": "array" }, "version": { "default": "1.0.0", "title": "Version", "type": "string" } }, "required": [ "agentId", "name" ], "title": "AgentRegistration", "type": "object" }, "AgentRequest": { "properties": { "max_tokens": { "default": 1024, "exclusiveMinimum": 0.0, "maximum": 16384.0, "title": "Max Tokens", "type": "integer" }, "messages": { "items": { "$ref": "#/components/schemas/AgentMessage" }, "title": "Messages", "type": "array" }, "model": { "description": "Provider-prefixed model id, e.g. openai/gpt-4.1-mini", "title": "Model", "type": "string" }, "stream": { "default": false, "title": "Stream", "type": "boolean" }, "temperature": { "default": 0.2, "title": "Temperature", "type": "number" }, "tool_choice": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Tool Choice" }, "tools": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Tools" }, "top_p": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Top P" } }, "required": [ "model", "messages" ], "title": "AgentRequest", "type": "object" }, "AgentRunMode": { "enum": [ "quick", "pro", "deep", "raw", "plan", "agent", "ask", "debug" ], "title": "AgentRunMode", "type": "string" }, "AgentRunReceipt": { "additionalProperties": true, "properties": { "agent_id": { "title": "Agent Id", "type": "string" }, "run_id": { "title": "Run Id", "type": "string" }, "stream_key": { "title": "Stream Key", "type": "string" } }, "required": [ "agent_id", "run_id", "stream_key" ], "title": "AgentRunReceipt", "type": "object" }, "AgentRunResponse": { "additionalProperties": true, "properties": { "agent_id": { "title": "Agent Id", "type": "string" }, "completed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Completed At" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "deadline_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deadline At" }, "durability": { "default": "legacy", "title": "Durability", "type": "string" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message" }, "id": { "title": "Id", "type": "string" }, "lifecycle_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Lifecycle Version" }, "mode": { "title": "Mode", "type": "string" }, "parent_run_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Run Id" }, "prompt": { "title": "Prompt", "type": "string" }, "result_access_error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Result Access Error" }, "result_json": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Result Json" }, "row_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Row Version" }, "started_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Started At" }, "status": { "title": "Status", "type": "string" }, "stream_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stream Key" }, "temporal_workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Temporal Workflow Id" }, "tenant_id": { "title": "Tenant Id", "type": "string" }, "usage_json": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Usage Json" } }, "required": [ "id", "agent_id", "tenant_id", "prompt", "status", "mode", "result_json", "usage_json", "error_message", "parent_run_id", "temporal_workflow_id", "started_at", "completed_at", "created_at" ], "title": "AgentRunResponse", "type": "object" }, "AgentSkill": { "properties": { "description": { "title": "Description", "type": "string" }, "examples": { "items": { "type": "string" }, "title": "Examples", "type": "array" }, "id": { "title": "Id", "type": "string" }, "inputModes": { "items": { "type": "string" }, "title": "Inputmodes", "type": "array" }, "name": { "title": "Name", "type": "string" }, "outputModes": { "items": { "type": "string" }, "title": "Outputmodes", "type": "array" }, "securityRequirements": { "items": { "additionalProperties": true, "type": "object" }, "title": "Securityrequirements", "type": "array" }, "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" } }, "required": [ "id", "name", "description", "tags" ], "title": "AgentSkill", "type": "object" }, "AgentSkillSchema": { "properties": { "description": { "default": "", "title": "Description", "type": "string" }, "inputSchema": { "additionalProperties": true, "title": "Inputschema", "type": "object" }, "name": { "maxLength": 200, "title": "Name", "type": "string" }, "outputSchema": { "additionalProperties": true, "title": "Outputschema", "type": "object" }, "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" } }, "required": [ "name" ], "title": "AgentSkillSchema", "type": "object" }, "AgentStreamDone": { "additionalProperties": true, "properties": { "result": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Result" }, "result_url": { "title": "Result Url", "type": "string" }, "row_version": { "minimum": 1, "title": "Row Version", "type": "integer" }, "status": { "enum": [ "completed", "failed", "cancelled", "expired" ], "title": "Status", "type": "string" }, "usage": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Usage" } }, "required": [ "status", "result_url", "row_version" ], "title": "AgentStreamDone", "type": "object" }, "AgentStreamEnvelope": { "additionalProperties": true, "properties": { "cursor": { "title": "Cursor", "type": "string" }, "payload": { "additionalProperties": true, "title": "Payload", "type": "object" }, "revision": { "maximum": 9999999999, "minimum": 0, "title": "Revision", "type": "integer" }, "run_id": { "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "title": "Run Id", "type": "string" }, "sequence": { "maximum": 9999999999, "minimum": 1, "title": "Sequence", "type": "integer" }, "type": { "title": "Type", "type": "string" }, "version": { "const": "1", "title": "Version", "type": "string" } }, "required": [ "version", "type", "run_id", "sequence", "cursor", "revision", "payload" ], "title": "AgentStreamEnvelope", "type": "object" }, "AgentStreamRevision": { "additionalProperties": true, "properties": { "answer": { "title": "Answer", "type": "string" }, "reason": { "title": "Reason", "type": "string" }, "replace": { "const": true, "title": "Replace", "type": "boolean" } }, "required": [ "reason", "replace", "answer" ], "title": "AgentStreamRevision", "type": "object" }, "AgentSummary": { "additionalProperties": true, "properties": { "agent_type": { "title": "Agent Type", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "status": { "title": "Status", "type": "string" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "required": [ "id", "name", "description", "agent_type", "status", "updated_at" ], "title": "AgentSummary", "type": "object" }, "AgentType": { "enum": [ "answer", "research", "document", "presentation", "analysis", "code", "pack", "custom" ], "title": "AgentType", "type": "string" }, "AiCapabilities": { "additionalProperties": true, "properties": { "capabilities": { "items": { "$ref": "#/components/schemas/AiCapability" }, "title": "Capabilities", "type": "array" } }, "required": [ "capabilities" ], "title": "AiCapabilities", "type": "object" }, "AiCapability": { "additionalProperties": true, "properties": { "capability": { "title": "Capability", "type": "string" }, "description": { "title": "Description", "type": "string" }, "execution_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Execution Model" }, "implementation_route": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Implementation Route" }, "implementation_route_public": { "title": "Implementation Route Public", "type": "boolean" }, "job_endpoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Job Endpoint" }, "job_supported": { "title": "Job Supported", "type": "boolean" }, "readiness_url": { "title": "Readiness Url", "type": "string" }, "result_format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Result Format" } }, "required": [ "capability", "description", "job_supported", "readiness_url", "job_endpoint", "implementation_route", "implementation_route_public", "execution_model", "result_format" ], "title": "AiCapability", "type": "object" }, "AiJobEventPayload": { "additionalProperties": true, "properties": { "error": { "anyOf": [ { "$ref": "#/components/schemas/JobError" }, { "type": "null" } ], "default": null }, "job_id": { "title": "Job Id", "type": "string" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Message" }, "progress_percent": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Progress Percent" }, "result": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Result" }, "seq": { "title": "Seq", "type": "integer" }, "stage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Stage" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" } }, "required": [ "seq", "job_id" ], "title": "AiJobEventPayload", "type": "object" }, "AiJobOptions": { "additionalProperties": false, "properties": { "enable_follow_ups": { "default": false, "title": "Enable Follow Ups", "type": "boolean" }, "enable_grounding": { "default": true, "title": "Enable Grounding", "type": "boolean" }, "enable_live_web": { "default": false, "title": "Enable Live Web", "type": "boolean" }, "max_sources": { "default": 6, "maximum": 30.0, "minimum": 1.0, "title": "Max Sources", "type": "integer" }, "max_sub_queries": { "default": 3, "maximum": 12.0, "minimum": 1.0, "title": "Max Sub Queries", "type": "integer" }, "max_tokens": { "default": 4096, "maximum": 16384.0, "minimum": 256.0, "title": "Max Tokens", "type": "integer" }, "mode": { "$ref": "#/components/schemas/AnswerMode", "default": "pro" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" }, "stream": { "default": true, "title": "Stream", "type": "boolean" }, "temperature": { "default": 0.2, "maximum": 1.5, "minimum": 0.0, "title": "Temperature", "type": "number" } }, "title": "AiJobOptions", "type": "object" }, "AiJobReceipt": { "additionalProperties": true, "properties": { "job_id": { "title": "Job Id", "type": "string" }, "status": { "enum": [ "queued", "running", "completed", "failed", "cancelled" ], "title": "Status", "type": "string" }, "status_url": { "title": "Status Url", "type": "string" }, "stream_url": { "title": "Stream Url", "type": "string" } }, "required": [ "job_id", "status", "status_url", "stream_url" ], "title": "AiJobReceipt", "type": "object" }, "AiJobResponse": { "additionalProperties": true, "properties": { "capability": { "title": "Capability", "type": "string" }, "current_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Current Message" }, "current_stage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Current Stage" }, "error": { "anyOf": [ { "$ref": "#/components/schemas/JobError" }, { "type": "null" } ] }, "events_seen": { "title": "Events Seen", "type": "integer" }, "job_id": { "title": "Job Id", "type": "string" }, "progress_percent": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Progress Percent" }, "quality": { "$ref": "#/components/schemas/ResultQuality" }, "result": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Result" }, "started_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Started At" }, "status": { "enum": [ "queued", "running", "completed", "failed", "cancelled" ], "title": "Status", "type": "string" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "required": [ "job_id", "capability", "status", "progress_percent", "current_stage", "current_message", "started_at", "updated_at", "result", "error", "events_seen" ], "title": "AiJobResponse", "type": "object" }, "AiJobStartRequest": { "additionalProperties": false, "properties": { "capability": { "enum": [ "generate_document", "edit_document", "generate_article", "generate_social_post", "deep_research", "pack_architect", "chat_with_tools" ], "title": "Capability", "type": "string" }, "input": { "additionalProperties": true, "title": "Input", "type": "object" }, "options": { "$ref": "#/components/schemas/AiJobOptions" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id" } }, "required": [ "capability", "input" ], "title": "AiJobStartRequest", "type": "object" }, "AnswerEventEnvelope": { "additionalProperties": true, "description": "Existing Answer SSE data; type is open for forward-compatible event names.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "payload": { "additionalProperties": true, "title": "Payload", "type": "object" }, "type": { "title": "Type", "type": "string" } }, "required": [ "type", "payload" ], "title": "AnswerEventEnvelope", "type": "object" }, "AnswerMode": { "description": "Answer modes \u2014 retrieval depth *and* execution contract.\n\nRetrieval-depth modes (pipeline):\n\n* ``QUICK`` \u2014 single retrieval pass, fastest model (``ModelPurpose.FAST``).\n* ``PRO`` \u2014 LLM planner with 3+ sub-queries, live web + RAG, grounding\n retry up to 2 times. Uses ``ModelPurpose.DEFAULT``.\n* ``DEEP`` \u2014 long-running Temporal workflow; iterates the engine for N\n rounds with larger budgets. Uses ``ModelPurpose.PRECISION``.\n* ``RAW`` \u2014 bypass the engine and pass straight through to the LLM.\n\nExecution-contract modes (distinct capability surface):\n\n* ``PLAN`` \u2014 research with read-only tools, emit an editable structured\n plan with TODO steps, await human approval before any execution.\n* ``AGENT`` \u2014 full autonomous ReAct loop (observe \u2192 plan \u2192 act \u2192 verify)\n with action tools (file I/O, shell, code execution).\n* ``ASK`` \u2014 read-only exploration; no writes or execution, conversational\n synthesis without citation-level grounding checks.\n* ``DEBUG`` \u2014 systematic troubleshooting with enhanced runtime evidence\n gathering; hypothesis-driven investigation before proposing fixes.\n\nUser-facing surfaces should prefer :class:`UserAnswerMode` (four modes)\nand treat ``QUICK``/``PRO``/``DEEP`` as internal :class:`RetrievalTier`\nvalues resolved by the classifier.", "enum": [ "quick", "pro", "deep", "raw", "plan", "agent", "ask", "debug" ], "title": "AnswerMode", "type": "string" }, "AnswerRequestPayload": { "properties": { "attachments": { "description": "Ephemeral attachment ids from POST /api/v1/attachments; text is re-hydrated server-side and prepended to the system prompt.", "items": { "type": "string" }, "title": "Attachments", "type": "array" }, "conversation_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Conversation Id" }, "enable_follow_ups": { "default": true, "title": "Enable Follow Ups", "type": "boolean" }, "enable_grounding": { "default": true, "title": "Enable Grounding", "type": "boolean" }, "enable_live_web": { "default": true, "title": "Enable Live Web", "type": "boolean" }, "enable_tool_approval": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "When true, WRITE+ action tools pause for human approval before execution.", "title": "Enable Tool Approval" }, "evidence_policy": { "$ref": "#/components/schemas/EvidencePolicy" }, "explicit_context": { "description": "User-pinned @-mention context: list of {type, reference, label?, content?} where type is file | codebase | url | plan.", "items": { "additionalProperties": true, "type": "object" }, "title": "Explicit Context", "type": "array" }, "extra_context": { "additionalProperties": true, "description": "Small structured product context. Large third-party vector context should be supplied through federated_endpoints instead of prompt text.", "title": "Extra Context", "type": "object" }, "federated_endpoints": { "items": { "additionalProperties": true, "type": "object" }, "title": "Federated Endpoints", "type": "array" }, "focus": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Retrieval lens (auto, academic, internal, \u2026)", "title": "Focus" }, "history": { "items": { "additionalProperties": { "type": "string" }, "type": "object" }, "title": "History", "type": "array" }, "ide_context": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "Rich IDE state: open_files, active_file, cursor_position, recent_edits, linter_errors, git_status.", "title": "Ide Context" }, "load_plan_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When set, load a saved plan from the workspace plan store instead of generating a new one.", "title": "Load Plan Id" }, "max_sources": { "default": 8, "exclusiveMinimum": 0.0, "maximum": 30.0, "title": "Max Sources", "type": "integer" }, "max_sub_queries": { "default": 4, "exclusiveMinimum": 0.0, "maximum": 12.0, "title": "Max Sub Queries", "type": "integer" }, "max_tokens": { "anyOf": [ { "exclusiveMinimum": 0.0, "maximum": 16384.0, "type": "integer" }, { "type": "null" } ], "title": "Max Tokens" }, "mcp_tools": { "items": { "additionalProperties": true, "type": "object" }, "title": "Mcp Tools", "type": "array" }, "mode": { "anyOf": [ { "$ref": "#/components/schemas/AnswerMode" }, { "type": "null" } ], "description": "User-facing mode: ask | plan | agent | debug. Legacy values quick | pro | deep map to ask with an internal retrieval tier." }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" }, "output_schema": { "anyOf": [ { "$ref": "#/components/schemas/OutputSchema" }, { "type": "null" } ] }, "parent_artifact_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When set, the follow-up refines the given artifact instead of creating a new one. The engine seeds the writer with the previous report (so `can you improve the slide deck to include graphs and images` edits the existing deck rather than starting a fresh topic) and the finaliser appends a new version to the same ``Artifact`` record.", "title": "Parent Artifact Id" }, "plan_approval": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "When true, pause after the planner until POST .../answer/{run_id}/approve", "title": "Plan Approval" }, "plan_approval_policy": { "anyOf": [ { "enum": [ "none", "advisory", "required" ], "type": "string" }, { "type": "null" } ], "title": "Plan Approval Policy" }, "plan_approval_timeout_seconds": { "anyOf": [ { "maximum": 3600.0, "minimum": 10.0, "type": "number" }, { "type": "null" } ], "description": "Approval validity in seconds. Only an explicit advisory policy can continue on expiry.", "title": "Plan Approval Timeout Seconds" }, "query": { "maxLength": 8000, "minLength": 1, "title": "Query", "type": "string" }, "save_plan": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "When true, persist the generated execution plan to the workspace plan store.", "title": "Save Plan" }, "session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Session Id" }, "source_page": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Slug of a published /p/ page to pin as a source. Used by the 'Continue in Q' CTA on published pages so the follow-up conversation cites the page the reader started from.", "title": "Source Page" }, "space_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When set, scopes retrieval to the given Space and applies the Space's instructions / model preferences as defaults.", "title": "Space Id" }, "stream": { "default": true, "title": "Stream", "type": "boolean" }, "stream_version": { "anyOf": [ { "const": "1", "type": "string" }, { "type": "null" } ], "description": "Opt in to the versioned machine answer event contract.", "title": "Stream Version" }, "system_prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "System Prompt" }, "temperature": { "default": 0.2, "maximum": 1.5, "minimum": 0.0, "title": "Temperature", "type": "number" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id" }, "workspace_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Opaque tenant-owned workspace resource ID.", "title": "Workspace Id" } }, "required": [ "query" ], "title": "AnswerRequestPayload", "type": "object" }, "AnswerResponse": { "additionalProperties": true, "properties": { "answer": { "title": "Answer", "type": "string" }, "citations": { "items": { "$ref": "#/components/schemas/Citation" }, "title": "Citations", "type": "array" }, "content": { "title": "Content", "type": "string" }, "elapsed_ms": { "title": "Elapsed Ms", "type": "integer" }, "evidence": { "$ref": "#/components/schemas/EvidenceReport" }, "follow_ups": { "items": { "type": "string" }, "title": "Follow Ups", "type": "array" }, "grounding_score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Grounding Score" }, "mode": { "title": "Mode", "type": "string" }, "model_used": { "title": "Model Used", "type": "string" }, "plan": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Plan" }, "quality": { "$ref": "#/components/schemas/ResultQuality" }, "query": { "title": "Query", "type": "string" }, "search_results": { "items": { "$ref": "#/components/schemas/Source" }, "title": "Search Results", "type": "array" }, "search_trace": { "$ref": "#/components/schemas/SearchTrace" }, "sources": { "items": { "$ref": "#/components/schemas/Source" }, "title": "Sources", "type": "array" }, "structured_output": { "$ref": "#/components/schemas/StructuredOutput" }, "tokens_in": { "title": "Tokens In", "type": "integer" }, "tokens_out": { "title": "Tokens Out", "type": "integer" }, "verification": { "anyOf": [ { "$ref": "#/components/schemas/AnswerVerification" }, { "type": "null" } ], "default": null }, "verified_claims": { "items": { "$ref": "#/components/schemas/VerifiedClaim" }, "title": "Verified Claims", "type": "array" } }, "required": [ "query", "answer", "content", "mode", "sources", "search_results", "citations", "search_trace", "follow_ups", "plan", "grounding_score", "elapsed_ms", "model_used", "tokens_in", "tokens_out" ], "title": "AnswerResponse", "type": "object" }, "AnswerStreamApproval": { "additionalProperties": true, "properties": { "action_version": { "title": "Action Version", "type": "string" }, "approval_id": { "title": "Approval Id", "type": "string" }, "details": { "additionalProperties": true, "title": "Details", "type": "object" }, "kind": { "enum": [ "plan", "tool", "budget" ], "title": "Kind", "type": "string" }, "policy": { "enum": [ "required", "advisory" ], "title": "Policy", "type": "string" } }, "required": [ "approval_id", "kind", "action_version", "policy", "details" ], "title": "AnswerStreamApproval", "type": "object" }, "AnswerStreamCompleted": { "additionalProperties": true, "properties": { "result": { "$ref": "#/components/schemas/AnswerResponse" } }, "required": [ "result" ], "title": "AnswerStreamCompleted", "type": "object" }, "AnswerStreamDelta": { "additionalProperties": true, "properties": { "delta": { "title": "Delta", "type": "string" }, "provisional": { "const": true, "default": true, "title": "Provisional", "type": "boolean" } }, "required": [ "delta" ], "title": "AnswerStreamDelta", "type": "object" }, "AnswerStreamEnvelope": { "additionalProperties": true, "properties": { "cursor": { "title": "Cursor", "type": "string" }, "payload": { "additionalProperties": true, "title": "Payload", "type": "object" }, "revision": { "maximum": 9999999999, "minimum": 0, "title": "Revision", "type": "integer" }, "run_id": { "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "title": "Run Id", "type": "string" }, "sequence": { "maximum": 9999999999, "minimum": 1, "title": "Sequence", "type": "integer" }, "type": { "title": "Type", "type": "string" }, "version": { "const": "1", "title": "Version", "type": "string" } }, "required": [ "version", "type", "run_id", "sequence", "cursor", "revision", "payload" ], "title": "AnswerStreamEnvelope", "type": "object" }, "AnswerStreamFailed": { "additionalProperties": true, "properties": { "code": { "title": "Code", "type": "string" }, "message": { "title": "Message", "type": "string" }, "outcome": { "enum": [ "failed", "unknown" ], "title": "Outcome", "type": "string" }, "retryable": { "const": false, "default": false, "title": "Retryable", "type": "boolean" } }, "required": [ "code", "message", "outcome" ], "title": "AnswerStreamFailed", "type": "object" }, "AnswerStreamHeartbeat": { "additionalProperties": true, "properties": {}, "title": "AnswerStreamHeartbeat", "type": "object" }, "AnswerStreamProgress": { "additionalProperties": true, "properties": { "details": { "additionalProperties": true, "title": "Details", "type": "object" }, "stage": { "title": "Stage", "type": "string" } }, "required": [ "stage", "details" ], "title": "AnswerStreamProgress", "type": "object" }, "AnswerStreamRevision": { "additionalProperties": true, "properties": { "reason": { "title": "Reason", "type": "string" }, "replace": { "const": true, "default": true, "title": "Replace", "type": "boolean" } }, "required": [ "reason" ], "title": "AnswerStreamRevision", "type": "object" }, "AnswerStreamStarted": { "additionalProperties": true, "properties": { "expires_at": { "title": "Expires At", "type": "number" }, "replay_safe": { "title": "Replay Safe", "type": "boolean" }, "resume_path": { "title": "Resume Path", "type": "string" } }, "required": [ "expires_at", "resume_path", "replay_safe" ], "title": "AnswerStreamStarted", "type": "object" }, "AnswerTrace": { "additionalProperties": true, "properties": { "final_citations": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Final Citations" }, "queries_issued": { "items": { "type": "string" }, "title": "Queries Issued", "type": "array" }, "rerank_elapsed_ms": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Rerank Elapsed Ms" }, "rerank_layers": { "title": "Rerank Layers" }, "rerank_results": { "title": "Rerank Results" }, "retrieval_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Retrieval Meta" }, "run_id": { "title": "Run Id", "type": "string" }, "search_trace": { "additionalProperties": true, "title": "Search Trace", "type": "object" }, "session_trace": { "additionalProperties": true, "title": "Session Trace", "type": "object" }, "sources_per_tool": { "items": { "additionalProperties": true, "type": "object" }, "title": "Sources Per Tool", "type": "array" }, "timing_ms": { "additionalProperties": true, "title": "Timing Ms", "type": "object" }, "tools_used": { "items": { "type": "string" }, "title": "Tools Used", "type": "array" }, "trace_detail": { "additionalProperties": true, "title": "Trace Detail", "type": "object" } }, "required": [ "run_id", "trace_detail", "search_trace", "session_trace", "queries_issued", "tools_used", "sources_per_tool", "rerank_elapsed_ms", "final_citations", "timing_ms", "retrieval_meta" ], "title": "AnswerTrace", "type": "object" }, "AnswerVerification": { "properties": { "claims": { "items": { "$ref": "#/components/schemas/VerifiedClaim" }, "title": "Claims", "type": "array" }, "contradicted": { "default": 0, "title": "Contradicted", "type": "integer" }, "coverage": { "default": 0, "title": "Coverage", "type": "number" }, "flagged": { "default": 0, "title": "Flagged", "type": "integer" }, "score_kind": { "const": "verifier_score_not_probability", "default": "verifier_score_not_probability", "title": "Score Kind", "type": "string" }, "status": { "default": "not_run", "enum": [ "complete", "partial", "not_run" ], "title": "Status", "type": "string" }, "total": { "default": 0, "title": "Total", "type": "integer" }, "truncated": { "default": false, "title": "Truncated", "type": "boolean" }, "unknown": { "default": 0, "title": "Unknown", "type": "integer" }, "verified": { "default": 0, "title": "Verified", "type": "integer" } }, "title": "AnswerVerification", "type": "object" }, "ApprovalDecision": { "additionalProperties": true, "properties": { "action_id": { "title": "Action Id", "type": "string" }, "action_version": { "title": "Action Version", "type": "string" }, "approval_id": { "title": "Approval Id", "type": "string" }, "approved": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Approved" }, "decision": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Decision" }, "expires_at": { "title": "Expires At", "type": "number" }, "kind": { "title": "Kind", "type": "string" }, "ok": { "title": "Ok", "type": "boolean" }, "pause_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pause Id" }, "policy": { "title": "Policy", "type": "string" }, "proposal": { "additionalProperties": true, "title": "Proposal", "type": "object" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request Id" }, "run_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Run Id" }, "status": { "title": "Status", "type": "string" } }, "required": [ "approval_id", "kind", "action_id", "action_version", "policy", "status", "decision", "expires_at", "proposal", "ok" ], "title": "ApprovalDecision", "type": "object" }, "ApprovalList": { "additionalProperties": true, "properties": { "approvals": { "items": { "$ref": "#/components/schemas/ApprovalResponse" }, "title": "Approvals", "type": "array" }, "run_id": { "title": "Run Id", "type": "string" } }, "required": [ "run_id", "approvals" ], "title": "ApprovalList", "type": "object" }, "ApprovalResponse": { "additionalProperties": true, "properties": { "action_id": { "title": "Action Id", "type": "string" }, "action_version": { "title": "Action Version", "type": "string" }, "approval_id": { "title": "Approval Id", "type": "string" }, "decision": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Decision" }, "expires_at": { "title": "Expires At", "type": "number" }, "kind": { "title": "Kind", "type": "string" }, "policy": { "title": "Policy", "type": "string" }, "proposal": { "additionalProperties": true, "title": "Proposal", "type": "object" }, "status": { "title": "Status", "type": "string" } }, "required": [ "approval_id", "kind", "action_id", "action_version", "policy", "status", "decision", "expires_at", "proposal" ], "title": "ApprovalResponse", "type": "object" }, "ArtifactReceipt": { "additionalProperties": false, "properties": { "artifact_id": { "title": "Artifact Id", "type": "string" }, "byte_size": { "minimum": 0.0, "title": "Byte Size", "type": "integer" }, "checksum_sha256": { "title": "Checksum Sha256", "type": "string" }, "download_url": { "title": "Download Url", "type": "string" }, "mime_type": { "title": "Mime Type", "type": "string" }, "status": { "const": "ready", "default": "ready", "title": "Status", "type": "string" }, "version": { "minimum": 1.0, "title": "Version", "type": "integer" } }, "required": [ "artifact_id", "version", "mime_type", "checksum_sha256", "byte_size", "download_url" ], "title": "ArtifactReceipt", "type": "object" }, "ArtifactRefineRequest": { "additionalProperties": false, "properties": { "expected_version": { "maximum": 128.0, "minimum": 1.0, "title": "Expected Version", "type": "integer" }, "instructions": { "maxLength": 4000, "minLength": 1, "title": "Instructions", "type": "string" } }, "required": [ "expected_version", "instructions" ], "title": "ArtifactRefineRequest", "type": "object" }, "ArtifactResponse": { "additionalProperties": true, "properties": { "body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Body" }, "byte_size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Byte Size" }, "checksum_sha256": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Checksum Sha256" }, "created_at": { "title": "Created At", "type": "number" }, "download_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Download Url" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "id": { "title": "Id", "type": "string" }, "metadata": { "additionalProperties": true, "title": "Metadata", "type": "object" }, "mime_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mime Type" }, "preview_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Preview Url" }, "status": { "title": "Status", "type": "string" }, "thread_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Thread Id" }, "title": { "title": "Title", "type": "string" }, "type": { "title": "Type", "type": "string" }, "updated_at": { "title": "Updated At", "type": "number" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "id", "type", "title", "status", "thread_id", "created_at", "updated_at", "version", "mime_type", "preview_url", "download_url", "error", "metadata" ], "title": "ArtifactResponse", "type": "object" }, "ArtifactType": { "enum": [ "document", "presentation", "spreadsheet", "chart", "image", "code_app", "pdf", "docx", "pptx", "dashboard" ], "title": "ArtifactType", "type": "string" }, "AuthConfig": { "description": "Authentication configuration for Pull/MCP endpoints.", "examples": [ { "credentials": "eyJhbGciOiJIUzI1NiIs...", "type": "bearer" }, { "credentials": "sk-xxx", "header_name": "X-API-Key", "type": "api_key" } ], "properties": { "credentials": { "description": "Token, API key, or credentials", "title": "Credentials", "type": "string" }, "header_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Custom header name (default: Authorization)", "title": "Header Name" }, "type": { "$ref": "#/components/schemas/app__models__context_schemas__AuthType", "default": "bearer", "description": "Authentication method" } }, "required": [ "credentials" ], "title": "AuthConfig", "type": "object" }, "AuthType-Output": { "description": "Supported MCP authentication types.", "enum": [ "none", "bearer", "basic", "api_key" ], "title": "AuthType", "type": "string" }, "Availability": { "additionalProperties": false, "properties": { "conditions": { "items": { "type": "string" }, "title": "Conditions", "type": "array" }, "readiness": { "const": "not_probed", "default": "not_probed", "title": "Readiness", "type": "string" }, "state": { "enum": [ "conditional", "unavailable", "public_metadata", "not_public" ], "title": "State", "type": "string" } }, "required": [ "state", "conditions" ], "title": "Availability", "type": "object" }, "BestOfNCommandBody": { "description": "Run the same task across multiple models in isolated worktrees.", "properties": { "judge_model": { "default": "default", "title": "Judge Model", "type": "string" }, "models": { "description": "Model list (defaults to BEST_OF_N_DEFAULT_MODELS).", "items": { "type": "string" }, "title": "Models", "type": "array" }, "n": { "default": 3, "maximum": 6.0, "minimum": 1.0, "title": "N", "type": "integer" }, "prompt": { "maxLength": 32000, "minLength": 1, "title": "Prompt", "type": "string" }, "space_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Space Id" }, "worktree_isolation": { "default": true, "title": "Worktree Isolation", "type": "boolean" } }, "required": [ "prompt" ], "title": "BestOfNCommandBody", "type": "object" }, "BestOfNWorkspaceMergeRequest": { "properties": { "branch": { "minLength": 1, "title": "Branch", "type": "string" }, "cleanup_branches": { "default": false, "title": "Cleanup Branches", "type": "boolean" }, "other_branches": { "items": { "type": "string" }, "title": "Other Branches", "type": "array" }, "workspace_id": { "minLength": 1, "title": "Workspace Id", "type": "string" } }, "required": [ "workspace_id", "branch" ], "title": "BestOfNWorkspaceMergeRequest", "type": "object" }, "BillingDiagnostics": { "additionalProperties": false, "properties": { "attempts": { "title": "Attempts", "type": "integer" }, "confirmed_usd": { "title": "Confirmed Usd", "type": "string" }, "held_usd": { "title": "Held Usd", "type": "string" }, "provisional_usd": { "title": "Provisional Usd", "type": "string" }, "unresolved": { "title": "Unresolved", "type": "integer" } }, "required": [ "attempts", "unresolved", "held_usd", "provisional_usd", "confirmed_usd" ], "title": "BillingDiagnostics", "type": "object" }, "BillingPeriod": { "additionalProperties": true, "properties": { "end": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End" }, "start": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Start" } }, "required": [ "start", "end" ], "title": "BillingPeriod", "type": "object" }, "BillingRate": { "additionalProperties": true, "properties": { "per_completion_token": { "title": "Per Completion Token", "type": "number" }, "per_prompt_token": { "title": "Per Prompt Token", "type": "number" }, "per_request": { "title": "Per Request", "type": "number" }, "per_search_result": { "title": "Per Search Result", "type": "number" } }, "required": [ "per_prompt_token", "per_completion_token", "per_request", "per_search_result" ], "title": "BillingRate", "type": "object" }, "BillingRates": { "additionalProperties": true, "properties": { "currency": { "title": "Currency", "type": "string" }, "rates": { "additionalProperties": { "$ref": "#/components/schemas/BillingRate" }, "title": "Rates", "type": "object" } }, "required": [ "currency", "rates" ], "title": "BillingRates", "type": "object" }, "BillingUsage": { "additionalProperties": true, "properties": { "group_by": { "title": "Group By", "type": "string" }, "rows": { "items": { "$ref": "#/components/schemas/UsageBucket" }, "title": "Rows", "type": "array" }, "since": { "title": "Since", "type": "string" }, "tenant_id": { "title": "Tenant Id", "type": "string" }, "totals": { "$ref": "#/components/schemas/UsageTotals" }, "until": { "title": "Until", "type": "string" } }, "required": [ "tenant_id", "since", "until", "group_by", "rows", "totals" ], "title": "BillingUsage", "type": "object" }, "BudgetPausePayload": { "properties": { "action_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action Version" }, "approved": { "title": "Approved", "type": "boolean" }, "reason": { "default": "", "title": "Reason", "type": "string" } }, "required": [ "approved" ], "title": "BudgetPausePayload", "type": "object" }, "CancelledResponse": { "additionalProperties": true, "properties": { "cancelled": { "title": "Cancelled", "type": "boolean" } }, "required": [ "cancelled" ], "title": "CancelledResponse", "type": "object" }, "CapabilityReadiness": { "additionalProperties": true, "properties": { "capability": { "title": "Capability", "type": "string" }, "checks": { "items": { "$ref": "#/components/schemas/ReadinessCheck" }, "title": "Checks", "type": "array" }, "ready": { "title": "Ready", "type": "boolean" } }, "required": [ "capability", "ready", "checks" ], "title": "CapabilityReadiness", "type": "object" }, "CapabilityView": { "additionalProperties": false, "properties": { "availability": { "$ref": "#/components/schemas/Availability" }, "contract": { "$ref": "#/components/schemas/ContractReference" }, "id": { "title": "Id", "type": "string" }, "limits": { "additionalProperties": true, "title": "Limits", "type": "object" }, "method": { "title": "Method", "type": "string" }, "path": { "title": "Path", "type": "string" }, "policy": { "$ref": "#/components/schemas/Policy" }, "sdk": { "additionalProperties": { "$ref": "#/components/schemas/SdkSupport" }, "title": "Sdk", "type": "object" } }, "required": [ "id", "method", "path", "policy", "availability", "contract", "limits", "sdk" ], "title": "CapabilityView", "type": "object" }, "ChangePlanRequest": { "properties": { "new_price_id": { "minLength": 1, "title": "New Price Id", "type": "string" } }, "required": [ "new_price_id" ], "title": "ChangePlanRequest", "type": "object" }, "ChannelConnectionCreate": { "properties": { "channel_type": { "description": "Channel type", "enum": [ "telegram", "whatsapp", "slack", "discord" ], "title": "Channel Type", "type": "string" }, "config": { "additionalProperties": true, "title": "Config", "type": "object" }, "credentials": { "additionalProperties": true, "description": "Channel-specific credentials", "title": "Credentials", "type": "object" }, "name": { "maxLength": 256, "minLength": 1, "title": "Name", "type": "string" }, "routing_rules": { "additionalProperties": true, "description": "Routing config: agent_id, mode (answer|agent), group_activation, allowlist", "title": "Routing Rules", "type": "object" } }, "required": [ "channel_type", "name", "credentials" ], "title": "ChannelConnectionCreate", "type": "object" }, "ChannelDelivery": { "additionalProperties": true, "properties": { "message_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message Id" }, "status": { "title": "Status", "type": "string" }, "success": { "title": "Success", "type": "boolean" } }, "required": [ "success", "message_id", "status" ], "title": "ChannelDelivery", "type": "object" }, "ChannelList": { "additionalProperties": true, "properties": { "connections": { "items": { "$ref": "#/components/schemas/ChannelResponse" }, "title": "Connections", "type": "array" } }, "required": [ "connections" ], "title": "ChannelList", "type": "object" }, "ChannelResponse": { "additionalProperties": true, "properties": { "channel_type": { "title": "Channel Type", "type": "string" }, "config": { "additionalProperties": true, "title": "Config", "type": "object" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "routing_rules": { "additionalProperties": true, "title": "Routing Rules", "type": "object" }, "status": { "title": "Status", "type": "string" }, "tenant_id": { "title": "Tenant Id", "type": "string" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "webhook_secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Webhook Secret" }, "webhook_secret_configured": { "title": "Webhook Secret Configured", "type": "boolean" } }, "required": [ "id", "tenant_id", "channel_type", "name", "status", "config", "routing_rules", "webhook_secret_configured", "created_at", "updated_at" ], "title": "ChannelResponse", "type": "object" }, "ChannelSendMessage": { "properties": { "format": { "default": "markdown", "description": "Message format: markdown, html, plain", "title": "Format", "type": "string" }, "recipient_id": { "description": "Channel-specific recipient ID", "title": "Recipient Id", "type": "string" }, "reply_to_message_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reply To Message Id" }, "text": { "maxLength": 32000, "minLength": 1, "title": "Text", "type": "string" }, "thread_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Thread Id" } }, "required": [ "recipient_id", "text" ], "title": "ChannelSendMessage", "type": "object" }, "ChannelTypeResponse": { "additionalProperties": true, "properties": { "name": { "title": "Name", "type": "string" }, "type": { "title": "Type", "type": "string" } }, "required": [ "type", "name" ], "title": "ChannelTypeResponse", "type": "object" }, "ChannelTypes": { "additionalProperties": true, "properties": { "channels": { "items": { "$ref": "#/components/schemas/ChannelTypeResponse" }, "title": "Channels", "type": "array" } }, "required": [ "channels" ], "title": "ChannelTypes", "type": "object" }, "ChatCompletionChoice": { "description": "A single completion choice.", "properties": { "finish_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Finish Reason" }, "index": { "title": "Index", "type": "integer" }, "message": { "$ref": "#/components/schemas/ChatMessage-Output" } }, "required": [ "index", "message" ], "title": "ChatCompletionChoice", "type": "object" }, "ChatCompletionRequest": { "description": "OpenAI-compatible chat completion request.", "properties": { "answer_mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Q Answer Engine mode: 'quick' | 'pro' | 'deep' | 'raw'. Any value other than 'raw' (or null) delegates execution to the unified Answer Engine (RAG + live web + inline citations). Default behaviour matches legacy /chat/completions (raw passthrough).", "title": "Answer Mode" }, "context_config": { "anyOf": [ { "$ref": "#/components/schemas/ContextConfig" }, { "type": "null" } ], "description": "Context configuration for Push/Pull/MCP context delivery. See Docs/Architecture/FEDERATED_CONTEXT_GATEWAY.md for details." }, "conversation_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Conversation ID for Pull context session continuity", "title": "Conversation Id" }, "frequency_penalty": { "anyOf": [ { "maximum": 2.0, "minimum": -2.0, "type": "number" }, { "type": "null" } ], "description": "Penalize tokens based on frequency in text so far (-2 to 2). Reduces repetition.", "title": "Frequency Penalty" }, "max_completion_tokens": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "Alias for max_tokens (used by newer OpenAI models)", "title": "Max Completion Tokens" }, "max_tokens": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "Maximum tokens to generate in the response. Each model has its own limit (e.g., GPT-4o: 16384, Gemini 1.5: 8192)", "title": "Max Tokens" }, "messages": { "description": "Conversation messages", "items": { "$ref": "#/components/schemas/app__api__completions__ChatMessage" }, "title": "Messages", "type": "array" }, "model": { "description": "Model ID (e.g., 'gpt-4o-mini', 'gemini/gemini-2.0-flash-exp')", "title": "Model", "type": "string" }, "n": { "anyOf": [ { "maximum": 10.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "default": 1, "description": "Number of completions to generate", "title": "N" }, "parallel_tool_calls": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Parallel Tool Calls" }, "presence_penalty": { "anyOf": [ { "maximum": 2.0, "minimum": -2.0, "type": "number" }, { "type": "null" } ], "description": "Penalize tokens based on presence in text so far (-2 to 2). Encourages new topics.", "title": "Presence Penalty" }, "response_format": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "Response format: {'type': 'json_object'} for JSON mode, or {'type': 'json_schema', 'json_schema': {...}}", "title": "Response Format" }, "seed": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Random seed for reproducible outputs (when supported by model)", "title": "Seed" }, "stop": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Stop sequences - generation stops when any of these are produced", "title": "Stop" }, "stream": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Stream response chunks (OpenAI-compatible SSE)", "title": "Stream" }, "stream_options": { "anyOf": [ { "$ref": "#/components/schemas/StreamOptions" }, { "type": "null" } ] }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Tags for cost attribution (e.g., ['project:x', 'team:y'])", "title": "Tags" }, "temperature": { "anyOf": [ { "maximum": 2.0, "minimum": 0.0, "type": "number" }, { "type": "null" } ], "description": "Sampling temperature (0-2). Lower = more focused, higher = more creative. Default varies by model.", "title": "Temperature" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tenant ID for trusted service-to-service callers. API-key callers cannot override their authenticated tenant.", "title": "Tenant Id" }, "tool_choice": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "Tool choice: 'auto', 'none', 'required', or specific tool", "title": "Tool Choice" }, "tools": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "Available tools/functions for the model to call", "title": "Tools" }, "top_k": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "Only sample from top K tokens. Used by Google/Anthropic models.", "title": "Top K" }, "top_p": { "anyOf": [ { "maximum": 1.0, "minimum": 0.0, "type": "number" }, { "type": "null" } ], "description": "Nucleus sampling: only consider tokens with cumulative probability <= top_p. Alternative to temperature.", "title": "Top P" }, "user": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "User ID for per-user usage tracking", "title": "User" } }, "required": [ "model", "messages" ], "title": "ChatCompletionRequest", "type": "object" }, "ChatCompletionResponse": { "properties": { "attribution_context": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Attribution Context" }, "choices": { "items": { "$ref": "#/components/schemas/ChatCompletionChoice" }, "title": "Choices", "type": "array" }, "context_metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "Metadata about context processing (sources used, tokens, errors)", "title": "Context Metadata" }, "created": { "title": "Created", "type": "integer" }, "estimated_cost": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Estimated cost in USD", "title": "Estimated Cost" }, "id": { "title": "Id", "type": "string" }, "model": { "title": "Model", "type": "string" }, "object": { "default": "chat.completion", "title": "Object", "type": "string" }, "usage": { "anyOf": [ { "$ref": "#/components/schemas/UsageInfo" }, { "type": "null" } ] }, "usage_record_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usage Record Id" } }, "required": [ "id", "created", "model", "choices" ], "title": "ChatCompletionResponse", "type": "object" }, "ChatMessage-Output": { "description": "A single message in the conversation.", "properties": { "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Message content (text or null for tool calls)", "title": "Content" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional name for the message author", "title": "Name" }, "role": { "description": "Role: system, developer, user, assistant or tool", "title": "Role", "type": "string" }, "tool_call_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ID of the tool call this message responds to", "title": "Tool Call Id" }, "tool_calls": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "Tool calls made by the assistant", "title": "Tool Calls" } }, "required": [ "role" ], "title": "ChatMessage", "type": "object" }, "ChatModel": { "additionalProperties": true, "properties": { "id": { "title": "Id", "type": "string" }, "input_cost_per_1k": { "title": "Input Cost Per 1K", "type": "number" }, "is_free": { "title": "Is Free", "type": "boolean" }, "max_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Tokens" }, "output_cost_per_1k": { "title": "Output Cost Per 1K", "type": "number" }, "provider": { "title": "Provider", "type": "string" }, "supports_function_calling": { "title": "Supports Function Calling", "type": "boolean" }, "supports_vision": { "title": "Supports Vision", "type": "boolean" } }, "required": [ "id", "provider", "is_free", "input_cost_per_1k", "output_cost_per_1k", "max_tokens", "supports_vision", "supports_function_calling" ], "title": "ChatModel", "type": "object" }, "CheckpointBranchPayload": { "properties": { "mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mode" }, "prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prompt" } }, "title": "CheckpointBranchPayload", "type": "object" }, "CheckpointCreatePayload": { "properties": { "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" } }, "title": "CheckpointCreatePayload", "type": "object" }, "CheckpointCreated": { "additionalProperties": true, "properties": { "checkpoint_id": { "title": "Checkpoint Id", "type": "string" }, "ok": { "title": "Ok", "type": "boolean" } }, "required": [ "ok", "checkpoint_id" ], "title": "CheckpointCreated", "type": "object" }, "CheckpointSummary": { "additionalProperties": true, "properties": { "checkpoint_type": { "title": "Checkpoint Type", "type": "string" }, "created_at": { "title": "Created At", "type": "string" }, "has_partial_synthesis": { "title": "Has Partial Synthesis", "type": "boolean" }, "id": { "title": "Id", "type": "string" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" }, "step_index": { "title": "Step Index", "type": "integer" }, "tool_results_count": { "title": "Tool Results Count", "type": "integer" } }, "required": [ "id", "checkpoint_type", "label", "step_index", "created_at", "tool_results_count", "has_partial_synthesis" ], "title": "CheckpointSummary", "type": "object" }, "CircuitState": { "description": "Circuit breaker state.", "enum": [ "closed", "open", "half_open" ], "title": "CircuitState", "type": "string" }, "Citation": { "additionalProperties": true, "properties": { "claim_text": { "title": "Claim Text", "type": "string" }, "confidence": { "title": "Confidence", "type": "number" }, "position_end": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Position End" }, "position_start": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Position Start" }, "source_indexes": { "items": { "type": "integer" }, "title": "Source Indexes", "type": "array" } }, "required": [ "claim_text", "source_indexes", "confidence", "position_start", "position_end" ], "title": "Citation", "type": "object" }, "ClarifyAnswerItem": { "properties": { "id": { "maxLength": 128, "minLength": 1, "title": "Id", "type": "string" }, "value": { "description": "string or list[string]", "title": "Value" } }, "required": [ "id", "value" ], "title": "ClarifyAnswerItem", "type": "object" }, "ClarifyRequestPayload": { "description": "Body for ``POST /api/v1/answer/clarify``.\n\nThe deep-research engine emits ``clarify_request`` events carrying a\n``run_id`` and ``clarify_id``; the client echoes both back along with\nthe user's answers so the server can load the checkpoint and resume\nthe same run. The server opens a fresh SSE stream on this endpoint\nand the frontend continues reading it as if it were still consuming\nthe original answer stream.", "properties": { "answers": { "items": { "$ref": "#/components/schemas/ClarifyAnswerItem" }, "title": "Answers", "type": "array" }, "clarify_id": { "maxLength": 256, "minLength": 1, "title": "Clarify Id", "type": "string" }, "conversation_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Conversation Id" }, "run_id": { "maxLength": 256, "minLength": 1, "title": "Run Id", "type": "string" } }, "required": [ "run_id", "clarify_id" ], "title": "ClarifyRequestPayload", "type": "object" }, "ConnectorBatch": { "additionalProperties": false, "properties": { "batch_id": { "format": "uuid", "title": "Batch Id", "type": "string" }, "changes": { "items": { "$ref": "#/components/schemas/ConnectorChange" }, "maxItems": 32, "title": "Changes", "type": "array" }, "checkpoint": { "anyOf": [ { "maxLength": 2048, "type": "string" }, { "type": "null" } ], "title": "Checkpoint" }, "expected_revision": { "minimum": 1.0, "title": "Expected Revision", "type": "integer" }, "next_checkpoint": { "maxLength": 2048, "minLength": 1, "title": "Next Checkpoint", "type": "string" } }, "required": [ "batch_id", "expected_revision", "next_checkpoint" ], "title": "ConnectorBatch", "type": "object" }, "ConnectorChange": { "additionalProperties": false, "properties": { "access": { "$ref": "#/components/schemas/SourcePermission" }, "deleted": { "default": false, "title": "Deleted", "type": "boolean" }, "remote_id": { "maxLength": 512, "minLength": 1, "title": "Remote Id", "type": "string" }, "source_revision": { "maximum": 9007199254740991.0, "minimum": 1.0, "title": "Source Revision", "type": "integer" }, "text": { "anyOf": [ { "maxLength": 32000, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Text" }, "title": { "default": "Document", "maxLength": 256, "minLength": 1, "title": "Title", "type": "string" } }, "required": [ "remote_id", "source_revision" ], "title": "ConnectorChange", "type": "object" }, "ConnectorCreate": { "properties": { "config_json": { "additionalProperties": true, "title": "Config Json", "type": "object" }, "connector_type": { "$ref": "#/components/schemas/ConnectorType" }, "name": { "maxLength": 256, "minLength": 1, "title": "Name", "type": "string" }, "sync_frequency_minutes": { "anyOf": [ { "maximum": 10080.0, "minimum": 5.0, "type": "integer" }, { "type": "null" } ], "title": "Sync Frequency Minutes" } }, "required": [ "connector_type", "name" ], "title": "ConnectorCreate", "type": "object" }, "ConnectorOut": { "properties": { "config_json": { "additionalProperties": true, "title": "Config Json", "type": "object" }, "connector_type": { "title": "Connector Type", "type": "string" }, "created_at": { "title": "Created At", "type": "string" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "last_sync_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Sync At" }, "name": { "title": "Name", "type": "string" }, "status": { "title": "Status", "type": "string" }, "sync_frequency_minutes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sync Frequency Minutes" }, "tenant_id": { "title": "Tenant Id", "type": "string" }, "updated_at": { "title": "Updated At", "type": "string" } }, "required": [ "id", "tenant_id", "connector_type", "name", "status", "config_json", "created_at", "updated_at" ], "title": "ConnectorOut", "type": "object" }, "ConnectorPackage": { "additionalProperties": false, "properties": { "max_batch_documents": { "default": 16, "maximum": 32.0, "minimum": 1.0, "title": "Max Batch Documents", "type": "integer" }, "min_sync_interval_seconds": { "default": 5, "maximum": 86400.0, "minimum": 1.0, "title": "Min Sync Interval Seconds", "type": "integer" }, "space_id": { "maxLength": 128, "minLength": 1, "title": "Space Id", "type": "string" }, "transport": { "const": "developer_push", "default": "developer_push", "title": "Transport", "type": "string" } }, "required": [ "space_id" ], "title": "ConnectorPackage", "type": "object" }, "ConnectorSyncResponse": { "additionalProperties": true, "properties": { "result": { "additionalProperties": true, "title": "Result", "type": "object" }, "status": { "title": "Status", "type": "string" }, "sync_id": { "title": "Sync Id", "type": "string" } }, "required": [ "sync_id", "status", "result" ], "title": "ConnectorSyncResponse", "type": "object" }, "ConnectorType": { "enum": [ "sharepoint", "notion", "confluence", "slack", "dropbox", "google_drive", "onedrive", "box", "custom" ], "title": "ConnectorType", "type": "string" }, "ContextBlock": { "additionalProperties": false, "properties": { "document_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Document Id" }, "id": { "title": "Id", "type": "string" }, "kind": { "enum": [ "evidence", "memory" ], "title": "Kind", "type": "string" }, "source": { "anyOf": [ { "enum": [ "local", "tenant_endpoint" ], "type": "string" }, { "type": "null" } ], "title": "Source" }, "text": { "title": "Text", "type": "string" } }, "required": [ "id", "kind", "text" ], "title": "ContextBlock", "type": "object" }, "ContextConfig": { "description": "Complete context configuration for a chat request.\n\nSupports all context delivery modes:\n- Push: Context included directly in the request\n- Pull: Q fetches context from third-party endpoint\n- MCP: Q connects to third-party MCP servers\n- Federated RAG: Q queries multiple third-party RAG endpoints (Phase 5)\n- Streaming: Third parties stream context incrementally (Phase 6)\n\nModes can be combined for comprehensive context gathering.", "examples": [ { "federated_rag": { "endpoints": [ { "auth": { "credentials": "token", "type": "bearer" }, "endpoint": "https://blackink.io/rag", "name": "knowledge-base" } ], "fusion_method": "rrf", "max_results": 5 }, "pull": { "auth": { "credentials": "token", "type": "bearer" }, "endpoint": "https://blackink.io/q-context", "scopes": [ "documents", "tasks" ] }, "push_context": { "sections": [ { "content": "...", "id": "current-doc", "priority": "critical", "title": "Current Document", "type": "document" } ] }, "streaming": { "endpoints": [ { "auth": { "credentials": "token", "type": "bearer" }, "endpoint": "https://blackink.io/context/stream", "mode": "sse", "name": "documents" } ], "parallel_streams": true } } ], "properties": { "federated_rag": { "anyOf": [ { "$ref": "#/components/schemas/FederatedRAGConfig" }, { "type": "null" } ], "description": "Federated RAG configuration for multi-source semantic search" }, "max_context_tokens": { "anyOf": [ { "maximum": 500000.0, "minimum": 1000.0, "type": "integer" }, { "type": "null" } ], "description": "Override default max context tokens", "title": "Max Context Tokens" }, "mcp_servers": { "anyOf": [ { "items": { "$ref": "#/components/schemas/McpServerConfig" }, "type": "array" }, { "type": "null" } ], "description": "MCP servers for tool-based context access", "title": "Mcp Servers" }, "priority_order": { "default": [ "push", "pull", "mcp", "federated_rag", "streaming" ], "description": "Order of context source priority", "items": { "type": "string" }, "title": "Priority Order", "type": "array" }, "pull": { "anyOf": [ { "$ref": "#/components/schemas/PullConfig" }, { "type": "null" } ], "description": "Pull configuration for on-demand context" }, "push_context": { "anyOf": [ { "$ref": "#/components/schemas/PushContext" }, { "type": "null" } ], "description": "Context pushed with the request" }, "streaming": { "anyOf": [ { "$ref": "#/components/schemas/StreamingConfig" }, { "type": "null" } ], "description": "Streaming configuration for incremental context delivery" } }, "title": "ContextConfig", "type": "object" }, "ContextPriority": { "description": "Priority levels for context sections.", "enum": [ "critical", "high", "medium", "low" ], "title": "ContextPriority", "type": "string" }, "ContextSection": { "description": "A single section of context.\n\nUsed in Push mode to provide structured context with the request.", "examples": [ { "content": "# ISO27001 Access Control Policy\n\n...", "id": "current-doc", "metadata": { "document_id": "doc-123", "version": "1.0" }, "priority": "critical", "title": "Current Document", "type": "document" } ], "properties": { "content": { "description": "The actual context content", "title": "Content", "type": "string" }, "id": { "description": "Unique identifier for this section", "title": "Id", "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "description": "Additional metadata about this section", "title": "Metadata" }, "priority": { "$ref": "#/components/schemas/ContextPriority", "default": "medium", "description": "Priority for token budgeting" }, "title": { "default": "", "description": "Human-readable title", "title": "Title", "type": "string" }, "token_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Pre-computed token count (if known)", "title": "Token Count" }, "type": { "$ref": "#/components/schemas/ContextType", "default": "custom", "description": "Type of context" } }, "required": [ "id", "content" ], "title": "ContextSection", "type": "object" }, "ContextType": { "description": "Types of context that can be provided.", "enum": [ "document", "task", "calendar", "profile", "conversation_summary", "user_preference", "custom" ], "title": "ContextType", "type": "string" }, "ContractReference": { "additionalProperties": false, "properties": { "media_types": { "items": { "type": "string" }, "title": "Media Types", "type": "array" }, "output_status": { "enum": [ "declared", "incomplete", "not_published" ], "title": "Output Status", "type": "string" }, "pointer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pointer" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" } }, "required": [ "url", "pointer", "output_status", "media_types" ], "title": "ContractReference", "type": "object" }, "CostSummary": { "description": "Cost summary with breakdown.", "properties": { "by_model": { "items": { "$ref": "#/components/schemas/UsageByModel" }, "title": "By Model", "type": "array" }, "by_tag": { "items": { "$ref": "#/components/schemas/UsageByTag" }, "title": "By Tag", "type": "array" }, "period_end": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Period End" }, "period_start": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Period Start" }, "total_cost": { "title": "Total Cost", "type": "number" }, "total_input_tokens": { "title": "Total Input Tokens", "type": "integer" }, "total_output_tokens": { "title": "Total Output Tokens", "type": "integer" } }, "required": [ "total_cost", "total_input_tokens", "total_output_tokens", "by_model", "by_tag" ], "title": "CostSummary", "type": "object" }, "CreateAgentBody": { "properties": { "agent_type": { "$ref": "#/components/schemas/AgentType" }, "config": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Config" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "name": { "maxLength": 256, "minLength": 1, "title": "Name", "type": "string" } }, "required": [ "name", "agent_type" ], "title": "CreateAgentBody", "type": "object" }, "CredentialRequirement": { "additionalProperties": false, "properties": { "description": { "maxLength": 500, "minLength": 1, "title": "Description", "type": "string" }, "location": { "const": "developer_host", "default": "developer_host", "title": "Location", "type": "string" }, "name": { "pattern": "^[A-Z][A-Z0-9_]{0,63}$", "title": "Name", "type": "string" } }, "required": [ "name", "description" ], "title": "CredentialRequirement", "type": "object" }, "CreditsResponse": { "additionalProperties": true, "properties": { "credits": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "additionalProperties": true, "type": "object" } ], "title": "Credits" }, "tenant_id": { "title": "Tenant Id", "type": "string" } }, "required": [ "tenant_id", "credits" ], "title": "CreditsResponse", "type": "object" }, "CursorPage_ArtifactResponse_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ArtifactResponse" }, "title": "Data", "type": "array" }, "has_more": { "title": "Has More", "type": "boolean" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "previous_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous Cursor" } }, "required": [ "data", "has_more" ], "title": "CursorPage[ArtifactResponse]", "type": "object" }, "CursorPage_RequestLogSummary_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/RequestLogSummary" }, "title": "Data", "type": "array" }, "has_more": { "title": "Has More", "type": "boolean" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "previous_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous Cursor" } }, "required": [ "data", "has_more" ], "title": "CursorPage[RequestLogSummary]", "type": "object" }, "CursorPage_SkillSummaryOut_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/SkillSummaryOut" }, "title": "Data", "type": "array" }, "has_more": { "title": "Has More", "type": "boolean" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "previous_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous Cursor" } }, "required": [ "data", "has_more" ], "title": "CursorPage[SkillSummaryOut]", "type": "object" }, "CursorPage_SpaceResponse_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/SpaceResponse" }, "title": "Data", "type": "array" }, "has_more": { "title": "Has More", "type": "boolean" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "previous_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous Cursor" } }, "required": [ "data", "has_more" ], "title": "CursorPage[SpaceResponse]", "type": "object" }, "CustomMode": { "additionalProperties": true, "properties": { "auto_approve_tools": { "title": "Auto Approve Tools", "type": "boolean" }, "description": { "title": "Description", "type": "string" }, "icon": { "title": "Icon", "type": "string" }, "name": { "title": "Name", "type": "string" }, "read_only": { "title": "Read Only", "type": "boolean" }, "system_prompt_addendum": { "title": "System Prompt Addendum", "type": "string" }, "tool_allowlist": { "items": { "type": "string" }, "title": "Tool Allowlist", "type": "array" } }, "required": [ "name", "description", "tool_allowlist", "system_prompt_addendum", "auto_approve_tools", "read_only", "icon" ], "title": "CustomMode", "type": "object" }, "CustomModes": { "additionalProperties": true, "properties": { "modes": { "items": { "$ref": "#/components/schemas/CustomMode" }, "title": "Modes", "type": "array" } }, "required": [ "modes" ], "title": "CustomModes", "type": "object" }, "DevtoolsTrace": { "additionalProperties": true, "properties": { "agent_steps": { "items": { "additionalProperties": true, "type": "object" }, "title": "Agent Steps", "type": "array" }, "model_calls": { "items": { "additionalProperties": true, "type": "object" }, "title": "Model Calls", "type": "array" }, "plan": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Plan" }, "rag_sources": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "additionalProperties": true, "type": "object" } ], "title": "Rag Sources" }, "request_id": { "title": "Request Id", "type": "string" }, "request_log": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Request Log" }, "retrieval_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Retrieval Meta" }, "search_trace": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Search Trace" } }, "required": [ "request_id", "request_log", "agent_steps", "rag_sources", "model_calls", "search_trace", "retrieval_meta", "plan" ], "title": "DevtoolsTrace", "type": "object" }, "DevtoolsUsage": { "additionalProperties": true, "properties": { "billing_period": { "$ref": "#/components/schemas/BillingPeriod" }, "by_surface": { "additionalProperties": true, "title": "By Surface", "type": "object" }, "generated_at": { "title": "Generated At", "type": "string" }, "tenant_id": { "title": "Tenant Id", "type": "string" }, "total_cost_usd": { "title": "Total Cost Usd", "type": "number" }, "total_tokens": { "title": "Total Tokens", "type": "integer" } }, "required": [ "tenant_id", "billing_period", "total_tokens", "total_cost_usd", "by_surface", "generated_at" ], "title": "DevtoolsUsage", "type": "object" }, "Discovery": { "additionalProperties": false, "properties": { "capabilities": { "items": { "$ref": "#/components/schemas/CapabilityView" }, "title": "Capabilities", "type": "array" }, "jobs": { "additionalProperties": { "$ref": "#/components/schemas/JobDefinition" }, "title": "Jobs", "type": "object" }, "openapi_url": { "default": "/v1/openapi.public.json", "title": "Openapi Url", "type": "string" }, "scope_semantics": { "additionalProperties": { "type": "string" }, "title": "Scope Semantics", "type": "object" }, "version": { "title": "Version", "type": "string" } }, "required": [ "version", "capabilities", "jobs" ], "title": "Discovery", "type": "object" }, "DocumentIngestionStatus": { "properties": { "accepted_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Accepted At" }, "document_id": { "format": "uuid", "title": "Document Id", "type": "string" }, "document_version": { "title": "Document Version", "type": "integer" }, "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Code" }, "fresh": { "title": "Fresh", "type": "boolean" }, "indexed_document_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Indexed Document Version" }, "indexed_revision": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Indexed Revision" }, "last_indexed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Last Indexed At" }, "publication_lag_ms": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "type": "null" } ], "title": "Publication Lag Ms" }, "quality": { "$ref": "#/components/schemas/IngestionQuality" }, "revision": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Revision" }, "state": { "enum": [ "unknown", "queued", "processing", "ready", "failed", "deleted" ], "title": "State", "type": "string" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "required": [ "document_id", "document_version", "state", "quality", "fresh" ], "title": "DocumentIngestionStatus", "type": "object" }, "EmbeddingItem": { "properties": { "embedding": { "items": { "type": "number" }, "title": "Embedding", "type": "array" }, "index": { "title": "Index", "type": "integer" }, "object": { "default": "embedding", "title": "Object", "type": "string" } }, "required": [ "embedding", "index" ], "title": "EmbeddingItem", "type": "object" }, "EmbeddingsUsage": { "properties": { "prompt_tokens": { "default": 0, "title": "Prompt Tokens", "type": "integer" }, "total_tokens": { "default": 0, "title": "Total Tokens", "type": "integer" } }, "title": "EmbeddingsUsage", "type": "object" }, "EntitlementsResponse": { "properties": { "entitlements": { "additionalProperties": { "type": "boolean" }, "title": "Entitlements", "type": "object" }, "tenant_id": { "title": "Tenant Id", "type": "string" }, "vellon_enabled": { "title": "Vellon Enabled", "type": "boolean" } }, "required": [ "tenant_id", "vellon_enabled", "entitlements" ], "title": "EntitlementsResponse", "type": "object" }, "ErrorBody": { "properties": { "code": { "title": "Code", "type": "string" }, "correlation_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Correlation Id" }, "doc_url": { "title": "Doc Url", "type": "string" }, "issues": { "items": { "$ref": "#/components/schemas/ValidationIssue" }, "title": "Issues", "type": "array" }, "message": { "title": "Message", "type": "string" }, "operation_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Operation Id" }, "outcome": { "enum": [ "rejected", "unknown" ], "title": "Outcome", "type": "string" }, "receipt": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Receipt" }, "request_log_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Request Log Url" }, "retryable": { "title": "Retryable", "type": "boolean" }, "status": { "maximum": 599, "minimum": 400, "title": "Status", "type": "integer" } }, "required": [ "code", "message", "status", "correlation_id", "doc_url", "retryable", "outcome" ], "title": "ErrorBody", "type": "object" }, "EventPage": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/ExtensionEvent" }, "title": "Items", "type": "array" }, "next_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next After" } }, "required": [ "items" ], "title": "EventPage", "type": "object" }, "EvidencePolicy": { "additionalProperties": false, "properties": { "allowed_tools": { "anyOf": [ { "items": { "enum": [ "vector_search", "keyword_search", "retrieval_endpoint", "federated_rag", "web_search", "fetch_url", "mcp_search" ], "type": "string" }, "maxItems": 7, "type": "array" }, { "type": "null" } ], "default": null, "title": "Allowed Tools" }, "mode": { "default": "auto", "enum": [ "auto", "strict", "general_knowledge" ], "title": "Mode", "type": "string" }, "required_tools": { "items": { "enum": [ "vector_search", "keyword_search", "retrieval_endpoint", "federated_rag", "web_search", "fetch_url", "mcp_search" ], "type": "string" }, "maxItems": 7, "title": "Required Tools", "type": "array" } }, "title": "EvidencePolicy", "type": "object" }, "EvidenceReport": { "properties": { "answer_status": { "default": "unverified", "enum": [ "evidence_backed", "general_knowledge", "partial", "abstained", "unverified" ], "title": "Answer Status", "type": "string" }, "mandatory_satisfied": { "default": false, "title": "Mandatory Satisfied", "type": "boolean" }, "outcomes": { "items": { "$ref": "#/components/schemas/RetrievalOutcome" }, "maxItems": 128, "title": "Outcomes", "type": "array" }, "policy": { "$ref": "#/components/schemas/EvidencePolicy" }, "source_count": { "default": 0, "minimum": 0, "title": "Source Count", "type": "integer" }, "status": { "default": "unknown", "enum": [ "available", "absent", "partial", "unavailable", "not_requested", "unknown" ], "title": "Status", "type": "string" } }, "title": "EvidenceReport", "type": "object" }, "ExecutionCancellation": { "additionalProperties": true, "properties": { "id": { "title": "Id", "type": "string" }, "status": { "enum": [ "pending", "running", "completed", "failed", "cancelled" ], "title": "Status", "type": "string" } }, "required": [ "id", "status" ], "title": "ExecutionCancellation", "type": "object" }, "ExecutionEventPayload": { "additionalProperties": true, "properties": { "error": { "anyOf": [ { "$ref": "#/components/schemas/JobError" }, { "type": "null" } ], "default": null }, "execution_id": { "title": "Execution Id", "type": "string" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Message" }, "progress_percent": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Progress Percent" }, "result": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Result" }, "seq": { "title": "Seq", "type": "integer" }, "stage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Stage" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" } }, "required": [ "seq", "execution_id" ], "title": "ExecutionEventPayload", "type": "object" }, "ExtensionEvent": { "additionalProperties": false, "properties": { "action": { "title": "Action", "type": "string" }, "actor_id": { "title": "Actor Id", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "revision": { "title": "Revision", "type": "integer" }, "sequence": { "title": "Sequence", "type": "integer" } }, "required": [ "sequence", "action", "revision", "actor_id", "created_at" ], "title": "ExtensionEvent", "type": "object" }, "ExtensionManifest": { "additionalProperties": false, "properties": { "connector": { "anyOf": [ { "$ref": "#/components/schemas/ConnectorPackage" }, { "type": "null" } ] }, "credentials": { "items": { "$ref": "#/components/schemas/CredentialRequirement" }, "maxItems": 8, "title": "Credentials", "type": "array" }, "description": { "maxLength": 2048, "minLength": 1, "title": "Description", "type": "string" }, "kind": { "enum": [ "tool", "skill", "connector" ], "title": "Kind", "type": "string" }, "manifest_version": { "const": "1", "default": "1", "title": "Manifest Version", "type": "string" }, "name": { "maxLength": 128, "minLength": 1, "title": "Name", "type": "string" }, "skill": { "anyOf": [ { "$ref": "#/components/schemas/SkillPackage" }, { "type": "null" } ] }, "slug": { "pattern": "^[a-z][a-z0-9-]{0,47}$", "title": "Slug", "type": "string" }, "tool": { "anyOf": [ { "$ref": "#/components/schemas/ToolPackage" }, { "type": "null" } ] }, "version": { "pattern": "^(0|[1-9][0-9]{0,5})\\.(0|[1-9][0-9]{0,5})\\.(0|[1-9][0-9]{0,5})$", "title": "Version", "type": "string" } }, "required": [ "kind", "slug", "name", "description", "version" ], "title": "ExtensionManifest", "type": "object" }, "ExtensionOut": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "digest": { "title": "Digest", "type": "string" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "manifest": { "$ref": "#/components/schemas/ExtensionManifest" }, "owner_id": { "title": "Owner Id", "type": "string" }, "resource_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Resource Id" }, "revision": { "title": "Revision", "type": "integer" }, "state": { "enum": [ "active", "revoked", "removed" ], "title": "State", "type": "string" }, "tool_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tool Name" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "owner_id", "revision", "state", "manifest", "digest", "created_at", "updated_at" ], "title": "ExtensionOut", "type": "object" }, "ExtensionPage": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/ExtensionOut" }, "title": "Items", "type": "array" }, "next_after": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Next After" } }, "required": [ "items" ], "title": "ExtensionPage", "type": "object" }, "ExtensionRegister": { "additionalProperties": false, "properties": { "expected_revision": { "default": 0, "minimum": 0.0, "title": "Expected Revision", "type": "integer" }, "manifest": { "$ref": "#/components/schemas/ExtensionManifest" } }, "required": [ "manifest" ], "title": "ExtensionRegister", "type": "object" }, "ExternalToolDefinition": { "additionalProperties": false, "properties": { "approval_required": { "default": false, "title": "Approval Required", "type": "boolean" }, "description": { "maxLength": 2048, "minLength": 1, "title": "Description", "type": "string" }, "effect": { "enum": [ "read", "write", "execute" ], "title": "Effect", "type": "string" }, "input_schema": { "additionalProperties": true, "title": "Input Schema", "type": "object" }, "name": { "pattern": "^external_[a-z][a-z0-9_]{0,62}$", "title": "Name", "type": "string" }, "output_schema": { "additionalProperties": true, "title": "Output Schema", "type": "object" }, "registration": { "anyOf": [ { "$ref": "#/components/schemas/ToolReference" }, { "type": "null" } ] } }, "required": [ "name", "description", "effect", "input_schema", "output_schema" ], "title": "ExternalToolDefinition", "type": "object" }, "ExternalToolResult": { "additionalProperties": false, "properties": { "input_digest": { "pattern": "^[0-9a-f]{64}$", "title": "Input Digest", "type": "string" }, "output": { "title": "Output" } }, "required": [ "input_digest", "output" ], "title": "ExternalToolResult", "type": "object" }, "FederatedRAGConfig": { "description": "Configuration for federated RAG across multiple third-party endpoints.\n\nPhase 5 of the Federated Context Gateway. Enables Q to query\nmultiple third-party RAG endpoints in parallel and unify the\nresults with cross-source ranking.", "examples": [ { "endpoints": [ { "auth": { "credentials": "token1", "type": "bearer" }, "endpoint": "https://blackink.io/rag", "name": "blackink", "weight": 1.5 }, { "auth": { "credentials": "key1", "type": "api_key" }, "endpoint": "https://routeroyal.com/rag", "name": "routeroyal", "weight": 1.0 } ], "fusion_method": "rrf", "max_results": 10 } ], "properties": { "endpoints": { "description": "List of RAG endpoints to query", "items": { "$ref": "#/components/schemas/FederatedRAGEndpointConfig" }, "title": "Endpoints", "type": "array" }, "fusion_method": { "default": "rrf", "description": "Ranking fusion method: 'rrf' (Reciprocal Rank Fusion), 'score_normalize', or 'source_priority'", "title": "Fusion Method", "type": "string" }, "max_results": { "default": 10, "description": "Maximum total results after fusion", "maximum": 100.0, "minimum": 1.0, "title": "Max Results", "type": "integer" }, "parallel_requests": { "default": true, "description": "Query endpoints in parallel (faster) or sequentially", "title": "Parallel Requests", "type": "boolean" }, "rrf_k": { "default": 60, "description": "RRF parameter k (higher = reduce impact of high ranks)", "maximum": 1000.0, "minimum": 1.0, "title": "Rrf K", "type": "integer" }, "timeout_ms": { "default": 10000, "description": "Overall timeout for all RAG queries", "maximum": 60000.0, "minimum": 1000.0, "title": "Timeout Ms", "type": "integer" } }, "title": "FederatedRAGConfig", "type": "object" }, "FederatedRAGEndpointConfig": { "description": "Configuration for a single federated RAG endpoint.\n\nThird parties host their own embeddings and provide a RAG endpoint\nthat Q can query for semantic search results.", "examples": [ { "auth": { "credentials": "token", "type": "bearer" }, "endpoint": "https://blackink.io/rag", "max_results": 10, "name": "blackink-docs", "scopes": [ "policies", "procedures" ], "weight": 1.5 } ], "properties": { "auth": { "$ref": "#/components/schemas/AuthConfig", "description": "Authentication configuration" }, "document_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Filter to specific document types", "title": "Document Types" }, "endpoint": { "description": "URL of the RAG endpoint (e.g., https://blackink.io/rag)", "title": "Endpoint", "type": "string" }, "extra_headers": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "description": "Additional HTTP headers to include", "title": "Extra Headers" }, "max_results": { "default": 10, "description": "Maximum results to request from this source", "maximum": 50.0, "minimum": 1.0, "title": "Max Results", "type": "integer" }, "name": { "description": "Human-readable name for this RAG source", "title": "Name", "type": "string" }, "scopes": { "description": "Optional scope filters for the RAG query", "items": { "type": "string" }, "title": "Scopes", "type": "array" }, "timeout_ms": { "default": 5000, "description": "Request timeout in milliseconds", "maximum": 30000.0, "minimum": 100.0, "title": "Timeout Ms", "type": "integer" }, "weight": { "default": 1.0, "description": "Weight for ranking (higher = more important)", "maximum": 10.0, "minimum": 0.1, "title": "Weight", "type": "number" } }, "required": [ "name", "endpoint", "auth" ], "title": "FederatedRAGEndpointConfig", "type": "object" }, "FileContent": { "properties": { "content": { "title": "Content", "type": "string" }, "path": { "title": "Path", "type": "string" }, "workspace_id": { "title": "Workspace Id", "type": "string" } }, "required": [ "workspace_id", "path", "content" ], "title": "FileContent", "type": "object" }, "FileList": { "properties": { "files": { "items": { "type": "string" }, "title": "Files", "type": "array" } }, "required": [ "files" ], "title": "FileList", "type": "object" }, "FileWritten": { "properties": { "path": { "title": "Path", "type": "string" }, "workspace_id": { "title": "Workspace Id", "type": "string" }, "written": { "title": "Written", "type": "boolean" } }, "required": [ "workspace_id", "path", "written" ], "title": "FileWritten", "type": "object" }, "GenerateArtifactPayload": { "properties": { "data": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Data" }, "inputs": { "additionalProperties": true, "title": "Inputs", "type": "object" }, "instructions": { "default": "", "title": "Instructions", "type": "string" }, "source_answer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Answer" }, "source_markdown": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Markdown" }, "sources": { "items": { "additionalProperties": true, "type": "object" }, "title": "Sources", "type": "array" }, "stream": { "default": false, "title": "Stream", "type": "boolean" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" }, "thread_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Thread Id" }, "title": { "default": "", "title": "Title", "type": "string" }, "type": { "$ref": "#/components/schemas/ArtifactType", "description": "Artifact kind to generate." }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id" } }, "required": [ "type" ], "title": "GenerateArtifactPayload", "type": "object" }, "GrantOut": { "additionalProperties": false, "properties": { "permissions": { "items": { "enum": [ "use", "sync" ], "type": "string" }, "title": "Permissions", "type": "array" }, "principal_id": { "title": "Principal Id", "type": "string" } }, "required": [ "principal_id", "permissions" ], "title": "GrantOut", "type": "object" }, "GrantPage": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/GrantOut" }, "title": "Items", "type": "array" } }, "required": [ "items" ], "title": "GrantPage", "type": "object" }, "GrantRequest": { "additionalProperties": false, "properties": { "expected_revision": { "minimum": 1.0, "title": "Expected Revision", "type": "integer" }, "permissions": { "items": { "enum": [ "use", "sync" ], "type": "string" }, "maxItems": 2, "title": "Permissions", "type": "array" }, "principal_id": { "maxLength": 256, "minLength": 1, "title": "Principal Id", "type": "string" } }, "required": [ "principal_id", "expected_revision" ], "title": "GrantRequest", "type": "object" }, "HealthStatus": { "description": "MCP server health status.", "enum": [ "healthy", "degraded", "unhealthy", "unknown" ], "title": "HealthStatus", "type": "string" }, "HookCreate": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "event_type": { "$ref": "#/components/schemas/HookEventType" }, "fail_open": { "default": true, "title": "Fail Open", "type": "boolean" }, "filter_config": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Filter Config" }, "handler_config": { "additionalProperties": true, "title": "Handler Config", "type": "object" }, "handler_type": { "$ref": "#/components/schemas/HookHandlerType" }, "is_active": { "default": true, "title": "Is Active", "type": "boolean" }, "name": { "maxLength": 256, "minLength": 1, "title": "Name", "type": "string" }, "priority": { "default": 0, "title": "Priority", "type": "integer" }, "timeout_ms": { "default": 5000, "maximum": 120000.0, "minimum": 100.0, "title": "Timeout Ms", "type": "integer" } }, "required": [ "name", "event_type", "handler_type" ], "title": "HookCreate", "type": "object" }, "HookEventType": { "enum": [ "before_answer", "after_answer", "before_tool_use", "after_tool_use", "on_error", "before_search", "after_search", "on_artifact_create", "on_stream_start", "on_stream_end" ], "title": "HookEventType", "type": "string" }, "HookExecution": { "additionalProperties": true, "properties": { "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "ok": { "title": "Ok", "type": "boolean" }, "result": { "title": "Result" } }, "required": [ "ok" ], "title": "HookExecution", "type": "object" }, "HookExecutions": { "additionalProperties": true, "properties": { "modifications": { "additionalProperties": true, "title": "Modifications", "type": "object" }, "results": { "items": { "$ref": "#/components/schemas/HookExecution" }, "title": "Results", "type": "array" } }, "required": [ "results", "modifications" ], "title": "HookExecutions", "type": "object" }, "HookHandlerType": { "enum": [ "webhook", "internal", "mcp_tool" ], "title": "HookHandlerType", "type": "string" }, "HookList": { "additionalProperties": true, "properties": { "hooks": { "items": { "$ref": "#/components/schemas/HookResponse" }, "title": "Hooks", "type": "array" } }, "required": [ "hooks" ], "title": "HookList", "type": "object" }, "HookResponse": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "event_type": { "title": "Event Type", "type": "string" }, "fail_open": { "title": "Fail Open", "type": "boolean" }, "filter_config": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Filter Config" }, "handler_config": { "additionalProperties": true, "title": "Handler Config", "type": "object" }, "handler_type": { "title": "Handler Type", "type": "string" }, "id": { "title": "Id", "type": "string" }, "is_active": { "title": "Is Active", "type": "boolean" }, "name": { "title": "Name", "type": "string" }, "priority": { "title": "Priority", "type": "integer" }, "tenant_id": { "title": "Tenant Id", "type": "string" }, "timeout_ms": { "title": "Timeout Ms", "type": "integer" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "required": [ "id", "tenant_id", "name", "description", "event_type", "handler_type", "handler_config", "is_active", "priority", "filter_config", "timeout_ms", "fail_open", "created_at", "updated_at" ], "title": "HookResponse", "type": "object" }, "HookTestBody": { "properties": { "context": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Context" }, "event_type": { "anyOf": [ { "$ref": "#/components/schemas/HookEventType" }, { "type": "null" } ] }, "hook_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Hook Id" }, "payload": { "additionalProperties": true, "title": "Payload", "type": "object" } }, "title": "HookTestBody", "type": "object" }, "HookUpdate": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "event_type": { "anyOf": [ { "$ref": "#/components/schemas/HookEventType" }, { "type": "null" } ] }, "fail_open": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Fail Open" }, "filter_config": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Filter Config" }, "handler_config": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Handler Config" }, "handler_type": { "anyOf": [ { "$ref": "#/components/schemas/HookHandlerType" }, { "type": "null" } ] }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "priority": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Priority" }, "timeout_ms": { "anyOf": [ { "maximum": 120000.0, "minimum": 100.0, "type": "integer" }, { "type": "null" } ], "title": "Timeout Ms" } }, "title": "HookUpdate", "type": "object" }, "HubSkillPage": { "additionalProperties": true, "properties": { "categories": { "items": { "type": "string" }, "title": "Categories", "type": "array" }, "limit": { "title": "Limit", "type": "integer" }, "offset": { "title": "Offset", "type": "integer" }, "skills": { "items": { "$ref": "#/components/schemas/HubSkillResponse" }, "title": "Skills", "type": "array" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "skills", "total", "offset", "limit", "categories" ], "title": "HubSkillPage", "type": "object" }, "HubSkillResponse": { "additionalProperties": true, "properties": { "author_name": { "title": "Author Name", "type": "string" }, "avg_rating": { "title": "Avg Rating", "type": "number" }, "category": { "title": "Category", "type": "string" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "description": { "title": "Description", "type": "string" }, "featured": { "title": "Featured", "type": "boolean" }, "icon_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Icon Url" }, "id": { "title": "Id", "type": "string" }, "install_count": { "title": "Install Count", "type": "integer" }, "installed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Installed At" }, "installed_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Installed Version" }, "license": { "title": "License", "type": "string" }, "name": { "title": "Name", "type": "string" }, "rating_count": { "title": "Rating Count", "type": "integer" }, "repository_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Repository Url" }, "slug": { "title": "Slug", "type": "string" }, "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "verified": { "title": "Verified", "type": "boolean" }, "version": { "title": "Version", "type": "string" } }, "required": [ "id", "slug", "name", "description", "version", "category", "tags", "author_name", "icon_url", "repository_url", "license", "install_count", "avg_rating", "rating_count", "verified", "featured", "created_at", "updated_at" ], "title": "HubSkillResponse", "type": "object" }, "HubSkillsInstalled": { "additionalProperties": true, "properties": { "skills": { "items": { "$ref": "#/components/schemas/HubSkillResponse" }, "title": "Skills", "type": "array" } }, "required": [ "skills" ], "title": "HubSkillsInstalled", "type": "object" }, "Incident": { "additionalProperties": true, "properties": { "description": { "default": "", "title": "Description", "type": "string" }, "title": { "title": "Title", "type": "string" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "required": [ "title" ], "title": "Incident", "type": "object" }, "IncidentList": { "additionalProperties": true, "properties": { "count": { "title": "Count", "type": "integer" }, "incidents": { "items": { "$ref": "#/components/schemas/Incident" }, "title": "Incidents", "type": "array" } }, "required": [ "incidents", "count" ], "title": "IncidentList", "type": "object" }, "IngestionQuality": { "properties": { "characters": { "anyOf": [ { "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Characters" }, "chunks": { "anyOf": [ { "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Chunks" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Format" }, "ocr_pages": { "anyOf": [ { "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Ocr Pages" }, "parser_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parser Version" }, "structure": { "additionalProperties": { "type": "integer" }, "title": "Structure", "type": "object" } }, "title": "IngestionQuality", "type": "object" }, "InvocationPage": { "properties": { "items": { "items": { "$ref": "#/components/schemas/PendingInvocation" }, "title": "Items", "type": "array" }, "next_after": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Next After" } }, "required": [ "items" ], "title": "InvocationPage", "type": "object" }, "InvocationReceipt": { "properties": { "effect": { "enum": [ "read", "write", "execute" ], "title": "Effect", "type": "string" }, "execution": { "enum": [ "local", "external" ], "title": "Execution", "type": "string" }, "input_digest": { "title": "Input Digest", "type": "string" }, "invocation_id": { "format": "uuid", "title": "Invocation Id", "type": "string" }, "run_id": { "format": "uuid", "title": "Run Id", "type": "string" }, "state": { "enum": [ "started", "awaiting_result", "completed" ], "title": "State", "type": "string" }, "tool": { "title": "Tool", "type": "string" } }, "required": [ "invocation_id", "run_id", "tool", "effect", "execution", "state", "input_digest" ], "title": "InvocationReceipt", "type": "object" }, "JobDefinition": { "additionalProperties": false, "properties": { "description": { "title": "Description", "type": "string" }, "execution_model": { "title": "Execution Model", "type": "string" }, "implementation_route": { "title": "Implementation Route", "type": "string" }, "implementation_route_public": { "title": "Implementation Route Public", "type": "boolean" }, "job_endpoint": { "title": "Job Endpoint", "type": "string" }, "planner_agents": { "items": { "type": "string" }, "title": "Planner Agents", "type": "array" }, "readiness_url": { "title": "Readiness Url", "type": "string" }, "requires_rerank": { "title": "Requires Rerank", "type": "boolean" }, "result_format": { "enum": [ "markdown", "json" ], "title": "Result Format", "type": "string" } }, "required": [ "description", "planner_agents", "requires_rerank", "job_endpoint", "readiness_url", "implementation_route", "implementation_route_public", "execution_model", "result_format" ], "title": "JobDefinition", "type": "object" }, "JobError": { "additionalProperties": true, "properties": { "code": { "title": "Code", "type": "string" }, "details": { "additionalProperties": true, "title": "Details", "type": "object" }, "message": { "title": "Message", "type": "string" }, "recoverable": { "default": false, "title": "Recoverable", "type": "boolean" }, "retryable": { "default": false, "title": "Retryable", "type": "boolean" } }, "required": [ "code", "message" ], "title": "JobError", "type": "object" }, "JsonRpcError": { "additionalProperties": true, "properties": { "code": { "title": "Code", "type": "integer" }, "data": { "title": "Data" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message" ], "title": "JsonRpcError", "type": "object" }, "JsonRpcFailure": { "additionalProperties": true, "properties": { "error": { "$ref": "#/components/schemas/JsonRpcError" }, "id": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "jsonrpc": { "const": "2.0", "title": "Jsonrpc", "type": "string" } }, "required": [ "jsonrpc", "id", "error" ], "title": "JsonRpcFailure", "type": "object" }, "JsonRpcSuccess": { "additionalProperties": true, "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "jsonrpc": { "const": "2.0", "title": "Jsonrpc", "type": "string" }, "result": { "title": "Result" } }, "required": [ "jsonrpc", "id", "result" ], "title": "JsonRpcSuccess", "type": "object" }, "KnowledgeContextRequest": { "additionalProperties": false, "properties": { "include_memory": { "default": false, "title": "Include Memory", "type": "boolean" }, "max_characters": { "default": 16000, "maximum": 64000.0, "minimum": 100.0, "title": "Max Characters", "type": "integer" }, "retrieval": { "$ref": "#/components/schemas/KnowledgeRetrieveRequest" } }, "required": [ "retrieval" ], "title": "KnowledgeContextRequest", "type": "object" }, "KnowledgeContextResponse": { "additionalProperties": false, "properties": { "blocks": { "items": { "$ref": "#/components/schemas/ContextBlock" }, "title": "Blocks", "type": "array" }, "characters": { "minimum": 0.0, "title": "Characters", "type": "integer" }, "evidence": { "$ref": "#/components/schemas/EvidenceReport" }, "truncated": { "title": "Truncated", "type": "boolean" } }, "required": [ "blocks", "evidence", "characters", "truncated" ], "title": "KnowledgeContextResponse", "type": "object" }, "KnowledgeDocumentRequest": { "additionalProperties": false, "properties": { "format": { "default": "document", "enum": [ "document", "docx" ], "title": "Format", "type": "string" }, "instructions": { "default": "", "maxLength": 4000, "title": "Instructions", "type": "string" }, "retrieval": { "anyOf": [ { "$ref": "#/components/schemas/KnowledgeRetrieveRequest" }, { "type": "null" } ] }, "text": { "anyOf": [ { "maxLength": 64000, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Text" }, "title": { "default": "Document", "maxLength": 200, "minLength": 1, "title": "Title", "type": "string" } }, "title": "KnowledgeDocumentRequest", "type": "object" }, "KnowledgeExtractRequest": { "additionalProperties": false, "properties": { "instructions": { "default": "Extract only facts present in the supplied evidence.", "maxLength": 4000, "title": "Instructions", "type": "string" }, "output_schema": { "$ref": "#/components/schemas/OutputSchema" }, "retrieval": { "anyOf": [ { "$ref": "#/components/schemas/KnowledgeRetrieveRequest" }, { "type": "null" } ] }, "text": { "anyOf": [ { "maxLength": 64000, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Text" } }, "required": [ "output_schema" ], "title": "KnowledgeExtractRequest", "type": "object" }, "KnowledgeExtractResponse": { "additionalProperties": false, "properties": { "evidence": { "anyOf": [ { "$ref": "#/components/schemas/EvidenceReport" }, { "type": "null" } ] }, "input_kind": { "enum": [ "supplied_text", "retrieval" ], "title": "Input Kind", "type": "string" }, "source_ids": { "items": { "type": "string" }, "title": "Source Ids", "type": "array" }, "structured_output": { "$ref": "#/components/schemas/StructuredOutput" } }, "required": [ "structured_output", "input_kind" ], "title": "KnowledgeExtractResponse", "type": "object" }, "KnowledgeHit": { "additionalProperties": false, "properties": { "chunk_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Chunk Id" }, "document_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Document Id" }, "id": { "title": "Id", "type": "string" }, "rank": { "minimum": 1.0, "title": "Rank", "type": "integer" }, "score": { "title": "Score", "type": "number" }, "source": { "enum": [ "local", "tenant_endpoint" ], "title": "Source", "type": "string" }, "text": { "title": "Text", "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" } }, "required": [ "id", "source", "text", "score", "rank" ], "title": "KnowledgeHit", "type": "object" }, "KnowledgeRetrieveRequest": { "additionalProperties": false, "properties": { "filters": { "$ref": "#/components/schemas/RetrievalFilters" }, "limit": { "default": 10, "maximum": 50.0, "minimum": 1.0, "title": "Limit", "type": "integer" }, "match_threshold": { "default": 0.5, "maximum": 1.0, "minimum": 0.0, "title": "Match Threshold", "type": "number" }, "mode": { "default": "hybrid", "enum": [ "keyword", "vector", "hybrid" ], "title": "Mode", "type": "string" }, "query": { "maxLength": 2000, "minLength": 1, "title": "Query", "type": "string" }, "sources": { "default": [ "local" ], "items": { "enum": [ "local", "tenant_endpoint" ], "type": "string" }, "maxItems": 2, "minItems": 1, "title": "Sources", "type": "array" } }, "required": [ "query" ], "title": "KnowledgeRetrieveRequest", "type": "object" }, "KnowledgeRetrieveResponse": { "additionalProperties": false, "properties": { "evidence": { "$ref": "#/components/schemas/EvidenceReport" }, "hits": { "items": { "$ref": "#/components/schemas/KnowledgeHit" }, "title": "Hits", "type": "array" }, "ranking": { "const": "reciprocal_rank_fusion", "default": "reciprocal_rank_fusion", "title": "Ranking", "type": "string" }, "truncated": { "default": false, "title": "Truncated", "type": "boolean" } }, "required": [ "hits", "evidence" ], "title": "KnowledgeRetrieveResponse", "type": "object" }, "KnowledgeSource": { "additionalProperties": false, "properties": { "configured": { "title": "Configured", "type": "boolean" }, "id": { "enum": [ "local", "tenant_endpoint" ], "title": "Id", "type": "string" }, "modes": { "items": { "enum": [ "keyword", "vector", "hybrid", "remote" ], "type": "string" }, "title": "Modes", "type": "array" } }, "required": [ "id", "configured", "modes" ], "title": "KnowledgeSource", "type": "object" }, "KnowledgeSources": { "additionalProperties": false, "properties": { "sources": { "items": { "$ref": "#/components/schemas/KnowledgeSource" }, "title": "Sources", "type": "array" } }, "required": [ "sources" ], "title": "KnowledgeSources", "type": "object" }, "LifecycleRequest": { "additionalProperties": false, "properties": { "expected_revision": { "minimum": 1.0, "title": "Expected Revision", "type": "integer" }, "state": { "enum": [ "active", "revoked", "removed" ], "title": "State", "type": "string" } }, "required": [ "expected_revision", "state" ], "title": "LifecycleRequest", "type": "object" }, "McpAgentJobResponse": { "description": "Full response for an MCP agent job.", "properties": { "completed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Completed At" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "current_step": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Current Step" }, "error_details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Error Details" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message" }, "estimated_cost": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Estimated Cost" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "input_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Input Tokens" }, "iterations": { "title": "Iterations", "type": "integer" }, "model": { "title": "Model", "type": "string" }, "output_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Output Tokens" }, "processing_time_seconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Processing Time Seconds" }, "progress_percent": { "title": "Progress Percent", "type": "integer" }, "result": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Result" }, "started_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Started At" }, "status": { "$ref": "#/components/schemas/McpJobStatus" }, "tenant_id": { "title": "Tenant Id", "type": "string" }, "tools_used": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tools Used" }, "total_tool_calls": { "title": "Total Tool Calls", "type": "integer" } }, "required": [ "id", "tenant_id", "status", "current_step", "progress_percent", "model", "result", "error_message", "error_details", "iterations", "total_tool_calls", "input_tokens", "output_tokens", "estimated_cost", "processing_time_seconds", "tools_used", "started_at", "completed_at", "created_at" ], "title": "McpAgentJobResponse", "type": "object" }, "McpCancellation": { "additionalProperties": true, "properties": { "message": { "title": "Message", "type": "string" }, "status": { "title": "Status", "type": "string" } }, "required": [ "message", "status" ], "title": "McpCancellation", "type": "object" }, "McpChatCompletionJobResponse": { "description": "Response when MCP chat completion is started as a job.", "properties": { "job_id": { "format": "uuid", "title": "Job Id", "type": "string" }, "message": { "title": "Message", "type": "string" }, "status": { "$ref": "#/components/schemas/McpJobStatus" } }, "required": [ "job_id", "status", "message" ], "title": "McpChatCompletionJobResponse", "type": "object" }, "McpChatCompletionRequest": { "additionalProperties": false, "description": "Request schema for MCP-powered chat completion.", "properties": { "additional_tools": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "Additional non-MCP tools to include", "title": "Additional Tools" }, "include_mcp_tools": { "default": true, "description": "Whether to include tenant's MCP tools", "title": "Include Mcp Tools", "type": "boolean" }, "max_iterations": { "anyOf": [ { "maximum": 50.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "Maximum agentic loop iterations", "title": "Max Iterations" }, "max_tokens": { "anyOf": [ { "maximum": 100000.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Max Tokens" }, "mcp_server_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Filter to specific MCP servers by name", "title": "Mcp Server Names" }, "mcp_tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Filter MCP servers by tags", "title": "Mcp Tags" }, "messages": { "items": { "$ref": "#/components/schemas/app__models__mcp_schemas__ChatMessage" }, "minItems": 1, "title": "Messages", "type": "array" }, "model": { "description": "LLM model to use", "title": "Model", "type": "string" }, "stream": { "default": false, "title": "Stream", "type": "boolean" }, "temperature": { "anyOf": [ { "maximum": 2.0, "minimum": 0.0, "type": "number" }, { "type": "null" } ], "title": "Temperature" } }, "required": [ "messages", "model" ], "title": "McpChatCompletionRequest", "type": "object" }, "McpJobStatus": { "description": "MCP agent job status.", "enum": [ "PENDING", "RUNNING", "COMPLETED", "FAILED", "CANCELLED" ], "title": "McpJobStatus", "type": "string" }, "McpRefreshCapabilitiesResponse": { "description": "Response from refreshing MCP server capabilities.", "properties": { "capabilities_hash": { "title": "Capabilities Hash", "type": "string" }, "refreshed_at": { "format": "date-time", "title": "Refreshed At", "type": "string" }, "resources_count": { "title": "Resources Count", "type": "integer" }, "server_id": { "format": "uuid", "title": "Server Id", "type": "string" }, "server_name": { "title": "Server Name", "type": "string" }, "tools_count": { "title": "Tools Count", "type": "integer" } }, "required": [ "server_id", "server_name", "tools_count", "resources_count", "capabilities_hash", "refreshed_at" ], "title": "McpRefreshCapabilitiesResponse", "type": "object" }, "McpResourceContentResponse": { "description": "Response schema for reading a resource.", "properties": { "cached": { "default": false, "title": "Cached", "type": "boolean" }, "content": { "title": "Content", "type": "string" }, "mime_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mime Type" }, "uri": { "title": "Uri", "type": "string" } }, "required": [ "uri", "content" ], "title": "McpResourceContentResponse", "type": "object" }, "McpResourceListResponse": { "description": "Response schema for listing MCP resources.", "properties": { "resources": { "items": { "$ref": "#/components/schemas/McpResourceResponse" }, "title": "Resources", "type": "array" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "resources", "total" ], "title": "McpResourceListResponse", "type": "object" }, "McpResourceResponse": { "description": "Response schema for an MCP resource.", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "mime_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mime Type" }, "name": { "title": "Name", "type": "string" }, "server_id": { "format": "uuid", "title": "Server Id", "type": "string" }, "server_name": { "title": "Server Name", "type": "string" }, "uri": { "title": "Uri", "type": "string" } }, "required": [ "uri", "name", "server_id", "server_name" ], "title": "McpResourceResponse", "type": "object" }, "McpServerAuthConfig": { "additionalProperties": false, "description": "Authentication configuration for MCP servers.", "properties": { "api_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" }, "header_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "X-API-Key", "description": "Header name for API key", "title": "Header Name" }, "password": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Password" }, "token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Token" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Username" } }, "title": "McpServerAuthConfig", "type": "object" }, "McpServerConfig": { "description": "Configuration for third-party MCP servers.\n\nQ connects to MCP servers for rich tool-based context access.\nBest for agentic workflows and dynamic data operations.", "examples": [ { "auth": { "credentials": "token", "type": "bearer" }, "enabled_tools": [ "search_documents", "get_related_tasks" ], "name": "Black Ink Documents", "uri": "https://blackink.io/mcp" } ], "properties": { "auth": { "$ref": "#/components/schemas/AuthConfig", "description": "Authentication configuration" }, "enabled_resources": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Whitelist of resource patterns (None = all)", "title": "Enabled Resources" }, "enabled_tools": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Whitelist of tools to use (None = all)", "title": "Enabled Tools" }, "name": { "description": "Human-readable server name", "title": "Name", "type": "string" }, "timeout_ms": { "default": 10000, "description": "Tool call timeout in milliseconds", "maximum": 60000.0, "minimum": 100.0, "title": "Timeout Ms", "type": "integer" }, "uri": { "description": "MCP server URI (e.g., https://blackink.io/mcp)", "title": "Uri", "type": "string" } }, "required": [ "uri", "name", "auth" ], "title": "McpServerConfig", "type": "object" }, "McpServerCreate": { "additionalProperties": false, "description": "Request schema for creating an MCP server.", "properties": { "auth_config": { "anyOf": [ { "$ref": "#/components/schemas/McpServerAuthConfig" }, { "type": "null" } ] }, "auth_type": { "$ref": "#/components/schemas/app__models__mcp_schemas__AuthType", "default": "none" }, "base_url": { "description": "SSE endpoint URL (e.g., https://agent.example.com/sse)", "title": "Base Url", "type": "string" }, "description": { "anyOf": [ { "maxLength": 2000, "type": "string" }, { "type": "null" } ], "title": "Description" }, "is_global": { "default": false, "description": "If True, server is available to ALL tenants (platform-wide). Global servers don't require tenant_id.", "title": "Is Global", "type": "boolean" }, "name": { "description": "Unique server name", "maxLength": 255, "minLength": 1, "title": "Name", "type": "string" }, "preferred_search_tool": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "description": "Exact tool name the mcp_search heuristic should prefer when selecting a search tool on this server.", "title": "Preferred Search Tool" }, "tags": { "items": { "type": "string" }, "maxItems": 20, "title": "Tags", "type": "array" } }, "required": [ "name", "base_url" ], "title": "McpServerCreate", "type": "object" }, "McpServerResponse": { "description": "Response schema for an MCP server.", "properties": { "auth_type": { "$ref": "#/components/schemas/AuthType-Output" }, "base_url": { "title": "Base Url", "type": "string" }, "capabilities": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Capabilities" }, "capabilities_hash": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Capabilities Hash" }, "capabilities_refreshed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Capabilities Refreshed At" }, "circuit_opened_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Circuit Opened At" }, "circuit_state": { "$ref": "#/components/schemas/CircuitState" }, "consecutive_failures": { "title": "Consecutive Failures", "type": "integer" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "health_status": { "$ref": "#/components/schemas/HealthStatus" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "is_active": { "title": "Is Active", "type": "boolean" }, "is_global": { "default": false, "title": "Is Global", "type": "boolean" }, "last_health_check_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Last Health Check At" }, "name": { "title": "Name", "type": "string" }, "preferred_search_tool": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Preferred Search Tool" }, "resources_count": { "default": 0, "title": "Resources Count", "type": "integer" }, "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" }, "tools_count": { "default": 0, "title": "Tools Count", "type": "integer" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "tenant_id", "name", "description", "base_url", "auth_type", "capabilities", "capabilities_hash", "capabilities_refreshed_at", "is_active", "health_status", "last_health_check_at", "consecutive_failures", "circuit_state", "circuit_opened_at", "tags", "created_at", "updated_at" ], "title": "McpServerResponse", "type": "object" }, "McpServerUpdate": { "additionalProperties": false, "description": "Request schema for updating an MCP server.", "properties": { "auth_config": { "anyOf": [ { "$ref": "#/components/schemas/McpServerAuthConfig" }, { "type": "null" } ] }, "auth_type": { "anyOf": [ { "$ref": "#/components/schemas/app__models__mcp_schemas__AuthType" }, { "type": "null" } ] }, "base_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Base Url" }, "description": { "anyOf": [ { "maxLength": 2000, "type": "string" }, { "type": "null" } ], "title": "Description" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active" }, "name": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Name" }, "preferred_search_tool": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "description": "Exact tool name the mcp_search heuristic should prefer.", "title": "Preferred Search Tool" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" } }, "title": "McpServerUpdate", "type": "object" }, "McpToolListResponse": { "description": "Response schema for listing MCP tools.", "properties": { "tools": { "items": { "$ref": "#/components/schemas/McpToolResponse" }, "title": "Tools", "type": "array" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "tools", "total" ], "title": "McpToolListResponse", "type": "object" }, "McpToolResponse": { "description": "Response schema for an MCP tool.", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "input_schema": { "additionalProperties": true, "title": "Input Schema", "type": "object" }, "name": { "title": "Name", "type": "string" }, "namespaced_name": { "title": "Namespaced Name", "type": "string" }, "server_id": { "format": "uuid", "title": "Server Id", "type": "string" }, "server_is_global": { "default": false, "title": "Server Is Global", "type": "boolean" }, "server_name": { "title": "Server Name", "type": "string" } }, "required": [ "name", "description", "input_schema", "server_id", "server_name", "namespaced_name" ], "title": "McpToolResponse", "type": "object" }, "MemoryListResponse": { "properties": { "categories": { "items": { "type": "string" }, "title": "Categories", "type": "array" }, "memories": { "items": { "$ref": "#/components/schemas/MemoryModel" }, "title": "Memories", "type": "array" } }, "required": [ "memories", "categories" ], "title": "MemoryListResponse", "type": "object" }, "MemoryModel": { "properties": { "category": { "title": "Category", "type": "string" }, "confidence": { "default": 1.0, "title": "Confidence", "type": "number" }, "content": { "title": "Content", "type": "string" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "id": { "title": "Id", "type": "string" }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Used At" }, "metadata": { "additionalProperties": true, "title": "Metadata", "type": "object" }, "pinned": { "default": false, "title": "Pinned", "type": "boolean" }, "source_turn_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Turn Id" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "user_id": { "title": "User Id", "type": "string" } }, "required": [ "id", "user_id", "content", "category" ], "title": "MemoryModel", "type": "object" }, "MemoryUpdate": { "properties": { "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" }, "content": { "anyOf": [ { "maxLength": 500, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Content" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" }, "pinned": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Pinned" } }, "title": "MemoryUpdate", "type": "object" }, "ModelInfo": { "description": "Information about an available model.", "properties": { "enabled": { "default": true, "description": "Whether the model is enabled for use", "title": "Enabled", "type": "boolean" }, "id": { "description": "Model identifier (e.g., 'gpt-4o-mini', 'gemini/gemini-2.0-flash')", "title": "Id", "type": "string" }, "input_cost_per_1k": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Cost per 1K input tokens in USD", "title": "Input Cost Per 1K" }, "is_free": { "default": false, "description": "Whether the model is free to use (both input and output costs are $0)", "title": "Is Free", "type": "boolean" }, "max_input_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum input/prompt tokens", "title": "Max Input Tokens" }, "max_output_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum output/completion tokens", "title": "Max Output Tokens" }, "max_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum total tokens (input + output)", "title": "Max Tokens" }, "name": { "description": "Human-readable model name", "title": "Name", "type": "string" }, "output_cost_per_1k": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Cost per 1K output tokens in USD", "title": "Output Cost Per 1K" }, "provider": { "description": "Provider name (e.g., 'openai', 'anthropic', 'gemini')", "title": "Provider", "type": "string" }, "supports_function_calling": { "default": false, "description": "Whether the model supports function/tool calling", "title": "Supports Function Calling", "type": "boolean" }, "supports_streaming": { "default": true, "description": "Whether the model supports streaming responses", "title": "Supports Streaming", "type": "boolean" }, "supports_vision": { "default": false, "description": "Whether the model supports image inputs", "title": "Supports Vision", "type": "boolean" } }, "required": [ "id", "name", "provider" ], "title": "ModelInfo", "type": "object" }, "ModelPreferences": { "additionalProperties": true, "properties": { "chat_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Chat Model" }, "deep_research_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deep Research Model" }, "max_output_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Output Tokens" }, "reasoning_effort": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reasoning Effort" }, "temperature": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Temperature" } }, "required": [ "chat_model", "deep_research_model", "reasoning_effort", "temperature", "max_output_tokens" ], "title": "ModelPreferences", "type": "object" }, "ModelPrefsPayload": { "properties": { "chat_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Chat Model" }, "deep_research_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deep Research Model" }, "max_output_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Output Tokens" }, "reasoning_effort": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reasoning Effort" }, "temperature": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Temperature" } }, "title": "ModelPrefsPayload", "type": "object" }, "ModelRouting": { "additionalProperties": true, "properties": { "fallbacks": { "items": { "type": "string" }, "title": "Fallbacks", "type": "array" }, "governance": { "additionalProperties": true, "title": "Governance", "type": "object" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" }, "purpose": { "title": "Purpose", "type": "string" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" } }, "required": [ "purpose", "model", "fallbacks", "tenant_id", "governance" ], "title": "ModelRouting", "type": "object" }, "MultitaskBody": { "description": "Trigger parallel subagent decomposition for a task.", "properties": { "prompt": { "maxLength": 32000, "minLength": 1, "title": "Prompt", "type": "string" }, "space_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Space Id" }, "tasks": { "description": "Optional explicit task specs: task_description, task_id, depends_on, subagent_type. When empty the prompt is run as a single parallelisable task.", "items": { "additionalProperties": true, "type": "object" }, "title": "Tasks", "type": "array" } }, "required": [ "prompt" ], "title": "MultitaskBody", "type": "object" }, "NewsItem": { "additionalProperties": true, "description": "A market-relevant news headline supplied by the caller for summarisation.", "properties": { "headline": { "title": "Headline", "type": "string" }, "published_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Published At" }, "snippet": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Snippet" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" } }, "required": [ "headline" ], "title": "NewsItem", "type": "object" }, "NewsSummary": { "additionalProperties": true, "description": "A concise, decision-oriented summary of a supplied news item or theme.", "properties": { "affected_instruments": { "items": { "type": "string" }, "title": "Affected Instruments", "type": "array" }, "impact": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "bullish|bearish|neutral", "title": "Impact" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "summary": { "title": "Summary", "type": "string" } }, "required": [ "summary" ], "title": "NewsSummary", "type": "object" }, "Objective": { "additionalProperties": false, "properties": { "bad": { "title": "Bad", "type": "integer" }, "budget_remaining_events": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Budget Remaining Events" }, "eligible": { "title": "Eligible", "type": "integer" }, "good": { "title": "Good", "type": "integer" }, "name": { "title": "Name", "type": "string" }, "observed_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Observed Ratio" }, "status": { "const": "candidate", "default": "candidate", "title": "Status", "type": "string" }, "target": { "title": "Target", "type": "number" } }, "required": [ "name", "target", "eligible", "good", "bad", "observed_ratio", "budget_remaining_events" ], "title": "Objective", "type": "object" }, "OkResponse": { "additionalProperties": true, "properties": { "ok": { "title": "Ok", "type": "boolean" } }, "required": [ "ok" ], "title": "OkResponse", "type": "object" }, "OpenAPIDocument": { "additionalProperties": true, "properties": { "components": { "additionalProperties": true, "title": "Components", "type": "object" }, "info": { "additionalProperties": true, "title": "Info", "type": "object" }, "openapi": { "title": "Openapi", "type": "string" }, "paths": { "additionalProperties": true, "title": "Paths", "type": "object" }, "servers": { "items": { "additionalProperties": true, "type": "object" }, "title": "Servers", "type": "array" }, "tags": { "items": { "additionalProperties": true, "type": "object" }, "title": "Tags", "type": "array" } }, "required": [ "openapi", "info", "paths", "components", "servers", "tags" ], "title": "OpenAPIDocument", "type": "object" }, "OutcomeCounts": { "additionalProperties": true, "properties": { "acceptance_rate": { "title": "Acceptance Rate", "type": "number" }, "accepted": { "title": "Accepted", "type": "integer" }, "corrected": { "title": "Corrected", "type": "integer" }, "correction_rate": { "title": "Correction Rate", "type": "number" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "total", "accepted", "corrected", "correction_rate", "acceptance_rate" ], "title": "OutcomeCounts", "type": "object" }, "OutcomeStats": { "additionalProperties": true, "properties": { "acceptance_rate": { "title": "Acceptance Rate", "type": "number" }, "accepted": { "title": "Accepted", "type": "integer" }, "by_model": { "additionalProperties": { "$ref": "#/components/schemas/OutcomeCounts" }, "title": "By Model", "type": "object" }, "corrected": { "title": "Corrected", "type": "integer" }, "correction_rate": { "title": "Correction Rate", "type": "number" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "total", "accepted", "corrected", "correction_rate", "acceptance_rate", "by_model" ], "title": "OutcomeStats", "type": "object" }, "OutputSchema": { "additionalProperties": false, "properties": { "json_schema": { "additionalProperties": true, "title": "Json Schema", "type": "object" }, "strict": { "default": true, "title": "Strict", "type": "boolean" } }, "required": [ "json_schema" ], "title": "OutputSchema", "type": "object" }, "PageList": { "additionalProperties": true, "properties": { "items": { "items": { "$ref": "#/components/schemas/PageResponse" }, "title": "Items", "type": "array" } }, "required": [ "items" ], "title": "PageList", "type": "object" }, "PageResponse": { "additionalProperties": true, "properties": { "answer_markdown": { "title": "Answer Markdown", "type": "string" }, "artifacts": { "items": { "additionalProperties": true, "type": "object" }, "title": "Artifacts", "type": "array" }, "citations": { "items": { "additionalProperties": true, "type": "object" }, "title": "Citations", "type": "array" }, "created_at": { "title": "Created At", "type": "string" }, "id": { "title": "Id", "type": "string" }, "owner_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner Id" }, "slug": { "title": "Slug", "type": "string" }, "source_page_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Page Id" }, "sources": { "items": { "additionalProperties": true, "type": "object" }, "title": "Sources", "type": "array" }, "summary": { "title": "Summary", "type": "string" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" }, "thread_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Thread Id" }, "title": { "title": "Title", "type": "string" }, "updated_at": { "title": "Updated At", "type": "string" }, "version": { "title": "Version", "type": "integer" }, "view_count": { "title": "View Count", "type": "integer" }, "visibility": { "title": "Visibility", "type": "string" } }, "required": [ "id", "slug", "title", "summary", "answer_markdown", "sources", "citations", "artifacts", "tenant_id", "owner_id", "thread_id", "source_page_id", "version", "visibility", "view_count", "created_at", "updated_at" ], "title": "PageResponse", "type": "object" }, "PageVisibility": { "enum": [ "public", "tenant", "unlisted" ], "title": "PageVisibility", "type": "string" }, "PassageVerdict": { "properties": { "backend": { "default": "none", "title": "Backend", "type": "string" }, "confidence": { "default": 0, "maximum": 1, "minimum": 0, "title": "Confidence", "type": "number" }, "reason": { "default": "not_checked", "title": "Reason", "type": "string" }, "source_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Source Id" }, "source_index": { "title": "Source Index", "type": "integer" }, "verdict": { "default": "unknown", "enum": [ "supported", "contradicted", "unsupported", "unknown" ], "title": "Verdict", "type": "string" } }, "required": [ "source_index" ], "title": "PassageVerdict", "type": "object" }, "PendingInvocation": { "properties": { "arguments": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Arguments" }, "effect": { "enum": [ "read", "write", "execute" ], "title": "Effect", "type": "string" }, "execution": { "enum": [ "local", "external" ], "title": "Execution", "type": "string" }, "input_digest": { "title": "Input Digest", "type": "string" }, "invocation_id": { "format": "uuid", "title": "Invocation Id", "type": "string" }, "output_schema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Output Schema" }, "run_id": { "format": "uuid", "title": "Run Id", "type": "string" }, "state": { "enum": [ "started", "awaiting_result", "completed" ], "title": "State", "type": "string" }, "tool": { "title": "Tool", "type": "string" } }, "required": [ "invocation_id", "run_id", "tool", "effect", "execution", "state", "input_digest" ], "title": "PendingInvocation", "type": "object" }, "PersonaResponse": { "properties": { "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instructions" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "personality": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Personality" }, "preferences": { "additionalProperties": true, "title": "Preferences", "type": "object" }, "tenant_id": { "title": "Tenant Id", "type": "string" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "user_context": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Context" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id" } }, "required": [ "id", "tenant_id", "user_id", "name", "personality", "instructions", "user_context", "preferences", "created_at", "updated_at" ], "title": "PersonaResponse", "type": "object" }, "PersonaUpsert": { "properties": { "instructions": { "anyOf": [ { "maxLength": 8000, "type": "string" }, { "type": "null" } ], "description": "Custom system instructions", "title": "Instructions" }, "name": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "description": "Assistant name", "title": "Name" }, "personality": { "anyOf": [ { "maxLength": 4000, "type": "string" }, { "type": "null" } ], "description": "Personality/tone description", "title": "Personality" }, "preferences": { "additionalProperties": true, "description": "Preferences: language, verbosity, format, etc.", "title": "Preferences", "type": "object" }, "user_context": { "anyOf": [ { "maxLength": 4000, "type": "string" }, { "type": "null" } ], "description": "Context about the user", "title": "User Context" } }, "title": "PersonaUpsert", "type": "object" }, "PlanApprovePayload": { "properties": { "action_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action Version" }, "plan": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Plan" } }, "title": "PlanApprovePayload", "type": "object" }, "PlanClarification": { "additionalProperties": true, "properties": { "answers": { "items": { "additionalProperties": { "type": "string" }, "type": "object" }, "title": "Answers", "type": "array" }, "ok": { "title": "Ok", "type": "boolean" }, "run_id": { "title": "Run Id", "type": "string" } }, "required": [ "ok", "run_id", "answers" ], "title": "PlanClarification", "type": "object" }, "PlanClarifyAnswerItem": { "properties": { "answer": { "maxLength": 8000, "title": "Answer", "type": "string" }, "question_id": { "maxLength": 128, "minLength": 1, "title": "Question Id", "type": "string" } }, "required": [ "question_id", "answer" ], "title": "PlanClarifyAnswerItem", "type": "object" }, "PlanClarifyPayload": { "properties": { "answers": { "items": { "$ref": "#/components/schemas/PlanClarifyAnswerItem" }, "title": "Answers", "type": "array" } }, "title": "PlanClarifyPayload", "type": "object" }, "PlanDeleted": { "additionalProperties": true, "properties": { "ok": { "title": "Ok", "type": "boolean" }, "plan_id": { "title": "Plan Id", "type": "string" } }, "required": [ "ok", "plan_id" ], "title": "PlanDeleted", "type": "object" }, "PlanList": { "additionalProperties": true, "properties": { "plans": { "items": { "$ref": "#/components/schemas/PlanSummary" }, "title": "Plans", "type": "array" } }, "required": [ "plans" ], "title": "PlanList", "type": "object" }, "PlanRejectPayload": { "properties": { "action_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action Version" }, "reason": { "default": "", "title": "Reason", "type": "string" } }, "title": "PlanRejectPayload", "type": "object" }, "PlanResponse": { "additionalProperties": true, "properties": { "created_at": { "title": "Created At", "type": "string" }, "description": { "title": "Description", "type": "string" }, "execution_plan": { "additionalProperties": true, "title": "Execution Plan", "type": "object" }, "markdown": { "title": "Markdown", "type": "string" }, "mode": { "title": "Mode", "type": "string" }, "plan_id": { "title": "Plan Id", "type": "string" }, "status": { "title": "Status", "type": "string" }, "updated_at": { "title": "Updated At", "type": "string" } }, "required": [ "plan_id", "execution_plan", "status", "mode", "description", "created_at", "updated_at", "markdown" ], "title": "PlanResponse", "type": "object" }, "PlanSummary": { "additionalProperties": true, "properties": { "created_at": { "title": "Created At", "type": "string" }, "description": { "title": "Description", "type": "string" }, "format": { "title": "Format", "type": "string" }, "mode": { "title": "Mode", "type": "string" }, "plan_id": { "title": "Plan Id", "type": "string" }, "status": { "title": "Status", "type": "string" }, "summary": { "title": "Summary", "type": "string" }, "updated_at": { "title": "Updated At", "type": "string" } }, "required": [ "plan_id", "status", "mode", "description", "created_at", "updated_at", "summary", "format" ], "title": "PlanSummary", "type": "object" }, "PlatformStatus": { "additionalProperties": true, "properties": { "checked_at": { "title": "Checked At", "type": "string" }, "degraded_capabilities": { "items": { "type": "string" }, "title": "Degraded Capabilities", "type": "array" }, "latency_ms": { "additionalProperties": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ] }, "title": "Latency Ms", "type": "object" }, "scope": { "default": "instance_dependencies", "title": "Scope", "type": "string" }, "services": { "additionalProperties": { "type": "string" }, "title": "Services", "type": "object" }, "status": { "title": "Status", "type": "string" }, "unverified_capabilities": { "default": [], "items": { "type": "string" }, "title": "Unverified Capabilities", "type": "array" }, "version": { "title": "Version", "type": "string" } }, "required": [ "status", "version", "services", "degraded_capabilities", "latency_ms", "checked_at" ], "title": "PlatformStatus", "type": "object" }, "Policy": { "additionalProperties": false, "properties": { "audience": { "enum": [ "public", "first_party", "admin", "experimental" ], "title": "Audience", "type": "string" }, "auth": { "enum": [ "anonymous", "credential", "api_key", "admin_session" ], "title": "Auth", "type": "string" }, "conditional_scopes": { "additionalProperties": { "type": "string" }, "title": "Conditional Scopes", "type": "object" }, "disabled_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Disabled Reason" }, "features": { "items": { "type": "string" }, "title": "Features", "type": "array" }, "reason": { "title": "Reason", "type": "string" }, "scope_policy": { "enum": [ "none", "ai_compat", "workspace", "a2a", "explicit" ], "title": "Scope Policy", "type": "string" }, "scopes": { "items": { "type": "string" }, "title": "Scopes", "type": "array" }, "settings": { "items": { "type": "string" }, "title": "Settings", "type": "array" }, "stability": { "enum": [ "stable", "beta", "alpha" ], "title": "Stability", "type": "string" }, "tenant": { "enum": [ "none", "credential", "credential_or_validated_request", "admin_target" ], "title": "Tenant", "type": "string" }, "user": { "title": "User", "type": "string" } }, "required": [ "audience", "auth", "scopes", "scope_policy", "tenant", "user", "features", "settings", "stability", "reason" ], "title": "Policy", "type": "object" }, "PortalSessionRequest": { "properties": { "return_url": { "minLength": 1, "title": "Return Url", "type": "string" } }, "required": [ "return_url" ], "title": "PortalSessionRequest", "type": "object" }, "PortalSessionResponse": { "properties": { "portal_session": { "additionalProperties": true, "title": "Portal Session", "type": "object" }, "tenant_id": { "title": "Tenant Id", "type": "string" } }, "required": [ "tenant_id", "portal_session" ], "title": "PortalSessionResponse", "type": "object" }, "PositionInput": { "additionalProperties": true, "description": "A single open position / holding for portfolio risk assessment.", "properties": { "current_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Current Price" }, "entry_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Entry Price" }, "notional": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Notional" }, "quantity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Quantity" }, "side": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "long|short", "title": "Side" }, "symbol": { "title": "Symbol", "type": "string" } }, "required": [ "symbol" ], "title": "PositionInput", "type": "object" }, "ProrationResponse": { "additionalProperties": true, "properties": { "proration_preview": { "additionalProperties": true, "title": "Proration Preview", "type": "object" }, "tenant_id": { "title": "Tenant Id", "type": "string" } }, "required": [ "tenant_id", "proration_preview" ], "title": "ProrationResponse", "type": "object" }, "ProtocolAgent": { "additionalProperties": true, "properties": { "agentId": { "title": "Agentid", "type": "string" }, "description": { "title": "Description", "type": "string" }, "endpoint": { "title": "Endpoint", "type": "string" }, "name": { "title": "Name", "type": "string" }, "protocols": { "items": { "type": "string" }, "title": "Protocols", "type": "array" }, "skills": { "items": { "additionalProperties": true, "type": "object" }, "title": "Skills", "type": "array" }, "version": { "title": "Version", "type": "string" } }, "required": [ "agentId", "name", "description", "version", "skills", "endpoint", "protocols" ], "title": "ProtocolAgent", "type": "object" }, "ProtocolAgents": { "additionalProperties": true, "properties": { "agents": { "items": { "$ref": "#/components/schemas/ProtocolAgent" }, "title": "Agents", "type": "array" } }, "required": [ "agents" ], "title": "ProtocolAgents", "type": "object" }, "ProviderDiagnostics": { "additionalProperties": false, "properties": { "attempts": { "title": "Attempts", "type": "integer" }, "cost_complete": { "title": "Cost Complete", "type": "boolean" }, "incomplete": { "title": "Incomplete", "type": "integer" }, "input_tokens": { "title": "Input Tokens", "type": "integer" }, "observed_cost_usd": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Observed Cost Usd" }, "output_tokens": { "title": "Output Tokens", "type": "integer" } }, "required": [ "attempts", "incomplete", "input_tokens", "output_tokens", "observed_cost_usd", "cost_complete" ], "title": "ProviderDiagnostics", "type": "object" }, "ProviderInfo": { "description": "Information about an available provider.", "properties": { "brand_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Brand colour hex code", "title": "Brand Color" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Provider category", "title": "Category" }, "configured": { "default": false, "description": "Whether the provider has API credentials configured", "title": "Configured", "type": "boolean" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Short provider description", "title": "Description" }, "display_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "UI sort priority", "title": "Display Order" }, "docs_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "API documentation URL", "title": "Docs Url" }, "enabled": { "default": true, "description": "Whether the provider is enabled", "title": "Enabled", "type": "boolean" }, "id": { "description": "Provider identifier", "title": "Id", "type": "string" }, "logo_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Path to provider logo SVG", "title": "Logo Path" }, "model_count": { "default": 0, "description": "Number of models available from this provider", "title": "Model Count", "type": "integer" }, "name": { "description": "Human-readable provider name", "title": "Name", "type": "string" }, "website_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Provider website URL", "title": "Website Url" } }, "required": [ "id", "name" ], "title": "ProviderInfo", "type": "object" }, "PublicSearchRequest": { "properties": { "filters": { "anyOf": [ { "$ref": "#/components/schemas/SearchFiltersPayload" }, { "type": "null" } ] }, "focus": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Deprecated: use mode + filters.domains", "title": "Focus" }, "limit": { "default": 10, "exclusiveMinimum": 0.0, "maximum": 50.0, "title": "Limit", "type": "integer" }, "max_results": { "anyOf": [ { "exclusiveMinimum": 0.0, "maximum": 50.0, "type": "integer" }, { "type": "null" } ], "title": "Max Results" }, "mode": { "$ref": "#/components/schemas/SearchMode", "default": "web" }, "offset": { "default": 0, "maximum": 5000.0, "minimum": 0.0, "title": "Offset", "type": "integer" }, "query": { "maxLength": 2000, "minLength": 1, "title": "Query", "type": "string" }, "search_domain_filter": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Search Domain Filter" }, "site_filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Site Filter" } }, "required": [ "query" ], "title": "PublicSearchRequest", "type": "object" }, "PublicSearchResponse": { "properties": { "elapsed_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Elapsed Ms" }, "hits": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SearchResultItem" }, "type": "array" }, { "type": "null" } ], "title": "Hits" }, "mode": { "title": "Mode", "type": "string" }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" }, "query": { "title": "Query", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/SearchResultItem" }, "title": "Results", "type": "array" }, "search_time_ms": { "default": 0, "title": "Search Time Ms", "type": "integer" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "results", "total", "query", "mode" ], "title": "PublicSearchResponse", "type": "object" }, "PullConfig": { "description": "Configuration for Pull mode.\n\nQ calls back to the third party's endpoint to fetch context on-demand.\nBetter for large datasets and dynamic context needs.", "examples": [ { "auth": { "credentials": "token", "type": "bearer" }, "endpoint": "https://blackink.io/q-context", "max_chunks": 20, "scopes": [ "documents", "tasks" ], "timeout_ms": 5000 } ], "properties": { "auth": { "$ref": "#/components/schemas/AuthConfig", "description": "Authentication configuration" }, "endpoint": { "description": "URL of the context provider endpoint (e.g., https://blackink.io/q-context)", "title": "Endpoint", "type": "string" }, "max_chunks": { "default": 20, "description": "Maximum chunks to request", "maximum": 100.0, "minimum": 1.0, "title": "Max Chunks", "type": "integer" }, "max_tokens": { "default": 50000, "description": "Maximum tokens to request", "maximum": 200000.0, "minimum": 1000.0, "title": "Max Tokens", "type": "integer" }, "scopes": { "description": "Context types to request (e.g., ['documents', 'tasks', 'calendar'])", "items": { "type": "string" }, "title": "Scopes", "type": "array" }, "timeout_ms": { "default": 5000, "description": "Request timeout in milliseconds", "maximum": 30000.0, "minimum": 100.0, "title": "Timeout Ms", "type": "integer" } }, "required": [ "endpoint", "auth" ], "title": "PullConfig", "type": "object" }, "PushContext": { "description": "Context pushed with the request.\n\nThird parties build context client-side and include it directly\nin the chat request. Lowest latency, simplest integration.", "examples": [ { "sections": [ { "content": "Acme Corp is a technology company...", "id": "company-profile", "priority": "high", "title": "Company Profile", "type": "profile" } ] } ], "properties": { "raw": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Raw context string (alternative to sections)", "title": "Raw" }, "sections": { "description": "Structured context sections", "items": { "$ref": "#/components/schemas/ContextSection" }, "title": "Sections", "type": "array" } }, "title": "PushContext", "type": "object" }, "ReadinessCheck": { "additionalProperties": true, "properties": { "active_dimensions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Active Dimensions" }, "default_dimensions": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Default Dimensions" }, "endpoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Endpoint" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "missing": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Missing" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" }, "name": { "title": "Name", "type": "string" }, "status": { "title": "Status", "type": "string" } }, "required": [ "name", "status" ], "title": "ReadinessCheck", "type": "object" }, "RegistrationResult": { "properties": { "registered": { "title": "Registered", "type": "string" } }, "required": [ "registered" ], "title": "RegistrationResult", "type": "object" }, "RegulatoryItem": { "additionalProperties": true, "description": "A regulatory / compliance watch item relevant to the instruments.", "properties": { "jurisdiction": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Jurisdiction" }, "severity": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "info|low|medium|high", "title": "Severity" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Summary" }, "title": { "title": "Title", "type": "string" } }, "required": [ "title" ], "title": "RegulatoryItem", "type": "object" }, "RequestLogDetail": { "properties": { "created_at": { "title": "Created At", "type": "string" }, "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Code" }, "latency_ms": { "title": "Latency Ms", "type": "integer" }, "method": { "title": "Method", "type": "string" }, "path": { "title": "Path", "type": "string" }, "request_body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request Body" }, "request_id": { "title": "Request Id", "type": "string" }, "response_body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Response Body" }, "status_code": { "title": "Status Code", "type": "integer" } }, "required": [ "request_id", "method", "path", "status_code", "latency_ms", "created_at" ], "title": "RequestLogDetail", "type": "object" }, "RequestLogSummary": { "properties": { "created_at": { "title": "Created At", "type": "string" }, "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Code" }, "latency_ms": { "title": "Latency Ms", "type": "integer" }, "method": { "title": "Method", "type": "string" }, "path": { "title": "Path", "type": "string" }, "request_id": { "title": "Request Id", "type": "string" }, "status_code": { "title": "Status Code", "type": "integer" } }, "required": [ "request_id", "method", "path", "status_code", "latency_ms", "created_at" ], "title": "RequestLogSummary", "type": "object" }, "ResolveRulesBody": { "properties": { "activation_context": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Activation Context" }, "include_builtin": { "default": true, "title": "Include Builtin", "type": "boolean" }, "space_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Space Id" }, "task_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Task Description" } }, "title": "ResolveRulesBody", "type": "object" }, "ResolvedRule": { "additionalProperties": true, "properties": { "activation_mode": { "title": "Activation Mode", "type": "string" }, "builtin": { "title": "Builtin", "type": "boolean" }, "content": { "title": "Content", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "name": { "title": "Name", "type": "string" }, "priority": { "title": "Priority", "type": "integer" }, "scope": { "title": "Scope", "type": "string" }, "slug": { "title": "Slug", "type": "string" } }, "required": [ "id", "slug", "name", "description", "content", "scope", "activation_mode", "priority", "builtin" ], "title": "ResolvedRule", "type": "object" }, "ResolvedRules": { "additionalProperties": true, "properties": { "prompt_section": { "title": "Prompt Section", "type": "string" }, "rules": { "items": { "$ref": "#/components/schemas/ResolvedRule" }, "title": "Rules", "type": "array" } }, "required": [ "rules", "prompt_section" ], "title": "ResolvedRules", "type": "object" }, "ResolvedSkillOut": { "properties": { "assets": { "items": { "additionalProperties": true, "type": "object" }, "title": "Assets", "type": "array" }, "category": { "$ref": "#/components/schemas/SkillCategory" }, "name": { "title": "Name", "type": "string" }, "rendered_instructions": { "title": "Rendered Instructions", "type": "string" }, "similarity": { "title": "Similarity", "type": "number" }, "skill_id": { "format": "uuid", "title": "Skill Id", "type": "string" }, "slug": { "title": "Slug", "type": "string" } }, "required": [ "skill_id", "slug", "name", "category", "similarity", "rendered_instructions" ], "title": "ResolvedSkillOut", "type": "object" }, "ResultIssue": { "properties": { "code": { "title": "Code", "type": "string" }, "component": { "title": "Component", "type": "string" }, "retryable": { "default": false, "title": "Retryable", "type": "boolean" } }, "required": [ "code", "component" ], "title": "ResultIssue", "type": "object" }, "ResultQuality": { "description": "Partial concerns missing work; degraded concerns reduced quality or fallback.\n\nUnknown means the producer has not measured completeness. Do not infer\nsuccess from an empty warnings list or a successful HTTP status.", "properties": { "completeness": { "default": "unknown", "enum": [ "complete", "partial", "unknown" ], "title": "Completeness", "type": "string" }, "degraded": { "default": false, "title": "Degraded", "type": "boolean" }, "issues": { "items": { "$ref": "#/components/schemas/ResultIssue" }, "title": "Issues", "type": "array" } }, "title": "ResultQuality", "type": "object" }, "ResumeRunBody": { "properties": { "additional_prompt": { "anyOf": [ { "maxLength": 16000, "type": "string" }, { "type": "null" } ], "title": "Additional Prompt" } }, "title": "ResumeRunBody", "type": "object" }, "RetrievalFilters": { "additionalProperties": false, "properties": { "document_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Document Id" }, "document_type": { "anyOf": [ { "maxLength": 128, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Document Type" }, "space_id": { "anyOf": [ { "maxLength": 128, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Space Id" } }, "title": "RetrievalFilters", "type": "object" }, "RetrievalOutcome": { "properties": { "code": { "enum": [ "matched", "empty_corpus", "no_relevant_hit", "timeout", "cancelled", "embedding_configuration_invalid", "embedding_unavailable", "provider_unavailable", "not_configured", "access_denied", "permission_unavailable", "not_attempted", "source_excluded" ], "title": "Code", "type": "string" }, "result_count": { "default": 0, "minimum": 0, "title": "Result Count", "type": "integer" }, "retryable": { "default": false, "title": "Retryable", "type": "boolean" }, "state": { "enum": [ "available", "empty", "partial", "unavailable", "not_attempted" ], "title": "State", "type": "string" }, "tool": { "title": "Tool", "type": "string" } }, "required": [ "tool", "state", "code" ], "title": "RetrievalOutcome", "type": "object" }, "RetrievalQualityPrimaryPayload": { "description": "Primary knobs only \u2014 secondary metadata fields are not writable here.", "properties": { "l2_rerank_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "When false, skip the L2 cross-encoder stage", "title": "L2 Rerank Enabled" }, "max_candidates": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Ceiling on passages sent to L2 (cost / latency guard)", "title": "Max Candidates" }, "rrf_k": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "RRF smoothing constant (Cormack default 60)", "title": "Rrf K" } }, "title": "RetrievalQualityPrimaryPayload", "type": "object" }, "RetrievalQualityResponse": { "additionalProperties": true, "properties": { "retrieval_quality": { "additionalProperties": true, "title": "Retrieval Quality", "type": "object" }, "tenant_id": { "title": "Tenant Id", "type": "string" } }, "required": [ "tenant_id", "retrieval_quality" ], "title": "RetrievalQualityResponse", "type": "object" }, "RiskAssessment": { "additionalProperties": true, "description": "A portfolio/position risk observation.", "properties": { "observation": { "title": "Observation", "type": "string" }, "risk_level": { "description": "low|medium|high|critical", "title": "Risk Level", "type": "string" }, "subject": { "description": "Symbol or 'portfolio'.", "title": "Subject", "type": "string" }, "suggested_mitigation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Suggested Mitigation" } }, "required": [ "subject", "risk_level", "observation" ], "title": "RiskAssessment", "type": "object" }, "RuleActivationMode": { "enum": [ "always", "conditional", "agent_requested", "manual" ], "title": "RuleActivationMode", "type": "string" }, "RuleCreate": { "properties": { "activation_mode": { "$ref": "#/components/schemas/RuleActivationMode", "default": "always" }, "condition_pattern": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Condition Pattern" }, "content": { "minLength": 1, "title": "Content", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "is_active": { "default": true, "title": "Is Active", "type": "boolean" }, "metadata_json": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata Json" }, "name": { "maxLength": 256, "minLength": 1, "title": "Name", "type": "string" }, "priority": { "default": 0, "title": "Priority", "type": "integer" }, "scope": { "$ref": "#/components/schemas/RuleScope" }, "slug": { "maxLength": 128, "minLength": 1, "title": "Slug", "type": "string" }, "space_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Space Id" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" } }, "required": [ "name", "slug", "content", "scope" ], "title": "RuleCreate", "type": "object" }, "RuleList": { "additionalProperties": true, "properties": { "rules": { "items": { "$ref": "#/components/schemas/RuleResponse" }, "title": "Rules", "type": "array" } }, "required": [ "rules" ], "title": "RuleList", "type": "object" }, "RuleResponse": { "additionalProperties": true, "properties": { "activation_mode": { "title": "Activation Mode", "type": "string" }, "condition_pattern": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Condition Pattern" }, "content": { "title": "Content", "type": "string" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "id": { "title": "Id", "type": "string" }, "is_active": { "title": "Is Active", "type": "boolean" }, "metadata_json": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata Json" }, "name": { "title": "Name", "type": "string" }, "priority": { "title": "Priority", "type": "integer" }, "scope": { "title": "Scope", "type": "string" }, "slug": { "title": "Slug", "type": "string" }, "space_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Space Id" }, "tenant_id": { "title": "Tenant Id", "type": "string" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "required": [ "id", "tenant_id", "space_id", "name", "slug", "description", "content", "scope", "activation_mode", "condition_pattern", "priority", "is_active", "metadata_json", "created_at", "updated_at" ], "title": "RuleResponse", "type": "object" }, "RuleScope": { "enum": [ "system", "tenant", "space", "task" ], "title": "RuleScope", "type": "string" }, "RuleUpdate": { "properties": { "activation_mode": { "anyOf": [ { "$ref": "#/components/schemas/RuleActivationMode" }, { "type": "null" } ] }, "condition_pattern": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Condition Pattern" }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active" }, "metadata_json": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata Json" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "priority": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Priority" }, "scope": { "anyOf": [ { "$ref": "#/components/schemas/RuleScope" }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Slug" }, "space_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Space Id" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" } }, "title": "RuleUpdate", "type": "object" }, "RunDiagnostics": { "additionalProperties": false, "properties": { "agent_id": { "title": "Agent Id", "type": "string" }, "billing": { "$ref": "#/components/schemas/BillingDiagnostics" }, "completed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Completed At" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "deadline_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Deadline At" }, "delivery_states": { "additionalProperties": { "type": "integer" }, "title": "Delivery States", "type": "object" }, "elapsed_ms": { "title": "Elapsed Ms", "type": "number" }, "failure_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Failure Code" }, "generated_at": { "format": "date-time", "title": "Generated At", "type": "string" }, "last_sequence": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Last Sequence" }, "latest_attempt": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Latest Attempt" }, "limitations": { "items": { "type": "string" }, "title": "Limitations", "type": "array" }, "next_action": { "title": "Next Action", "type": "string" }, "provider": { "$ref": "#/components/schemas/ProviderDiagnostics" }, "queue_ms": { "title": "Queue Ms", "type": "number" }, "reason": { "title": "Reason", "type": "string" }, "replay_available": { "title": "Replay Available", "type": "boolean" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request Id" }, "run_id": { "title": "Run Id", "type": "string" }, "stages": { "items": { "$ref": "#/components/schemas/StageTiming" }, "title": "Stages", "type": "array" }, "stages_recorded_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Stages Recorded At" }, "started_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Started At" }, "status": { "title": "Status", "type": "string" }, "tool_states": { "additionalProperties": { "type": "integer" }, "title": "Tool States", "type": "object" }, "version": { "const": 1, "default": 1, "title": "Version", "type": "integer" } }, "required": [ "run_id", "agent_id", "request_id", "status", "reason", "next_action", "generated_at", "created_at", "started_at", "completed_at", "deadline_at", "elapsed_ms", "queue_ms", "latest_attempt", "stages_recorded_at", "stages", "provider", "billing", "tool_states", "delivery_states", "replay_available", "last_sequence", "limitations" ], "title": "RunDiagnostics", "type": "object" }, "ScheduleCreate": { "properties": { "action_config": { "additionalProperties": true, "description": "Action-specific config: {prompt, agent_id, query, webhook_url, ...}", "title": "Action Config", "type": "object" }, "action_type": { "description": "Action: answer, agent_run, search, webhook", "enum": [ "answer", "agent_run", "search", "webhook" ], "title": "Action Type", "type": "string" }, "channel_connection_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "description": "Optional channel to deliver results to", "title": "Channel Connection Id" }, "delivery_config": { "additionalProperties": true, "description": "Delivery options: {recipient_id, thread_id, format}", "title": "Delivery Config", "type": "object" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "name": { "maxLength": 256, "minLength": 1, "title": "Name", "type": "string" }, "schedule_expr": { "description": "Cron expression (5-field), interval (30m, 1h, 1d), or ISO 8601 timestamp", "title": "Schedule Expr", "type": "string" }, "schedule_type": { "description": "Type: cron, interval, once", "enum": [ "cron", "interval", "once" ], "title": "Schedule Type", "type": "string" }, "timezone": { "default": "UTC", "title": "Timezone", "type": "string" } }, "required": [ "name", "schedule_type", "schedule_expr", "action_type", "action_config" ], "title": "ScheduleCreate", "type": "object" }, "ScheduleList": { "additionalProperties": true, "properties": { "schedules": { "items": { "$ref": "#/components/schemas/ScheduleResponse" }, "title": "Schedules", "type": "array" } }, "required": [ "schedules" ], "title": "ScheduleList", "type": "object" }, "ScheduleResponse": { "additionalProperties": true, "properties": { "action_config": { "additionalProperties": true, "title": "Action Config", "type": "object" }, "action_type": { "title": "Action Type", "type": "string" }, "channel_connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Connection Id" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "delivery_config": { "additionalProperties": true, "title": "Delivery Config", "type": "object" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "error_count": { "title": "Error Count", "type": "integer" }, "id": { "title": "Id", "type": "string" }, "last_run_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Run At" }, "name": { "title": "Name", "type": "string" }, "next_run_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Run At" }, "run_count": { "title": "Run Count", "type": "integer" }, "schedule_expr": { "title": "Schedule Expr", "type": "string" }, "schedule_type": { "title": "Schedule Type", "type": "string" }, "status": { "title": "Status", "type": "string" }, "tenant_id": { "title": "Tenant Id", "type": "string" }, "timezone": { "title": "Timezone", "type": "string" } }, "required": [ "id", "tenant_id", "name", "description", "schedule_type", "schedule_expr", "timezone", "action_type", "action_config", "channel_connection_id", "delivery_config", "status", "last_run_at", "next_run_at", "run_count", "error_count", "created_at" ], "title": "ScheduleResponse", "type": "object" }, "SdkEvidence": { "additionalProperties": false, "properties": { "path": { "title": "Path", "type": "string" }, "source": { "title": "Source", "type": "string" }, "transport": { "title": "Transport", "type": "string" } }, "required": [ "source", "transport", "path" ], "title": "SdkEvidence", "type": "object" }, "SdkSupport": { "additionalProperties": false, "properties": { "evidence": { "default": [], "items": { "$ref": "#/components/schemas/SdkEvidence" }, "title": "Evidence", "type": "array" }, "qualification": { "default": "Checkout source only; released-package conformance is not asserted.", "title": "Qualification", "type": "string" }, "status": { "enum": [ "source_wrapper", "unverified", "not_public" ], "title": "Status", "type": "string" } }, "required": [ "status" ], "title": "SdkSupport", "type": "object" }, "SearchFiltersPayload": { "properties": { "date_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date From" }, "date_to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date To" }, "domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Domains" }, "exclude_domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Exclude Domains" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" }, "recency": { "anyOf": [ { "enum": [ "hour", "day", "week", "month", "year" ], "type": "string" }, { "type": "null" } ], "title": "Recency" }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Region" } }, "title": "SearchFiltersPayload", "type": "object" }, "SearchMode": { "enum": [ "web", "academic", "legal", "financial", "news" ], "title": "SearchMode", "type": "string" }, "SearchResponse": { "properties": { "results": { "items": { "$ref": "#/components/schemas/SearchResponseItem" }, "title": "Results", "type": "array" } }, "required": [ "results" ], "title": "SearchResponse", "type": "object" }, "SearchResponseItem": { "properties": { "approx_similarity": { "title": "Approx Similarity", "type": "number" }, "snippet": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Snippet" }, "text": { "title": "Text", "type": "string" } }, "required": [ "text", "approx_similarity" ], "title": "SearchResponseItem", "type": "object" }, "SearchResultItem": { "properties": { "date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date" }, "last_updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Updated" }, "relevance_score": { "default": 0.0, "title": "Relevance Score", "type": "number" }, "snippet": { "title": "Snippet", "type": "string" }, "source_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Type" }, "title": { "title": "Title", "type": "string" }, "url": { "title": "Url", "type": "string" } }, "required": [ "title", "url", "snippet" ], "title": "SearchResultItem", "type": "object" }, "SearchTrace": { "additionalProperties": true, "properties": { "errors": { "items": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": "Errors", "type": "array" }, "latency_ms": { "items": { "type": "integer" }, "title": "Latency Ms", "type": "array" }, "queries": { "items": { "type": "string" }, "title": "Queries", "type": "array" }, "result_counts": { "items": { "type": "integer" }, "title": "Result Counts", "type": "array" }, "tool_ids": { "items": { "type": "string" }, "title": "Tool Ids", "type": "array" }, "tool_names": { "items": { "type": "string" }, "title": "Tool Names", "type": "array" } }, "required": [ "tool_ids", "tool_names", "queries", "result_counts", "latency_ms", "errors" ], "title": "SearchTrace", "type": "object" }, "SemanticSearchRequest": { "properties": { "category_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category Key" }, "created_after": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created After" }, "created_before": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created Before" }, "document_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Document Id" }, "document_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Document Type" }, "embedding_dim": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Embedding Dim" }, "enable_rerank": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enable Rerank" }, "include_snippets": { "default": false, "title": "Include Snippets", "type": "boolean" }, "k": { "default": 10, "exclusiveMinimum": 0.0, "maximum": 50.0, "title": "K", "type": "integer" }, "match_threshold": { "default": 0.7, "maximum": 1.0, "minimum": 0.0, "title": "Match Threshold", "type": "number" }, "metadata_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Metadata Key" }, "metadata_value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Metadata Value" }, "mmr": { "default": false, "title": "Mmr", "type": "boolean" }, "query": { "maxLength": 8000, "minLength": 1, "title": "Query", "type": "string" }, "role_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role Key" }, "type_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type Key" } }, "required": [ "query" ], "title": "SemanticSearchRequest", "type": "object" }, "SentimentSignal": { "additionalProperties": true, "description": "Aggregated sentiment for an instrument or the overall market.", "properties": { "confidence": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "0..1 model confidence", "title": "Confidence" }, "drivers": { "items": { "type": "string" }, "title": "Drivers", "type": "array" }, "rationale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rationale" }, "sentiment": { "description": "bullish|bearish|neutral|mixed", "title": "Sentiment", "type": "string" }, "subject": { "description": "Instrument symbol or 'overall'.", "title": "Subject", "type": "string" } }, "required": [ "subject", "sentiment" ], "title": "SentimentSignal", "type": "object" }, "ServiceObjectives": { "additionalProperties": false, "properties": { "generated_at": { "format": "date-time", "title": "Generated At", "type": "string" }, "limitations": { "items": { "type": "string" }, "title": "Limitations", "type": "array" }, "objectives": { "items": { "$ref": "#/components/schemas/Objective" }, "title": "Objectives", "type": "array" }, "run_states": { "additionalProperties": { "type": "integer" }, "title": "Run States", "type": "object" }, "scope": { "const": "authenticated_principal", "default": "authenticated_principal", "title": "Scope", "type": "string" }, "version": { "const": 1, "default": 1, "title": "Version", "type": "integer" }, "window_start": { "format": "date-time", "title": "Window Start", "type": "string" } }, "required": [ "generated_at", "window_start", "objectives", "run_states", "limitations" ], "title": "ServiceObjectives", "type": "object" }, "SkillActivationMode": { "description": "When a skill applies relative to the task.", "enum": [ "always", "conditional", "on_demand", "auto" ], "title": "SkillActivationMode", "type": "string" }, "SkillAssetOut": { "properties": { "asset_type": { "$ref": "#/components/schemas/SkillAssetType" }, "content": { "title": "Content", "type": "string" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "order_index": { "title": "Order Index", "type": "integer" } }, "required": [ "id", "name", "asset_type", "content", "order_index" ], "title": "SkillAssetOut", "type": "object" }, "SkillAssetType": { "description": "Kind of supplemental asset bundled with a skill.", "enum": [ "reference", "script", "template", "example" ], "title": "SkillAssetType", "type": "string" }, "SkillCategory": { "description": "High-level grouping for capability skills.", "enum": [ "research", "document", "presentation", "analysis", "coding", "general" ], "title": "SkillCategory", "type": "string" }, "SkillImportBody": { "properties": { "yaml_content": { "maxLength": 2000000, "minLength": 1, "title": "Yaml Content", "type": "string" } }, "required": [ "yaml_content" ], "title": "SkillImportBody", "type": "object" }, "SkillInstall": { "properties": { "slug": { "description": "Skill slug to install", "title": "Slug", "type": "string" } }, "required": [ "slug" ], "title": "SkillInstall", "type": "object" }, "SkillInstallation": { "additionalProperties": true, "properties": { "installed": { "title": "Installed", "type": "boolean" }, "slug": { "title": "Slug", "type": "string" }, "version": { "title": "Version", "type": "string" } }, "required": [ "installed", "slug", "version" ], "title": "SkillInstallation", "type": "object" }, "SkillOut": { "properties": { "activation_mode": { "$ref": "#/components/schemas/SkillActivationMode" }, "assets": { "items": { "$ref": "#/components/schemas/SkillAssetOut" }, "title": "Assets", "type": "array" }, "category": { "$ref": "#/components/schemas/SkillCategory" }, "condition_pattern": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Condition Pattern" }, "created_at": { "title": "Created At", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "instructions": { "title": "Instructions", "type": "string" }, "is_active": { "title": "Is Active", "type": "boolean" }, "is_system": { "title": "Is System", "type": "boolean" }, "metadata": { "additionalProperties": true, "title": "Metadata", "type": "object" }, "name": { "title": "Name", "type": "string" }, "slug": { "title": "Slug", "type": "string" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" }, "updated_at": { "title": "Updated At", "type": "string" }, "version": { "title": "Version", "type": "string" } }, "required": [ "id", "name", "slug", "version", "category", "instructions", "metadata", "activation_mode", "is_active", "is_system", "created_at", "updated_at" ], "title": "SkillOut", "type": "object" }, "SkillPackage": { "additionalProperties": false, "properties": { "category": { "default": "general", "enum": [ "research", "document", "presentation", "analysis", "coding", "general" ], "title": "Category", "type": "string" }, "instructions": { "maxLength": 32000, "minLength": 1, "title": "Instructions", "type": "string" }, "references": { "items": { "$ref": "#/components/schemas/SkillReference" }, "maxItems": 8, "title": "References", "type": "array" } }, "required": [ "instructions" ], "title": "SkillPackage", "type": "object" }, "SkillReference": { "additionalProperties": false, "properties": { "content": { "maxLength": 8000, "title": "Content", "type": "string" }, "name": { "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,63}\\.md$", "title": "Name", "type": "string" } }, "required": [ "name", "content" ], "title": "SkillReference", "type": "object" }, "SkillResolveRequest": { "properties": { "activation_context": { "additionalProperties": true, "title": "Activation Context", "type": "object" }, "similarity_threshold": { "default": 0.32, "maximum": 1.0, "minimum": 0.0, "title": "Similarity Threshold", "type": "number" }, "task_description": { "maxLength": 16000, "minLength": 1, "title": "Task Description", "type": "string" }, "top_k": { "default": 3, "maximum": 12.0, "minimum": 1.0, "title": "Top K", "type": "integer" } }, "required": [ "task_description" ], "title": "SkillResolveRequest", "type": "object" }, "SkillSummaryOut": { "properties": { "activation_mode": { "$ref": "#/components/schemas/SkillActivationMode" }, "category": { "$ref": "#/components/schemas/SkillCategory" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "is_active": { "title": "Is Active", "type": "boolean" }, "is_system": { "title": "Is System", "type": "boolean" }, "name": { "title": "Name", "type": "string" }, "slug": { "title": "Slug", "type": "string" }, "version": { "title": "Version", "type": "string" } }, "required": [ "id", "slug", "name", "category", "version", "activation_mode", "is_active", "is_system" ], "title": "SkillSummaryOut", "type": "object" }, "SonarChoice": { "properties": { "finish_reason": { "default": "stop", "enum": [ "stop", "length" ], "title": "Finish Reason", "type": "string" }, "index": { "default": 0, "title": "Index", "type": "integer" }, "message": { "$ref": "#/components/schemas/SonarChoiceMessage" } }, "required": [ "message" ], "title": "SonarChoice", "type": "object" }, "SonarChoiceMessage": { "properties": { "content": { "title": "Content", "type": "string" }, "role": { "const": "assistant", "default": "assistant", "title": "Role", "type": "string" } }, "required": [ "content" ], "title": "SonarChoiceMessage", "type": "object" }, "SonarMessage": { "properties": { "content": { "title": "Content", "type": "string" }, "role": { "enum": [ "system", "user", "assistant" ], "title": "Role", "type": "string" } }, "required": [ "role", "content" ], "title": "SonarMessage", "type": "object" }, "SonarModel": { "additionalProperties": true, "properties": { "description": { "title": "Description", "type": "string" }, "id": { "title": "Id", "type": "string" }, "object": { "title": "Object", "type": "string" }, "owned_by": { "title": "Owned By", "type": "string" } }, "required": [ "id", "object", "owned_by", "description" ], "title": "SonarModel", "type": "object" }, "SonarModels": { "additionalProperties": true, "properties": { "data": { "items": { "$ref": "#/components/schemas/SonarModel" }, "title": "Data", "type": "array" }, "object": { "title": "Object", "type": "string" } }, "required": [ "object", "data" ], "title": "SonarModels", "type": "object" }, "SonarRequest": { "properties": { "max_tokens": { "anyOf": [ { "exclusiveMinimum": 0.0, "maximum": 16384.0, "type": "integer" }, { "type": "null" } ], "title": "Max Tokens" }, "messages": { "items": { "$ref": "#/components/schemas/SonarMessage" }, "title": "Messages", "type": "array" }, "model": { "description": "sonar, sonar-pro, sonar-reasoning, sonar-reasoning-pro, sonar-deep-research", "title": "Model", "type": "string" }, "return_citations": { "default": true, "title": "Return Citations", "type": "boolean" }, "return_images": { "default": false, "title": "Return Images", "type": "boolean" }, "return_related_questions": { "default": false, "title": "Return Related Questions", "type": "boolean" }, "search_context_size": { "anyOf": [ { "enum": [ "low", "medium", "high" ], "type": "string" }, { "type": "null" } ], "default": "medium", "title": "Search Context Size" }, "search_domain_filter": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Search Domain Filter" }, "stream": { "default": false, "title": "Stream", "type": "boolean" }, "temperature": { "default": 0.2, "title": "Temperature", "type": "number" }, "top_p": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Top P" } }, "required": [ "model", "messages" ], "title": "SonarRequest", "type": "object" }, "SonarResponse": { "properties": { "choices": { "items": { "$ref": "#/components/schemas/SonarChoice" }, "title": "Choices", "type": "array" }, "citations": { "items": { "type": "string" }, "title": "Citations", "type": "array" }, "created": { "title": "Created", "type": "integer" }, "id": { "title": "Id", "type": "string" }, "model": { "title": "Model", "type": "string" }, "object": { "const": "chat.completion", "default": "chat.completion", "title": "Object", "type": "string" }, "related_questions": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Related Questions" }, "search_results": { "items": { "$ref": "#/components/schemas/SonarSearchResult" }, "title": "Search Results", "type": "array" }, "usage": { "$ref": "#/components/schemas/SonarUsage" } }, "required": [ "id", "model", "created", "choices", "usage" ], "title": "SonarResponse", "type": "object" }, "SonarSearchResult": { "properties": { "date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date" }, "title": { "title": "Title", "type": "string" }, "url": { "title": "Url", "type": "string" } }, "required": [ "title", "url" ], "title": "SonarSearchResult", "type": "object" }, "SonarUsage": { "properties": { "completion_tokens": { "default": 0, "title": "Completion Tokens", "type": "integer" }, "cost": { "additionalProperties": { "type": "number" }, "title": "Cost", "type": "object" }, "prompt_tokens": { "default": 0, "title": "Prompt Tokens", "type": "integer" }, "search_context_size": { "default": "medium", "title": "Search Context Size", "type": "string" }, "total_tokens": { "default": 0, "title": "Total Tokens", "type": "integer" } }, "title": "SonarUsage", "type": "object" }, "Source": { "additionalProperties": true, "properties": { "chunk_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Chunk Id" }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Domain" }, "id": { "title": "Id", "type": "string" }, "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Index" }, "published_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Published Date" }, "rank_position": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Rank Position" }, "relevance_score": { "default": 0, "title": "Relevance Score", "type": "number" }, "retrieved_by": { "default": "", "title": "Retrieved By", "type": "string" }, "score": { "title": "Score", "type": "number" }, "snippet": { "title": "Snippet", "type": "string" }, "source_type": { "default": "", "title": "Source Type", "type": "string" }, "title": { "title": "Title", "type": "string" }, "tool": { "default": "", "title": "Tool", "type": "string" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url" } }, "required": [ "id", "title", "snippet", "score" ], "title": "Source", "type": "object" }, "SourcePermission": { "additionalProperties": false, "properties": { "owner_id": { "anyOf": [ { "maxLength": 256, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Owner Id" }, "users": { "items": { "type": "string" }, "maxItems": 32, "title": "Users", "type": "array" }, "visibility": { "default": "private", "enum": [ "private", "tenant" ], "title": "Visibility", "type": "string" } }, "title": "SourcePermission", "type": "object" }, "SpaceCollaborator": { "additionalProperties": true, "properties": { "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "role": { "title": "Role", "type": "string" }, "user_id": { "title": "User Id", "type": "string" } }, "required": [ "user_id", "role", "email" ], "title": "SpaceCollaborator", "type": "object" }, "SpaceCreate": { "properties": { "description": { "default": "", "title": "Description", "type": "string" }, "instructions": { "default": "", "title": "Instructions", "type": "string" }, "model_prefs": { "anyOf": [ { "$ref": "#/components/schemas/ModelPrefsPayload" }, { "type": "null" } ] }, "name": { "minLength": 1, "title": "Name", "type": "string" }, "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" }, "visibility": { "$ref": "#/components/schemas/SpaceVisibility", "default": "private" } }, "required": [ "name" ], "title": "SpaceCreate", "type": "object" }, "SpaceFile": { "additionalProperties": true, "properties": { "chunks_indexed": { "title": "Chunks Indexed", "type": "integer" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "id": { "title": "Id", "type": "string" }, "metadata": { "additionalProperties": true, "title": "Metadata", "type": "object" }, "mime_type": { "title": "Mime Type", "type": "string" }, "name": { "title": "Name", "type": "string" }, "size_bytes": { "title": "Size Bytes", "type": "integer" }, "status": { "title": "Status", "type": "string" }, "uploaded_at": { "title": "Uploaded At", "type": "string" }, "uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Uri" } }, "required": [ "id", "name", "mime_type", "size_bytes", "uri", "chunks_indexed", "status", "error", "uploaded_at", "metadata" ], "title": "SpaceFile", "type": "object" }, "SpacePageCreatePayload": { "properties": { "answer_markdown": { "minLength": 1, "title": "Answer Markdown", "type": "string" }, "artifacts": { "items": { "additionalProperties": true, "type": "object" }, "title": "Artifacts", "type": "array" }, "citations": { "items": { "additionalProperties": true, "type": "object" }, "title": "Citations", "type": "array" }, "sources": { "items": { "additionalProperties": true, "type": "object" }, "title": "Sources", "type": "array" }, "summary": { "default": "", "title": "Summary", "type": "string" }, "thread_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Thread Id" }, "title": { "minLength": 1, "title": "Title", "type": "string" }, "visibility": { "$ref": "#/components/schemas/PageVisibility", "default": "tenant" } }, "required": [ "title", "answer_markdown" ], "title": "SpacePageCreatePayload", "type": "object" }, "SpaceResponse": { "additionalProperties": true, "properties": { "collaborators": { "items": { "$ref": "#/components/schemas/SpaceCollaborator" }, "title": "Collaborators", "type": "array" }, "created_at": { "title": "Created At", "type": "string" }, "description": { "title": "Description", "type": "string" }, "files": { "items": { "$ref": "#/components/schemas/SpaceFile" }, "title": "Files", "type": "array" }, "id": { "title": "Id", "type": "string" }, "instructions": { "title": "Instructions", "type": "string" }, "model_prefs": { "$ref": "#/components/schemas/ModelPreferences" }, "name": { "title": "Name", "type": "string" }, "owner_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner Id" }, "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" }, "updated_at": { "title": "Updated At", "type": "string" }, "visibility": { "title": "Visibility", "type": "string" } }, "required": [ "id", "tenant_id", "owner_id", "name", "description", "instructions", "visibility", "collaborators", "files", "model_prefs", "tags", "created_at", "updated_at" ], "title": "SpaceResponse", "type": "object" }, "SpaceSearchPayload": { "properties": { "match_threshold": { "default": 0.5, "maximum": 1.0, "minimum": 0.0, "title": "Match Threshold", "type": "number" }, "max_results": { "default": 10, "exclusiveMinimum": 0.0, "maximum": 50.0, "title": "Max Results", "type": "integer" }, "query": { "maxLength": 8000, "minLength": 1, "title": "Query", "type": "string" } }, "required": [ "query" ], "title": "SpaceSearchPayload", "type": "object" }, "SpaceSearchResponse": { "additionalProperties": true, "properties": { "embedding_model": { "title": "Embedding Model", "type": "string" }, "results": { "items": { "additionalProperties": true, "type": "object" }, "title": "Results", "type": "array" }, "space_id": { "title": "Space Id", "type": "string" } }, "required": [ "results", "embedding_model", "space_id" ], "title": "SpaceSearchResponse", "type": "object" }, "SpaceVisibility": { "description": "Who can read the Space without being an explicit collaborator.", "enum": [ "private", "tenant", "public" ], "title": "SpaceVisibility", "type": "string" }, "SpendAccounting": { "additionalProperties": true, "properties": { "accounting_basis": { "const": "provider_expenditure", "title": "Accounting Basis", "type": "string" }, "currency": { "const": "USD", "title": "Currency", "type": "string" }, "customer_charges_usd": { "title": "Customer Charges Usd", "type": "string" }, "opening_confirmed": { "title": "Opening Confirmed", "type": "boolean" }, "provider_actual_usd": { "title": "Provider Actual Usd", "type": "string" }, "provider_provisional_usd": { "title": "Provider Provisional Usd", "type": "string" }, "reserved_usd": { "title": "Reserved Usd", "type": "string" }, "unresolved_attempts": { "title": "Unresolved Attempts", "type": "integer" } }, "required": [ "accounting_basis", "currency", "opening_confirmed", "provider_actual_usd", "provider_provisional_usd", "reserved_usd", "unresolved_attempts", "customer_charges_usd" ], "title": "SpendAccounting", "type": "object" }, "SpendResponse": { "additionalProperties": true, "properties": { "accounting": { "anyOf": [ { "$ref": "#/components/schemas/SpendAccounting" }, { "type": "null" } ] }, "breakdown": { "additionalProperties": { "type": "number" }, "title": "Breakdown", "type": "object" }, "since": { "title": "Since", "type": "string" }, "tenant_id": { "title": "Tenant Id", "type": "string" }, "total_cost_usd": { "title": "Total Cost Usd", "type": "number" }, "until": { "title": "Until", "type": "string" } }, "required": [ "tenant_id", "since", "until", "total_cost_usd", "breakdown" ], "title": "SpendResponse", "type": "object" }, "StageTiming": { "additionalProperties": false, "properties": { "calls": { "minimum": 0.0, "title": "Calls", "type": "integer" }, "errors": { "minimum": 0.0, "title": "Errors", "type": "integer" }, "milliseconds": { "minimum": 0.0, "title": "Milliseconds", "type": "number" }, "stage": { "title": "Stage", "type": "string" } }, "required": [ "stage", "calls", "milliseconds", "errors" ], "title": "StageTiming", "type": "object" }, "StartRunBody": { "properties": { "best_of_n": { "default": false, "description": "When True, run the prompt across multiple models in isolated worktrees.", "title": "Best Of N", "type": "boolean" }, "best_of_n_models": { "description": "Optional model list for best-of-n (defaults to BEST_OF_N_DEFAULT_MODELS).", "items": { "type": "string" }, "title": "Best Of N Models", "type": "array" }, "deadline_seconds": { "default": 3600, "maximum": 86400.0, "minimum": 1.0, "title": "Deadline Seconds", "type": "integer" }, "durable_temporal": { "default": false, "description": "When True, execution runs on Temporal workers (SSE via shared buffer).", "title": "Durable Temporal", "type": "boolean" }, "enable_tool_approval": { "default": false, "title": "Enable Tool Approval", "type": "boolean" }, "external_tools": { "items": { "$ref": "#/components/schemas/ExternalToolDefinition" }, "maxItems": 16, "title": "External Tools", "type": "array" }, "intake_surface": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "description": "Optional intake origin badge (e.g. web) persisted on run meta.", "title": "Intake Surface" }, "mode": { "anyOf": [ { "$ref": "#/components/schemas/AgentRunMode" }, { "type": "null" } ], "default": "pro", "description": "User mode: agent | ask | plan | debug (legacy: quick | pro | deep)" }, "prompt": { "maxLength": 32000, "minLength": 1, "title": "Prompt", "type": "string" }, "registered_tools": { "items": { "$ref": "#/components/schemas/ToolReference" }, "maxItems": 16, "title": "Registered Tools", "type": "array" }, "response_mode": { "default": "stream", "enum": [ "stream", "receipt" ], "title": "Response Mode", "type": "string" }, "rules": { "items": { "type": "string" }, "title": "Rules", "type": "array" }, "skills": { "items": { "type": "string" }, "title": "Skills", "type": "array" }, "space_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Space Id" }, "workspace_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, "required": [ "prompt" ], "title": "StartRunBody", "type": "object" }, "StreamOptions": { "additionalProperties": false, "properties": { "include_usage": { "default": false, "title": "Include Usage", "type": "boolean" } }, "title": "StreamOptions", "type": "object" }, "StreamingConfig": { "description": "Configuration for streaming context from third-party endpoints.\n\nPhase 6 of the Federated Context Gateway. Enables incremental\ncontext delivery for lower time-to-first-token.\n\nBenefits:\n- Lower latency: Start processing before all context arrives\n- Better UX: Show progress as context streams in\n- Resilience: Partial results if connection drops", "examples": [ { "endpoints": [ { "auth": { "credentials": "token1", "type": "bearer" }, "endpoint": "https://blackink.io/context/stream", "mode": "sse", "name": "blackink" }, { "auth": { "credentials": "key1", "type": "api_key" }, "endpoint": "https://routeroyal.com/context/stream", "mode": "ndjson", "name": "routeroyal" } ], "max_total_chunks": 100, "parallel_streams": true } ], "properties": { "enable_circuit_breaker": { "default": true, "description": "Enable circuit breaker for streaming endpoints", "title": "Enable Circuit Breaker", "type": "boolean" }, "endpoints": { "description": "List of streaming endpoints to query", "items": { "$ref": "#/components/schemas/StreamingEndpointConfig" }, "title": "Endpoints", "type": "array" }, "max_total_chunks": { "default": 100, "description": "Maximum total chunks across all sources", "maximum": 500.0, "minimum": 1.0, "title": "Max Total Chunks", "type": "integer" }, "max_total_tokens": { "default": 200000, "description": "Maximum total tokens across all sources", "maximum": 1000000.0, "minimum": 1000.0, "title": "Max Total Tokens", "type": "integer" }, "parallel_streams": { "default": true, "description": "Stream from endpoints in parallel (faster) or sequentially", "title": "Parallel Streams", "type": "boolean" } }, "title": "StreamingConfig", "type": "object" }, "StreamingEndpointConfig": { "description": "Configuration for a single streaming context endpoint.\n\nPhase 6 of the Federated Context Gateway. Third parties stream\ncontext chunks incrementally, allowing Q to start processing\nbefore all context has arrived for lower time-to-first-token.", "examples": [ { "auth": { "credentials": "token", "type": "bearer" }, "endpoint": "https://blackink.io/context/stream", "max_chunks": 50, "mode": "sse", "name": "blackink-stream", "scopes": [ "documents", "tasks" ], "total_timeout_ms": 60000 } ], "properties": { "auth": { "$ref": "#/components/schemas/AuthConfig", "description": "Authentication configuration" }, "connect_timeout_ms": { "default": 5000, "description": "Connection timeout in milliseconds", "maximum": 30000.0, "minimum": 100.0, "title": "Connect Timeout Ms", "type": "integer" }, "endpoint": { "description": "URL of the streaming endpoint (e.g., https://blackink.io/context/stream)", "title": "Endpoint", "type": "string" }, "extra_headers": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "description": "Additional HTTP headers to include", "title": "Extra Headers" }, "max_chunks": { "default": 50, "description": "Maximum chunks to receive from this source", "maximum": 200.0, "minimum": 1.0, "title": "Max Chunks", "type": "integer" }, "max_tokens": { "default": 100000, "description": "Maximum tokens to receive from this source", "maximum": 500000.0, "minimum": 1000.0, "title": "Max Tokens", "type": "integer" }, "mode": { "$ref": "#/components/schemas/StreamingMode", "default": "sse", "description": "Streaming protocol mode" }, "name": { "description": "Human-readable name for this streaming source", "title": "Name", "type": "string" }, "read_timeout_ms": { "default": 30000, "description": "Per-chunk read timeout in milliseconds", "maximum": 120000.0, "minimum": 1000.0, "title": "Read Timeout Ms", "type": "integer" }, "scopes": { "description": "Optional scope filters for the context stream", "items": { "type": "string" }, "title": "Scopes", "type": "array" }, "total_timeout_ms": { "default": 60000, "description": "Total stream duration timeout in milliseconds", "maximum": 300000.0, "minimum": 5000.0, "title": "Total Timeout Ms", "type": "integer" } }, "required": [ "name", "endpoint", "auth" ], "title": "StreamingEndpointConfig", "type": "object" }, "StreamingMode": { "description": "Streaming protocol modes for context delivery.", "enum": [ "sse", "ndjson", "chunked" ], "title": "StreamingMode", "type": "string" }, "StructuredOutput": { "properties": { "attempts": { "default": 0, "maximum": 3, "minimum": 0, "title": "Attempts", "type": "integer" }, "error_code": { "anyOf": [ { "enum": [ "structured_output_invalid", "structured_output_unavailable", "evidence_unavailable" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Error Code" }, "status": { "default": "not_requested", "enum": [ "not_requested", "valid", "failed" ], "title": "Status", "type": "string" }, "value": { "default": null, "title": "Value" } }, "title": "StructuredOutput", "type": "object" }, "SubscribeRequest": { "properties": { "price_id": { "minLength": 1, "title": "Price Id", "type": "string" }, "quantity": { "default": 1, "minimum": 1.0, "title": "Quantity", "type": "integer" } }, "required": [ "price_id" ], "title": "SubscribeRequest", "type": "object" }, "SubscriptionResponse": { "properties": { "subscription": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Subscription" }, "tenant_id": { "title": "Tenant Id", "type": "string" } }, "required": [ "tenant_id" ], "title": "SubscriptionResponse", "type": "object" }, "SyncDocument": { "additionalProperties": false, "properties": { "document_id": { "format": "uuid", "title": "Document Id", "type": "string" }, "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Code" }, "last_indexed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Last Indexed At" }, "publication_lag_ms": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Publication Lag Ms" }, "revision": { "title": "Revision", "type": "integer" }, "state": { "enum": [ "queued", "processing", "ready", "failed", "deleted", "superseded" ], "title": "State", "type": "string" } }, "required": [ "document_id", "revision", "state" ], "title": "SyncDocument", "type": "object" }, "SyncPage": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/SyncReceipt" }, "title": "Items", "type": "array" }, "next_after": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Next After" } }, "required": [ "items" ], "title": "SyncPage", "type": "object" }, "SyncReceipt": { "additionalProperties": false, "properties": { "batch_id": { "format": "uuid", "title": "Batch Id", "type": "string" }, "checkpoint": { "title": "Checkpoint", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "documents": { "items": { "$ref": "#/components/schemas/SyncDocument" }, "title": "Documents", "type": "array" }, "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Code" }, "extension_id": { "format": "uuid", "title": "Extension Id", "type": "string" }, "retry_after_seconds": { "default": 0, "title": "Retry After Seconds", "type": "integer" }, "revision": { "title": "Revision", "type": "integer" }, "state": { "enum": [ "queued", "dispatched", "indexed", "failed", "revoked", "superseded" ], "title": "State", "type": "string" } }, "required": [ "batch_id", "extension_id", "revision", "state", "checkpoint", "documents", "created_at" ], "title": "SyncReceipt", "type": "object" }, "SyncTriggerBody": { "properties": { "options": { "additionalProperties": true, "title": "Options", "type": "object" }, "space_id": { "minLength": 1, "title": "Space Id", "type": "string" } }, "required": [ "space_id" ], "title": "SyncTriggerBody", "type": "object" }, "TaskRequest": { "description": "Standardised task delegation.", "properties": { "agentId": { "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", "title": "Agentid", "type": "string" }, "contextId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Contextid" }, "input": { "additionalProperties": true, "title": "Input", "type": "object" }, "metadata": { "additionalProperties": true, "title": "Metadata", "type": "object" }, "taskId": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9_.:-]+$", "title": "Taskid", "type": "string" } }, "required": [ "agentId", "taskId" ], "title": "TaskRequest", "type": "object" }, "TaskResponse": { "properties": { "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "result": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Result" }, "status": { "title": "Status", "type": "string" }, "taskId": { "title": "Taskid", "type": "string" } }, "required": [ "taskId", "status" ], "title": "TaskResponse", "type": "object" }, "TenantHealth": { "additionalProperties": true, "properties": { "answer_engine_streams": { "additionalProperties": true, "title": "Answer Engine Streams", "type": "object" }, "as_of": { "title": "As Of", "type": "string" }, "budget_utilisation": { "additionalProperties": true, "title": "Budget Utilisation", "type": "object" }, "mcp_tool_success": { "additionalProperties": true, "title": "Mcp Tool Success", "type": "object" }, "retrieval_callback_latency": { "additionalProperties": true, "title": "Retrieval Callback Latency", "type": "object" }, "tenant_id": { "title": "Tenant Id", "type": "string" }, "window_hours": { "title": "Window Hours", "type": "integer" } }, "required": [ "tenant_id", "window_hours", "as_of", "retrieval_callback_latency", "mcp_tool_success", "answer_engine_streams", "budget_utilisation" ], "title": "TenantHealth", "type": "object" }, "ToolApprovalBody": { "properties": { "action_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action Version" }, "approved": { "title": "Approved", "type": "boolean" }, "reason": { "default": "", "title": "Reason", "type": "string" } }, "required": [ "approved" ], "title": "ToolApprovalBody", "type": "object" }, "ToolApprovalPayload": { "properties": { "action_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action Version" }, "approved": { "title": "Approved", "type": "boolean" }, "reason": { "default": "", "title": "Reason", "type": "string" } }, "required": [ "approved" ], "title": "ToolApprovalPayload", "type": "object" }, "ToolPackage": { "additionalProperties": false, "properties": { "approval": { "default": "required", "enum": [ "none", "required" ], "title": "Approval", "type": "string" }, "effect": { "enum": [ "read", "write", "execute" ], "title": "Effect", "type": "string" }, "input_schema": { "additionalProperties": true, "title": "Input Schema", "type": "object" }, "output_schema": { "additionalProperties": true, "title": "Output Schema", "type": "object" } }, "required": [ "effect", "input_schema", "output_schema" ], "title": "ToolPackage", "type": "object" }, "ToolReference": { "additionalProperties": false, "properties": { "extension_id": { "format": "uuid", "title": "Extension Id", "type": "string" }, "revision": { "minimum": 1.0, "title": "Revision", "type": "integer" }, "version": { "maxLength": 32, "minLength": 1, "title": "Version", "type": "string" } }, "required": [ "extension_id", "version", "revision" ], "title": "ToolReference", "type": "object" }, "TradingAnalysisRequest": { "description": "API payload for the Trading Analyst.", "properties": { "instruments": { "description": "Tickers / symbols / pairs in scope (e.g. ['EURUSD', 'AAPL']).", "items": { "type": "string" }, "title": "Instruments", "type": "array" }, "market": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Asset class or venue, e.g. fx, equities, crypto, cfd.", "title": "Market" }, "news": { "description": "Optional caller-supplied news to summarise. Q does not fetch market data.", "items": { "$ref": "#/components/schemas/NewsItem" }, "title": "News", "type": "array" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Free-form context (strategy, constraints, risk appetite).", "title": "Notes" }, "positions": { "description": "Optional open positions for portfolio risk assessment.", "items": { "$ref": "#/components/schemas/PositionInput" }, "title": "Positions", "type": "array" }, "risk_appetite": { "default": "medium", "pattern": "^(low|medium|high)$", "title": "Risk Appetite", "type": "string" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" }, "timeframe": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Analysis horizon, e.g. intraday, swing, position.", "title": "Timeframe" } }, "title": "TradingAnalysisRequest", "type": "object" }, "TradingAnalysisResponse": { "description": "Structured, advisory-only output from the Trading Analyst.", "properties": { "disclaimer": { "default": "Advisory analysis only. Not financial advice and not a trade instruction. Execution decisions remain with the calling system.", "title": "Disclaimer", "type": "string" }, "input_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Input Tokens" }, "model_used": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Used" }, "news_summaries": { "items": { "$ref": "#/components/schemas/NewsSummary" }, "title": "News Summaries", "type": "array" }, "output_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Output Tokens" }, "overview": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "One-paragraph read of the current setup.", "title": "Overview" }, "parsing_warnings": { "items": { "type": "string" }, "title": "Parsing Warnings", "type": "array" }, "regulatory_watch": { "items": { "$ref": "#/components/schemas/RegulatoryItem" }, "title": "Regulatory Watch", "type": "array" }, "risk_assessment": { "items": { "$ref": "#/components/schemas/RiskAssessment" }, "title": "Risk Assessment", "type": "array" }, "sentiment": { "items": { "$ref": "#/components/schemas/SentimentSignal" }, "title": "Sentiment", "type": "array" } }, "title": "TradingAnalysisResponse", "type": "object" }, "UnifiedErrorEnvelope": { "properties": { "error": { "$ref": "#/components/schemas/ErrorBody" } }, "required": [ "error" ], "title": "UnifiedErrorEnvelope", "type": "object" }, "UsageBucket": { "additionalProperties": true, "properties": { "bucket": { "title": "Bucket", "type": "string" }, "completion_tokens": { "title": "Completion Tokens", "type": "integer" }, "cost_usd": { "title": "Cost Usd", "type": "number" }, "prompt_tokens": { "title": "Prompt Tokens", "type": "integer" }, "requests": { "title": "Requests", "type": "integer" }, "search_results": { "title": "Search Results", "type": "integer" } }, "required": [ "bucket", "prompt_tokens", "completion_tokens", "requests", "search_results", "cost_usd" ], "title": "UsageBucket", "type": "object" }, "UsageByModel": { "description": "Usage breakdown by model.", "properties": { "model": { "title": "Model", "type": "string" }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" }, "request_count": { "title": "Request Count", "type": "integer" }, "total_cost": { "title": "Total Cost", "type": "number" }, "total_input_tokens": { "title": "Total Input Tokens", "type": "integer" }, "total_output_tokens": { "title": "Total Output Tokens", "type": "integer" } }, "required": [ "model", "provider", "total_input_tokens", "total_output_tokens", "total_cost", "request_count" ], "title": "UsageByModel", "type": "object" }, "UsageByTag": { "description": "Usage breakdown by tag.", "properties": { "request_count": { "title": "Request Count", "type": "integer" }, "tag": { "title": "Tag", "type": "string" }, "total_cost": { "title": "Total Cost", "type": "number" }, "total_input_tokens": { "title": "Total Input Tokens", "type": "integer" }, "total_output_tokens": { "title": "Total Output Tokens", "type": "integer" } }, "required": [ "tag", "total_input_tokens", "total_output_tokens", "total_cost", "request_count" ], "title": "UsageByTag", "type": "object" }, "UsageInfo": { "description": "Token usage information.", "properties": { "completion_tokens": { "title": "Completion Tokens", "type": "integer" }, "prompt_tokens": { "title": "Prompt Tokens", "type": "integer" }, "total_tokens": { "title": "Total Tokens", "type": "integer" } }, "required": [ "prompt_tokens", "completion_tokens", "total_tokens" ], "title": "UsageInfo", "type": "object" }, "UsageRecord_Response": { "properties": { "attribution_context": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Attribution Context" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "estimated_cost": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Estimated Cost" }, "id": { "title": "Id", "type": "integer" }, "input_tokens": { "title": "Input Tokens", "type": "integer" }, "model": { "title": "Model", "type": "string" }, "output_tokens": { "title": "Output Tokens", "type": "integer" }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "tenant_id": { "title": "Tenant Id", "type": "string" }, "total_tokens": { "title": "Total Tokens", "type": "integer" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id" } }, "required": [ "id", "tenant_id", "user_id", "model", "provider", "tags", "input_tokens", "output_tokens", "total_tokens", "estimated_cost", "created_at" ], "title": "UsageRecord_Response", "type": "object" }, "UsageSummary": { "description": "Summary of usage for a client/organisation.", "properties": { "record_count": { "title": "Record Count", "type": "integer" }, "tenant_id": { "title": "Tenant Id", "type": "string" }, "total_cost": { "title": "Total Cost", "type": "number" }, "total_input_tokens": { "title": "Total Input Tokens", "type": "integer" }, "total_output_tokens": { "title": "Total Output Tokens", "type": "integer" }, "total_tokens": { "title": "Total Tokens", "type": "integer" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id" } }, "required": [ "tenant_id", "total_input_tokens", "total_output_tokens", "total_tokens", "total_cost", "record_count" ], "title": "UsageSummary", "type": "object" }, "UsageTotals": { "additionalProperties": true, "properties": { "cost_usd": { "title": "Cost Usd", "type": "number" }, "requests": { "title": "Requests", "type": "integer" } }, "required": [ "cost_usd", "requests" ], "title": "UsageTotals", "type": "object" }, "UserBudget": { "additionalProperties": true, "properties": { "allowed": { "title": "Allowed", "type": "boolean" }, "daily_budget_usd": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Daily Budget Usd" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "spend_today_usd": { "title": "Spend Today Usd", "type": "number" }, "tenant_id": { "title": "Tenant Id", "type": "string" }, "user_id": { "title": "User Id", "type": "string" } }, "required": [ "tenant_id", "user_id", "allowed", "spend_today_usd", "daily_budget_usd", "reason" ], "title": "UserBudget", "type": "object" }, "ValidationIssue": { "properties": { "code": { "title": "Code", "type": "string" }, "location": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "title": "Location", "type": "array" } }, "required": [ "location", "code" ], "title": "ValidationIssue", "type": "object" }, "ValidationReceipt": { "additionalProperties": false, "properties": { "approval": { "enum": [ "none", "required" ], "title": "Approval", "type": "string" }, "digest": { "title": "Digest", "type": "string" }, "execution": { "enum": [ "developer_host", "instructions_only" ], "title": "Execution", "type": "string" }, "valid": { "const": true, "default": true, "title": "Valid", "type": "boolean" } }, "required": [ "digest", "execution", "approval" ], "title": "ValidationReceipt", "type": "object" }, "VerifiedClaim": { "properties": { "backend": { "default": "none", "title": "Backend", "type": "string" }, "claim_text": { "title": "Claim Text", "type": "string" }, "confidence": { "default": 0, "maximum": 1, "minimum": 0, "title": "Confidence", "type": "number" }, "passages": { "items": { "$ref": "#/components/schemas/PassageVerdict" }, "title": "Passages", "type": "array" }, "passed": { "default": false, "title": "Passed", "type": "boolean" }, "position_end": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Position End" }, "position_start": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Position Start" }, "reason": { "default": "not_checked", "title": "Reason", "type": "string" }, "source_indexes": { "items": { "type": "integer" }, "title": "Source Indexes", "type": "array" }, "verdict": { "default": "unknown", "enum": [ "supported", "contradicted", "unsupported", "unknown" ], "title": "Verdict", "type": "string" } }, "required": [ "claim_text", "source_indexes" ], "title": "VerifiedClaim", "type": "object" }, "WebhookCreate": { "properties": { "active": { "default": true, "title": "Active", "type": "boolean" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "events": { "items": { "type": "string" }, "minItems": 1, "title": "Events", "type": "array" }, "url": { "maxLength": 2048, "minLength": 8, "title": "Url", "type": "string" } }, "required": [ "url", "events" ], "title": "WebhookCreate", "type": "object" }, "WebhookDeliveries": { "additionalProperties": true, "properties": { "deliveries": { "items": { "$ref": "#/components/schemas/WebhookDelivery" }, "title": "Deliveries", "type": "array" }, "webhook_id": { "title": "Webhook Id", "type": "string" } }, "required": [ "webhook_id", "deliveries" ], "title": "WebhookDeliveries", "type": "object" }, "WebhookDelivery": { "additionalProperties": true, "properties": { "attempt_count": { "title": "Attempt Count", "type": "integer" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "delivered_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Delivered At" }, "delivery_version": { "default": 1, "title": "Delivery Version", "type": "integer" }, "event_id": { "title": "Event Id", "type": "string" }, "event_type": { "title": "Event Type", "type": "string" }, "http_status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Http Status" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "last_error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Error" }, "lease_until": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lease Until" }, "next_retry_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Retry At" }, "replay_count": { "default": 0, "title": "Replay Count", "type": "integer" }, "status": { "title": "Status", "type": "string" } }, "required": [ "event_id", "event_type", "status", "http_status", "attempt_count", "created_at" ], "title": "WebhookDelivery", "type": "object" }, "WebhookPage": { "properties": { "data": { "items": { "$ref": "#/components/schemas/WebhookResponse" }, "title": "Data", "type": "array" }, "has_more": { "title": "Has More", "type": "boolean" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "previous_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous Cursor" }, "supported_events": { "items": { "type": "string" }, "title": "Supported Events", "type": "array" } }, "required": [ "data", "has_more", "supported_events" ], "title": "WebhookPage", "type": "object" }, "WebhookResponse": { "additionalProperties": true, "properties": { "active": { "title": "Active", "type": "boolean" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "description": { "title": "Description", "type": "string" }, "events": { "items": { "type": "string" }, "title": "Events", "type": "array" }, "id": { "title": "Id", "type": "string" }, "secret": { "title": "Secret", "type": "string" }, "tenant_id": { "title": "Tenant Id", "type": "string" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "url": { "title": "Url", "type": "string" } }, "required": [ "id", "tenant_id", "url", "events", "description", "active", "secret", "created_at", "updated_at" ], "title": "WebhookResponse", "type": "object" }, "WebhookTest": { "additionalProperties": true, "properties": { "attempt_count": { "title": "Attempt Count", "type": "integer" }, "event_id": { "title": "Event Id", "type": "string" }, "http_status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Http Status" }, "status": { "title": "Status", "type": "string" }, "success": { "title": "Success", "type": "boolean" } }, "required": [ "success", "http_status", "status", "event_id", "attempt_count" ], "title": "WebhookTest", "type": "object" }, "WebhookUpdate": { "properties": { "active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Active" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "events": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Events" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" } }, "title": "WebhookUpdate", "type": "object" }, "WorkspaceFiles": { "additionalProperties": true, "properties": { "files": { "items": { "type": "string" }, "title": "Files", "type": "array" } }, "required": [ "files" ], "title": "WorkspaceFiles", "type": "object" }, "WorkspaceInfo": { "properties": { "execution_enabled": { "title": "Execution Enabled", "type": "boolean" }, "label": { "title": "Label", "type": "string" }, "workspace_id": { "title": "Workspace Id", "type": "string" } }, "required": [ "workspace_id", "label", "execution_enabled" ], "title": "WorkspaceInfo", "type": "object" }, "WorkspaceList": { "properties": { "workspaces": { "items": { "$ref": "#/components/schemas/WorkspaceInfo" }, "title": "Workspaces", "type": "array" } }, "required": [ "workspaces" ], "title": "WorkspaceList", "type": "object" }, "WriteFile": { "additionalProperties": false, "properties": { "content": { "maxLength": 1000000, "title": "Content", "type": "string" } }, "required": [ "content" ], "title": "WriteFile", "type": "object" }, "app__api__completions__ChatMessage": { "description": "A single message in the conversation.", "properties": { "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Message content (text or null for tool calls)", "title": "Content" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional name for the message author", "title": "Name" }, "role": { "description": "Role: system, developer, user, assistant or tool", "title": "Role", "type": "string" }, "tool_call_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ID of the tool call this message responds to", "title": "Tool Call Id" }, "tool_calls": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "Tool calls made by the assistant", "title": "Tool Calls" } }, "required": [ "role" ], "title": "ChatMessage", "type": "object" }, "app__api__memory__MemoryCreate": { "properties": { "category": { "default": "fact", "title": "Category", "type": "string" }, "confidence": { "default": 1.0, "title": "Confidence", "type": "number" }, "content": { "maxLength": 500, "minLength": 1, "title": "Content", "type": "string" }, "metadata": { "additionalProperties": true, "title": "Metadata", "type": "object" }, "pinned": { "default": false, "title": "Pinned", "type": "boolean" } }, "required": [ "content" ], "title": "MemoryCreate", "type": "object" }, "app__api__public_embeddings__EmbeddingsRequest": { "properties": { "dimensions": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Dimensions" }, "encoding_format": { "const": "float", "default": "float", "title": "Encoding Format", "type": "string" }, "input": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ], "title": "Input" }, "input_type": { "default": "document", "enum": [ "query", "document" ], "title": "Input Type", "type": "string" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Embedding model identifier. Defaults to the tenant / system preference if omitted.", "title": "Model" }, "purpose": { "default": "default", "title": "Purpose", "type": "string" }, "user": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User" } }, "required": [ "input" ], "title": "EmbeddingsRequest", "type": "object" }, "app__api__public_embeddings__EmbeddingsResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/EmbeddingItem" }, "title": "Data", "type": "array" }, "model": { "title": "Model", "type": "string" }, "object": { "default": "list", "title": "Object", "type": "string" }, "usage": { "$ref": "#/components/schemas/EmbeddingsUsage" } }, "required": [ "data", "model", "usage" ], "title": "EmbeddingsResponse", "type": "object" }, "app__models__context_schemas__AuthType": { "description": "Authentication types for Pull/MCP endpoints.", "enum": [ "bearer", "api_key", "basic", "oauth2", "none" ], "title": "AuthType", "type": "string" }, "app__models__mcp_schemas__AuthType": { "description": "Supported MCP authentication types.", "enum": [ "none", "bearer", "basic", "api_key" ], "title": "AuthType", "type": "string" }, "app__models__mcp_schemas__ChatMessage": { "description": "Chat message for completions.", "properties": { "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "role": { "enum": [ "system", "user", "assistant", "tool" ], "title": "Role", "type": "string" }, "tool_call_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tool Call Id" }, "tool_calls": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Tool Calls" } }, "required": [ "role" ], "title": "ChatMessage", "type": "object" }, "app__models__mcp_schemas__McpServerListResponse": { "description": "Response schema for listing MCP servers.", "properties": { "servers": { "items": { "$ref": "#/components/schemas/McpServerResponse" }, "title": "Servers", "type": "array" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "servers", "total" ], "title": "McpServerListResponse", "type": "object" } }, "securitySchemes": { "BearerAuth": { "description": "API key authentication. Use a live key or a sandbox key prefixed with `q_test_` for Try-It requests in this reference.", "scheme": "bearer", "type": "http" } } }, "info": { "description": "A microservice for AI-powered data processing and reasoning.", "title": "Q Division Cognitive Engine", "version": "1.0.0", "x-capability-registry": { "url": "/v1/capabilities", "version": "2026-10-12.1" }, "x-ratelimit": { "auth": { "requests": 20, "window_seconds": 60 }, "default": { "requests": 120, "window_seconds": 60 }, "embeddings": { "burst": 200, "requests": 600, "window_seconds": 60 }, "test_key": { "requests": 20, "window_seconds": 60 } }, "x-ratelimit-headers": [ "X-RateLimit-Limit", "X-RateLimit-Remaining", "X-RateLimit-Reset", "Retry-After" ], "x-sdk": { "cli-package": "@getq/cli", "python-package": "getq", "react-package": "@getq/embed", "typescript-package": "@getq/sdk" }, "x-stability-tiers": { "alpha": "Experimental, no backwards-compatibility guarantees", "beta": "May change with 30-day notice", "stable": "Breaking changes require 6-month deprecation notice" } }, "openapi": "3.1.0", "paths": { "/v1/a2a/.well-known/agent.json": { "get": { "operationId": "well_known_agent_card_v1_a2a__well_known_agent_json_get", "responses": { "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "410": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [], "summary": "Well Known Agent Card", "tags": [ "A2A Public" ], "x-q-capability": { "id": "GET /v1/a2a/.well-known/agent.json", "policy": { "audience": "public", "auth": "anonymous", "conditional_scopes": {}, "disabled_reason": "a2a_profile_migration_required", "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "stable", "tenant": "none", "user": "No user or tenant context." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "A2A Public", "A2A v1" ], "x-stability": "stable" }, "x-stability": "stable" }, "/v1/a2a/agents": { "get": { "operationId": "list_agents_v1_a2a_agents_get", "parameters": [ { "in": "query", "name": "capability", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Capability" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtocolAgents" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "410": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "List Agents", "tags": [ "A2A Public" ], "x-q-capability": { "id": "GET /v1/a2a/agents", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "a2a", "scopes": [ "a2a:read" ], "settings": [], "stability": "alpha", "tenant": "credential_or_validated_request", "user": "Tenant-scoped external agent registry and tasks; credential bindings and outbound policy apply." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "A2A Public", "A2A v1" ], "x-stability": "alpha" }, "post": { "operationId": "register_agent_endpoint_v1_a2a_agents_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentRegistration" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationResult" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "410": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Register Agent Endpoint", "tags": [ "A2A Public" ], "x-q-capability": { "id": "POST /v1/a2a/agents", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "a2a", "scopes": [ "a2a:write" ], "settings": [], "stability": "alpha", "tenant": "credential_or_validated_request", "user": "Tenant-scoped external agent registry and tasks; credential bindings and outbound policy apply." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "A2A Public", "A2A v1" ], "x-stability": "alpha" }, "x-stability": "alpha" }, "/v1/a2a/agents/{agent_id}": { "delete": { "operationId": "delete_agent_v1_a2a_agents__agent_id__delete", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "410": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Delete Agent", "tags": [ "A2A Public" ], "x-q-capability": { "id": "DELETE /v1/a2a/agents/{agent_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "a2a", "scopes": [ "a2a:write" ], "settings": [], "stability": "alpha", "tenant": "credential_or_validated_request", "user": "Tenant-scoped external agent registry and tasks; credential bindings and outbound policy apply." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "A2A Public", "A2A v1" ], "x-stability": "alpha" }, "x-stability": "alpha" }, "/v1/a2a/agents/{agent_id}/.well-known/agent-card.json": { "get": { "operationId": "standard_agent_card_v1_a2a_agents__agent_id___well_known_agent_card_json_get", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "format": "uuid", "title": "Agent Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentCard" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "410": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Standard Agent Card", "tags": [ "A2A Public" ], "x-q-capability": { "id": "GET /v1/a2a/agents/{agent_id}/.well-known/agent-card.json", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "agent_api" ], "reason": "", "scope_policy": "a2a", "scopes": [ "a2a:read", "ai:answer" ], "settings": [ "A2A_SERVER_PROFILE_ENABLED" ], "stability": "alpha", "tenant": "credential_or_validated_request", "user": "Principal-owned durable tasks; SendMessage, SendStreamingMessage and CancelTask require a2a:delegate plus ai:answer. Current workspace/evidence grants apply." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "A2A Public", "A2A v1" ], "x-stability": "alpha" }, "x-stability": "alpha" }, "/v1/a2a/agents/{agent_id}/rpc": { "post": { "operationId": "standard_rpc_v1_a2a_agents__agent_id__rpc_post", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "format": "uuid", "title": "Agent Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/A2A_A2ARequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/A2A_Result" }, { "$ref": "#/components/schemas/JsonRpcFailure" } ] } }, "text/event-stream": { "schema": { "type": "string" } } }, "description": "A2A result, protocol error or ordered SSE stream" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "410": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Standard Rpc", "tags": [ "A2A Public" ], "x-q-a2a": { "binding": "JSONRPC", "protocolVersion": "1.0", "pushNotifications": false, "taskRecovery": "GetTask or snapshot-first SubscribeToTask", "textOnly": true }, "x-q-capability": { "id": "POST /v1/a2a/agents/{agent_id}/rpc", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": { "SendMessage, SendStreamingMessage, CancelTask": "a2a:delegate, a2a:* or *", "read operations": "a2a:read, a2a:* or *" }, "disabled_reason": null, "features": [ "agent_api" ], "reason": "", "scope_policy": "a2a", "scopes": [ "ai:answer" ], "settings": [ "A2A_SERVER_PROFILE_ENABLED" ], "stability": "alpha", "tenant": "credential_or_validated_request", "user": "Principal-owned durable tasks; SendMessage, SendStreamingMessage and CancelTask require a2a:delegate plus ai:answer. Current workspace/evidence grants apply." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "A2A Public", "A2A v1" ], "x-stability": "alpha" }, "x-stability": "alpha" }, "/v1/a2a/tasks": { "post": { "operationId": "submit_task_v1_a2a_tasks_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "410": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Submit Task", "tags": [ "A2A Public" ], "x-q-capability": { "id": "POST /v1/a2a/tasks", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "a2a", "scopes": [ "a2a:delegate" ], "settings": [], "stability": "alpha", "tenant": "credential_or_validated_request", "user": "Tenant-scoped external agent registry and tasks; credential bindings and outbound policy apply." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "A2A Public", "A2A v1" ], "x-stability": "alpha" }, "x-stability": "alpha" }, "/v1/a2a/tasks/{task_id}": { "get": { "operationId": "get_task_result_v1_a2a_tasks__task_id__get", "parameters": [ { "in": "path", "name": "task_id", "required": true, "schema": { "format": "uuid", "title": "Task Id", "type": "string" } } ], "responses": { "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "410": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Task Result", "tags": [ "A2A Public" ], "x-q-capability": { "id": "GET /v1/a2a/tasks/{task_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": "a2a_profile_migration_required", "features": [], "reason": "", "scope_policy": "a2a", "scopes": [ "a2a:read" ], "settings": [], "stability": "alpha", "tenant": "credential_or_validated_request", "user": "Tenant-scoped external agent registry and tasks; credential bindings and outbound policy apply." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "A2A Public", "A2A v1" ], "x-stability": "alpha" }, "x-stability": "alpha" }, "/v1/agent/chat/completions": { "post": { "operationId": "agent_chat_v1_agent_chat_completions_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatCompletionResponse" } }, "text/event-stream": { "schema": { "type": "string" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "OpenAI-compatible chat completion passthrough (multi-provider)", "tags": [ "Agent API" ], "x-q-capability": { "id": "POST /v1/agent/chat/completions", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "agent_api" ], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:chat" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide; resource-specific permissions still apply." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "'/agent/chat/completions'", "source": "sdks/python/src/q_client/agent.py", "transport": "post_json" } ], "typescript": [ { "path": "\"/agent/chat/completions\"", "source": "sdks/typescript/src/client.ts", "transport": "postJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Agent API", "Agent API" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/agents": { "get": { "operationId": "public_list_agents_v1_agents_get", "parameters": [ { "in": "query", "name": "agent_type", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/AgentType" }, { "type": "null" } ], "title": "Agent Type" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/AgentSummary" }, "title": "Response Public List Agents V1 Agents Get", "type": "array" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "List agents (public API)", "tags": [ "Agents v2 Public" ], "x-q-capability": { "id": "GET /v1/agents", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "agent_api" ], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-scoped agent/run records; workspace grants and principal-bound approvals checked independently." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "'/agents'", "source": "sdks/python/src/q_client/agents_v2.py", "transport": "get_json" } ], "typescript": [ { "path": "\"/agents\"", "source": "sdks/typescript/src/agents.ts", "transport": "getJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Agents v2 Public", "Agents v2 Public" ], "x-stability": "beta" }, "post": { "operationId": "public_create_agent_v1_agents_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAgentBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentCreated" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Create agent (public API)", "tags": [ "Agents v2 Public" ], "x-q-capability": { "id": "POST /v1/agents", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "agent_api" ], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-scoped agent/run records; workspace grants and principal-bound approvals checked independently." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "'/agents'", "source": "sdks/python/src/q_client/agents_v2.py", "transport": "post_json" } ], "typescript": [ { "path": "\"/agents\"", "source": "sdks/typescript/src/agents.ts", "transport": "postJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Agents v2 Public", "Agents v2 Public" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/agents/execute": { "post": { "description": "Submit an agent execution via the unified contract.", "operationId": "execute_agent_v1_agents_execute_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentExecuteRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentExecuteResponse" } } }, "description": "Successful Response" }, "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentExecuteResponse" } } }, "description": "Accepted" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Execute Agent", "tags": [ "Agent Gateway" ], "x-q-capability": { "id": "POST /v1/agents/execute", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant and authenticated user/principal; delegated users require identity:delegate or *. Workspace grants and run approval ownership are checked separately." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Agent Gateway", "Agent Gateway" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/agents/executions/{execution_id}": { "delete": { "description": "Cancel a pending or running agent execution.", "operationId": "cancel_execution_v1_agents_executions__execution_id__delete", "parameters": [ { "in": "path", "name": "execution_id", "required": true, "schema": { "title": "Execution Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionCancellation" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Cancel Execution", "tags": [ "Agent Gateway" ], "x-q-capability": { "id": "DELETE /v1/agents/executions/{execution_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant and authenticated user/principal; delegated users require identity:delegate or *. Workspace grants and run approval ownership are checked separately." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Agent Gateway", "Agent Gateway" ], "x-stability": "beta" }, "get": { "description": "Poll agent execution status.", "operationId": "get_execution_v1_agents_executions__execution_id__get", "parameters": [ { "in": "path", "name": "execution_id", "required": true, "schema": { "title": "Execution Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentExecutionResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Execution", "tags": [ "Agent Gateway" ], "x-q-capability": { "id": "GET /v1/agents/executions/{execution_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant and authenticated user/principal; delegated users require identity:delegate or *. Workspace grants and run approval ownership are checked separately." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Agent Gateway", "Agent Gateway" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/agents/executions/{execution_id}/stream": { "get": { "description": "Stream agent execution events via SSE.", "operationId": "stream_execution_v1_agents_executions__execution_id__stream_get", "parameters": [ { "in": "path", "name": "execution_id", "required": true, "schema": { "title": "Execution Id", "type": "string" } } ], "responses": { "200": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Stream Execution", "tags": [ "Agent Gateway" ], "x-q-capability": { "id": "GET /v1/agents/executions/{execution_id}/stream", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant and authenticated user/principal; delegated users require identity:delegate or *. Workspace grants and run approval ownership are checked separately." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-sse-data": { "$ref": "#/components/schemas/ExecutionEventPayload" }, "x-q-tags": [ "Agent Gateway", "Agent Gateway" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/agents/trading-analyst/run": { "post": { "description": "Synthesises supplied market context (instruments, news, positions) into sentiment, news summaries, risk assessment, and regulatory watch items. Advisory only \u2014 never a trade instruction.", "operationId": "run_trading_analysis_v1_agents_trading_analyst_run_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TradingAnalysisRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TradingAnalysisResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Run advisory trading analysis", "tags": [ "Trading Analyst" ], "x-q-capability": { "id": "POST /v1/agents/trading-analyst/run", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant and authenticated user/principal; delegated users require identity:delegate or *. Workspace grants and run approval ownership are checked separately." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Trading Analyst", "Trading Analyst" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/agents/{agent_id}/best-of-n": { "post": { "operationId": "public_best_of_n_command_v1_agents__agent_id__best_of_n_post", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "format": "uuid", "title": "Agent Id", "type": "string" } }, { "in": "header", "name": "Last-Event-ID", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last-Event-Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BestOfNCommandBody" } } }, "required": true }, "responses": { "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Best-of-n SSE (public API)", "tags": [ "Agents v2 Public" ], "x-q-capability": { "id": "POST /v1/agents/{agent_id}/best-of-n", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": "Authenticated authorised requests return 503 workspace_operation_backend_unavailable; this backend is not implemented.", "features": [ "agent_api" ], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-scoped agent/run records; workspace grants and principal-bound approvals checked independently." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Agents v2 Public", "Agents v2 Public" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/agents/{agent_id}/multitask": { "post": { "operationId": "public_multitask_command_v1_agents__agent_id__multitask_post", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "format": "uuid", "title": "Agent Id", "type": "string" } }, { "in": "header", "name": "Last-Event-ID", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last-Event-Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultitaskBody" } } }, "required": true }, "responses": { "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Multitask SSE (public API)", "tags": [ "Agents v2 Public" ], "x-q-capability": { "id": "POST /v1/agents/{agent_id}/multitask", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": "Authenticated authorised requests return 503 workspace_operation_backend_unavailable; this backend is not implemented.", "features": [ "agent_api" ], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-scoped agent/run records; workspace grants and principal-bound approvals checked independently." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Agents v2 Public", "Agents v2 Public" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/agents/{agent_id}/runs": { "post": { "operationId": "public_start_run_v1_agents__agent_id__runs_post", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "format": "uuid", "title": "Agent Id", "type": "string" } }, { "in": "header", "name": "Last-Event-ID", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last-Event-Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartRunBody" } } }, "required": true }, "responses": { "200": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "Successful Response" }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentRunReceipt" } } }, "description": "Created" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Start run SSE (public API)", "tags": [ "Agents v2 Public" ], "x-q-agent-stream": { "condition": "lifecycle_version=2", "cursor": "run_id:sequence", "envelope": { "$ref": "#/components/schemas/AgentStreamEnvelope" }, "expiry": "run_deadline_plus_3600_seconds", "legacy": "unmanaged_runs_keep_unversioned_best_effort_events", "max_event_bytes": 262144, "max_retained_bytes": 8388608, "max_retained_events": 1024, "payloads": { "done": { "$ref": "#/components/schemas/AgentStreamDone" }, "revision": { "$ref": "#/components/schemas/AgentStreamRevision" } }, "replay": "same_principal_and_current_workspace_and_source_permissions", "replay_page_size": 16, "resume_method": "GET", "terminal_events": [ "done" ], "version": "1" }, "x-q-capability": { "id": "POST /v1/agents/{agent_id}/runs", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "agent_api" ], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-scoped agent/run records; workspace grants and principal-bound approvals checked independently." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Agents v2 Public", "Agents v2 Public" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/agents/{agent_id}/runs/best-of-n": { "post": { "operationId": "public_best_of_n_run_v1_agents__agent_id__runs_best_of_n_post", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "format": "uuid", "title": "Agent Id", "type": "string" } }, { "in": "header", "name": "Last-Event-ID", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last-Event-Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BestOfNCommandBody" } } }, "required": true }, "responses": { "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Best-of-n run SSE (public API)", "tags": [ "Agents v2 Public" ], "x-q-capability": { "id": "POST /v1/agents/{agent_id}/runs/best-of-n", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": "Authenticated authorised requests return 503 workspace_operation_backend_unavailable; this backend is not implemented.", "features": [ "agent_api" ], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-scoped agent/run records; workspace grants and principal-bound approvals checked independently." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Agents v2 Public", "Agents v2 Public" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/agents/{agent_id}/runs/{run_id}": { "get": { "operationId": "public_get_run_v1_agents__agent_id__runs__run_id__get", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "format": "uuid", "title": "Agent Id", "type": "string" } }, { "in": "path", "name": "run_id", "required": true, "schema": { "format": "uuid", "title": "Run Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentRunResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Get run (public API)", "tags": [ "Agents v2 Public" ], "x-q-capability": { "id": "GET /v1/agents/{agent_id}/runs/{run_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "agent_api" ], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-scoped agent/run records; workspace grants and principal-bound approvals checked independently." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "f\"/agents/{quote(agent_id, safe='')}/runs/{quote(run_id, safe='')}\"", "source": "sdks/python/src/q_client/agents_v2.py", "transport": "get_json" } ], "typescript": [ { "path": "`/agents/${encodeURIComponent(agentId)}/runs/${encodeURIComponent(runId)}`", "source": "sdks/typescript/src/agents.ts", "transport": "getJson" }, { "path": "`/agents/${encodeURIComponent(agentId)}/runs/${encodeURIComponent(runId)}`", "source": "sdks/typescript/src/agents.ts", "transport": "getJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Agents v2 Public", "Agents v2 Public" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/agents/{agent_id}/runs/{run_id}/cancel": { "post": { "operationId": "public_cancel_run_v1_agents__agent_id__runs__run_id__cancel_post", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "format": "uuid", "title": "Agent Id", "type": "string" } }, { "in": "path", "name": "run_id", "required": true, "schema": { "format": "uuid", "title": "Run Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelledResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Cancel durable run", "tags": [ "Agents v2 Public" ], "x-q-capability": { "id": "POST /v1/agents/{agent_id}/runs/{run_id}/cancel", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "agent_api" ], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-scoped agent/run records; workspace grants and principal-bound approvals checked independently." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Agents v2 Public", "Agents v2 Public" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/agents/{agent_id}/runs/{run_id}/diagnostics": { "get": { "operationId": "agent_run_diagnostics", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "format": "uuid", "title": "Agent Id", "type": "string" } }, { "in": "path", "name": "run_id", "required": true, "schema": { "format": "uuid", "title": "Run Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunDiagnostics" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Diagnose an owned durable run without source content", "tags": [ "Agents v2 Public" ], "x-q-capability": { "id": "GET /v1/agents/{agent_id}/runs/{run_id}/diagnostics", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "agent_api" ], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-scoped agent/run records; workspace grants and principal-bound approvals checked independently." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Agents v2 Public", "Agents v2 Public" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/agents/{agent_id}/runs/{run_id}/resume": { "post": { "operationId": "public_resume_run_v1_agents__agent_id__runs__run_id__resume_post", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "format": "uuid", "title": "Agent Id", "type": "string" } }, { "in": "path", "name": "run_id", "required": true, "schema": { "format": "uuid", "title": "Run Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResumeRunBody" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentRunReceipt" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Continue a durable run awaiting input", "tags": [ "Agents v2 Public" ], "x-q-capability": { "id": "POST /v1/agents/{agent_id}/runs/{run_id}/resume", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "agent_api" ], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-scoped agent/run records; workspace grants and principal-bound approvals checked independently." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "f\"/agents/{quote(agent_id, safe='')}/runs/{quote(run_id, safe='')}/resume\"", "source": "sdks/python/src/q_client/agents_v2.py", "transport": "post_json" } ], "typescript": [ { "path": "`/agents/${encodeURIComponent(agentId)}/runs/${encodeURIComponent(runId)}/resume`", "source": "sdks/typescript/src/agents.ts", "transport": "postJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Agents v2 Public", "Agents v2 Public" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/agents/{agent_id}/runs/{run_id}/stream": { "get": { "operationId": "public_stream_run_v1_agents__agent_id__runs__run_id__stream_get", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "format": "uuid", "title": "Agent Id", "type": "string" } }, { "in": "path", "name": "run_id", "required": true, "schema": { "format": "uuid", "title": "Run Id", "type": "string" } }, { "description": "Value from X-Stream-Key when the run was started", "in": "query", "name": "stream_key", "required": true, "schema": { "description": "Value from X-Stream-Key when the run was started", "title": "Stream Key", "type": "string" } }, { "in": "header", "name": "Last-Event-ID", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last-Event-Id" } } ], "responses": { "200": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "SSE stream (public API)", "tags": [ "Agents v2 Public" ], "x-q-agent-stream": { "condition": "lifecycle_version=2", "cursor": "run_id:sequence", "envelope": { "$ref": "#/components/schemas/AgentStreamEnvelope" }, "expiry": "run_deadline_plus_3600_seconds", "legacy": "unmanaged_runs_keep_unversioned_best_effort_events", "max_event_bytes": 262144, "max_retained_bytes": 8388608, "max_retained_events": 1024, "payloads": { "done": { "$ref": "#/components/schemas/AgentStreamDone" }, "revision": { "$ref": "#/components/schemas/AgentStreamRevision" } }, "replay": "same_principal_and_current_workspace_and_source_permissions", "replay_page_size": 16, "resume_method": "GET", "terminal_events": [ "done" ], "version": "1" }, "x-q-capability": { "id": "GET /v1/agents/{agent_id}/runs/{run_id}/stream", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "agent_api" ], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-scoped agent/run records; workspace grants and principal-bound approvals checked independently." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Agents v2 Public", "Agents v2 Public" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/agents/{agent_id}/runs/{run_id}/tool-approval/{approval_id}": { "post": { "operationId": "public_agent_tool_approval_v1_agents__agent_id__runs__run_id__tool_approval__approval_id__post", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "format": "uuid", "title": "Agent Id", "type": "string" } }, { "in": "path", "name": "run_id", "required": true, "schema": { "format": "uuid", "title": "Run Id", "type": "string" } }, { "in": "path", "name": "approval_id", "required": true, "schema": { "title": "Approval Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolApprovalBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovalDecision" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Decide a durable agent tool approval", "tags": [ "Agents v2 Public" ], "x-q-capability": { "id": "POST /v1/agents/{agent_id}/runs/{run_id}/tool-approval/{approval_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "agent_api" ], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-scoped agent/run records; workspace grants and principal-bound approvals checked independently." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Agents v2 Public", "Agents v2 Public" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/agents/{agent_id}/runs/{run_id}/tool-invocations": { "get": { "operationId": "public_tool_invocations_v1_agents__agent_id__runs__run_id__tool_invocations_get", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "format": "uuid", "title": "Agent Id", "type": "string" } }, { "in": "path", "name": "run_id", "required": true, "schema": { "format": "uuid", "title": "Run Id", "type": "string" } }, { "in": "query", "name": "after", "required": false, "schema": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "After" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvocationPage" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "List durable tool invocations", "tags": [ "Agents v2 Public" ], "x-q-capability": { "id": "GET /v1/agents/{agent_id}/runs/{run_id}/tool-invocations", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "agent_api" ], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-scoped agent/run records; workspace grants and principal-bound approvals checked independently." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "f\"/agents/{quote(agent_id, safe='')}/runs/{quote(run_id, safe='')}/tool-invocations\"", "source": "sdks/python/src/q_client/agents_v2.py", "transport": "get_json" } ], "typescript": [ { "path": "`/agents/${encodeURIComponent(agentId)}/runs/${encodeURIComponent(runId)}/tool-invocations`", "source": "sdks/typescript/src/agents.ts", "transport": "getJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Agents v2 Public", "Agents v2 Public" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/agents/{agent_id}/runs/{run_id}/tool-invocations/{invocation_id}/result": { "post": { "operationId": "public_submit_tool_result_v1_agents__agent_id__runs__run_id__tool_invocations__invocation_id__result_post", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "format": "uuid", "title": "Agent Id", "type": "string" } }, { "in": "path", "name": "run_id", "required": true, "schema": { "format": "uuid", "title": "Run Id", "type": "string" } }, { "in": "path", "name": "invocation_id", "required": true, "schema": { "format": "uuid", "title": "Invocation Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalToolResult" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvocationReceipt" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Submit a developer-hosted tool result", "tags": [ "Agents v2 Public" ], "x-q-capability": { "id": "POST /v1/agents/{agent_id}/runs/{run_id}/tool-invocations/{invocation_id}/result", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "agent_api" ], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-scoped agent/run records; workspace grants and principal-bound approvals checked independently." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "f\"/agents/{quote(agent_id, safe='')}/runs/{quote(run_id, safe='')}/tool-invocations/{quote(invocation_id, safe='')}/result\"", "source": "sdks/python/src/q_client/agents_v2.py", "transport": "post_json" } ], "typescript": [ { "path": "`/agents/${encodeURIComponent(agentId)}/runs/${encodeURIComponent(runId)}/tool-invocations/${encodeURIComponent(invocationId)}/result`", "source": "sdks/typescript/src/agents.ts", "transport": "postJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Agents v2 Public", "Agents v2 Public" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/ai/capabilities": { "get": { "operationId": "list_ai_capabilities_v1_ai_capabilities_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiCapabilities" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "List Ai Capabilities", "tags": [ "AI Services" ], "x-q-capability": { "id": "GET /v1/ai/capabilities", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "none", "user": "Authenticated discovery; readiness probes are operational checks, not resource access grants." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "AI Services", "AI Services" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/ai/capabilities/{capability}/readiness": { "get": { "operationId": "capability_readiness_v1_ai_capabilities__capability__readiness_get", "parameters": [ { "in": "path", "name": "capability", "required": true, "schema": { "enum": [ "generate_document", "edit_document", "generate_article", "generate_social_post", "deep_research", "pack_architect", "chat_with_tools" ], "title": "Capability", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CapabilityReadiness" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Capability Readiness", "tags": [ "AI Services" ], "x-q-capability": { "id": "GET /v1/ai/capabilities/{capability}/readiness", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "none", "user": "Authenticated discovery; readiness probes are operational checks, not resource access grants." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "AI Services", "AI Services" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/ai/jobs": { "post": { "operationId": "start_ai_job_v1_ai_jobs_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiJobStartRequest" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiJobReceipt" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Start Ai Job", "tags": [ "AI Services" ], "x-q-capability": { "id": "POST /v1/ai/jobs", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant and authenticated user/principal; delegated users require identity:delegate or *. Workspace grants and run approval ownership are checked separately." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "AI Services", "AI Services" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/ai/jobs/{job_id}": { "get": { "operationId": "get_ai_job_v1_ai_jobs__job_id__get", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiJobResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Ai Job", "tags": [ "AI Services" ], "x-q-capability": { "id": "GET /v1/ai/jobs/{job_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant and authenticated user/principal; delegated users require identity:delegate or *. Workspace grants and run approval ownership are checked separately." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "AI Services", "AI Services" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/ai/jobs/{job_id}/stream": { "get": { "operationId": "stream_ai_job_v1_ai_jobs__job_id__stream_get", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } } ], "responses": { "200": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Stream Ai Job", "tags": [ "AI Services" ], "x-q-capability": { "id": "GET /v1/ai/jobs/{job_id}/stream", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant and authenticated user/principal; delegated users require identity:delegate or *. Workspace grants and run approval ownership are checked separately." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-sse-data": { "$ref": "#/components/schemas/AiJobEventPayload" }, "x-q-tags": [ "AI Services", "AI Services" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/answer": { "post": { "description": "Perplexity-style SSE answer stream with plan, tool_start/result, sources, tokens, follow-ups.", "operationId": "answer_endpoint_v1_answer_post", "parameters": [ { "in": "query", "name": "request_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request Id" } }, { "in": "header", "name": "Last-Event-ID", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last-Event-Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnswerRequestPayload" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnswerResponse" } }, "text/event-stream": { "schema": { "type": "string" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Run the unified Answer Engine", "tags": [ "Answer Engine" ], "x-q-answer-stream": { "envelope": { "$ref": "#/components/schemas/AnswerStreamEnvelope" }, "max_event_bytes": 262144, "max_retained_events": 1024, "opt_in": "stream_version", "payloads": { "approval_required": { "$ref": "#/components/schemas/AnswerStreamApproval" }, "completed": { "$ref": "#/components/schemas/AnswerStreamCompleted" }, "delta": { "$ref": "#/components/schemas/AnswerStreamDelta" }, "failed": { "$ref": "#/components/schemas/AnswerStreamFailed" }, "heartbeat": { "$ref": "#/components/schemas/AnswerStreamHeartbeat" }, "progress": { "$ref": "#/components/schemas/AnswerStreamProgress" }, "revision": { "$ref": "#/components/schemas/AnswerStreamRevision" }, "started": { "$ref": "#/components/schemas/AnswerStreamStarted" } }, "replay": "same_principal_and_current_source_permissions_and_revisions", "resume_method": "GET", "retention_seconds": 900, "terminal_events": [ "completed", "failed" ], "unknown_events": "advance_cursor_without_changing_result", "version": "1" }, "x-q-capability": { "id": "POST /v1/answer", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant and authenticated user/principal; delegated users require identity:delegate or *. Workspace grants and run approval ownership are checked separately." }, "registry_version": "2026-10-12.1", "sdk": { "typescript": [ { "path": "\"/answer\"", "source": "sdks/typescript/src/answer.ts", "transport": "postJson" }, { "path": "\"/answer\"", "source": "sdks/typescript/src/answer.ts", "transport": "postJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-sse-data": { "$ref": "#/components/schemas/AnswerEventEnvelope" }, "x-q-tags": [ "Answer Engine", "Answer Engine" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/answer/clarify": { "post": { "description": "Loads the Redis checkpoint for ``run_id``, injects the user's ``answers`` into the planner context, and continues streaming the same run as SSE. Emits a ``clarify_resumed`` event first, followed by the normal Deep Research event sequence.", "operationId": "answer_clarify_endpoint_v1_answer_clarify_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClarifyRequestPayload" } } }, "required": true }, "responses": { "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Submit clarification answers and resume a paused deep-research run", "tags": [ "Answer Engine" ], "x-q-capability": { "id": "POST /v1/answer/clarify", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": "Permission-aware retained-evidence replay is not implemented; authenticated requests return 409 permission_aware_replay_required.", "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant and authenticated user/principal; delegated users require identity:delegate or *. Workspace grants and run approval ownership are checked separately." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Answer Engine", "Answer Engine" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/answer/outcome-stats": { "get": { "description": "Return aggregated session correction/acceptance rates.\n\nConsumed by ``bench/aggregate_outcomes.py`` and optionally by a\nfrontend dashboard. Prefers Redis aggregation buckets when available,\nfalls back to in-memory stats.", "operationId": "outcome_stats_v1_answer_outcome_stats_get", "parameters": [ { "in": "query", "name": "harness", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Harness" } }, { "in": "query", "name": "model", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" } }, { "in": "query", "name": "window_hours", "required": false, "schema": { "default": 24, "title": "Window Hours", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutcomeStats" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Outcome Stats", "tags": [ "Answer Engine" ], "x-q-capability": { "id": "GET /v1/answer/outcome-stats", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant and authenticated user/principal; delegated users require identity:delegate or *. Workspace grants and run approval ownership are checked separately." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Answer Engine", "Answer Engine" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/answer/resume": { "get": { "description": "Replays buffered SSE frames for an in-flight or recently-completed answer request. Clients pass ``?request_id=`` and may include the ``Last-Event-ID`` header to skip frames already delivered.", "operationId": "resume_endpoint_v1_answer_resume_get", "parameters": [ { "in": "query", "name": "request_id", "required": true, "schema": { "title": "Request Id", "type": "string" } }, { "in": "header", "name": "Last-Event-ID", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last-Event-Id" } } ], "responses": { "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Resume an Answer SSE stream by request_id and Last-Event-ID", "tags": [ "Answer Engine" ], "x-q-capability": { "id": "GET /v1/answer/resume", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": "Permission-aware retained-evidence replay is not implemented; authenticated requests return 409 permission_aware_replay_required.", "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant and authenticated user/principal; delegated users require identity:delegate or *. Workspace grants and run approval ownership are checked separately." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Answer Engine", "Answer Engine" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/answer/streams/{run_id}": { "get": { "operationId": "machine_resume_endpoint_v1_answer_streams__run_id__get", "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } }, { "in": "header", "name": "Last-Event-ID", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last-Event-Id" } } ], "responses": { "200": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Observe or reconnect to a version-one answer stream", "tags": [ "Answer Engine" ], "x-q-answer-stream": { "envelope": { "$ref": "#/components/schemas/AnswerStreamEnvelope" }, "max_event_bytes": 262144, "max_retained_events": 1024, "opt_in": "stream_version", "payloads": { "approval_required": { "$ref": "#/components/schemas/AnswerStreamApproval" }, "completed": { "$ref": "#/components/schemas/AnswerStreamCompleted" }, "delta": { "$ref": "#/components/schemas/AnswerStreamDelta" }, "failed": { "$ref": "#/components/schemas/AnswerStreamFailed" }, "heartbeat": { "$ref": "#/components/schemas/AnswerStreamHeartbeat" }, "progress": { "$ref": "#/components/schemas/AnswerStreamProgress" }, "revision": { "$ref": "#/components/schemas/AnswerStreamRevision" }, "started": { "$ref": "#/components/schemas/AnswerStreamStarted" } }, "replay": "same_principal_and_current_source_permissions_and_revisions", "resume_method": "GET", "retention_seconds": 900, "terminal_events": [ "completed", "failed" ], "unknown_events": "advance_cursor_without_changing_result", "version": "1" }, "x-q-capability": { "id": "GET /v1/answer/streams/{run_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant and authenticated user/principal; delegated users require identity:delegate or *. Workspace grants and run approval ownership are checked separately." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-sse-data": { "$ref": "#/components/schemas/AnswerStreamEnvelope" }, "x-q-tags": [ "Answer Engine", "Answer Engine" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/answer/{request_id}/budget-pause/{pause_id}": { "post": { "description": "Used after a ``budget_pause_request`` SSE event. POST ``{ \"approved\": true }`` to let the agent continue, or ``{ \"approved\": false }`` to stop the run.", "operationId": "answer_budget_pause_v1_answer__request_id__budget_pause__pause_id__post", "parameters": [ { "in": "path", "name": "request_id", "required": true, "schema": { "title": "Request Id", "type": "string" } }, { "in": "path", "name": "pause_id", "required": true, "schema": { "title": "Pause Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BudgetPausePayload" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovalDecision" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Approve or reject continuing past an agent budget safety cap", "tags": [ "Answer Engine" ], "x-q-capability": { "id": "POST /v1/answer/{request_id}/budget-pause/{pause_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant and authenticated user/principal; delegated users require identity:delegate or *. Workspace grants and run approval ownership are checked separately." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Answer Engine", "Answer Engine" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/answer/{request_id}/checkpoints": { "get": { "operationId": "answer_list_checkpoints_v1_answer__request_id__checkpoints_get", "parameters": [ { "in": "path", "name": "request_id", "required": true, "schema": { "title": "Request Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/CheckpointSummary" }, "title": "Response Answer List Checkpoints V1 Answer Request Id Checkpoints Get", "type": "array" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "List checkpoints for an answer run", "tags": [ "Answer Engine" ], "x-q-capability": { "id": "GET /v1/answer/{request_id}/checkpoints", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant and authenticated user/principal; delegated users require identity:delegate or *. Workspace grants and run approval ownership are checked separately." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Answer Engine", "Answer Engine" ], "x-stability": "beta" }, "post": { "operationId": "answer_create_checkpoint_v1_answer__request_id__checkpoints_post", "parameters": [ { "in": "path", "name": "request_id", "required": true, "schema": { "title": "Request Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/CheckpointCreatePayload" }, { "type": "null" } ], "title": "Body" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckpointCreated" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Create a user-requested checkpoint", "tags": [ "Answer Engine" ], "x-q-capability": { "id": "POST /v1/answer/{request_id}/checkpoints", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant and authenticated user/principal; delegated users require identity:delegate or *. Workspace grants and run approval ownership are checked separately." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Answer Engine", "Answer Engine" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/answer/{request_id}/checkpoints/{checkpoint_id}/branch": { "post": { "operationId": "answer_branch_checkpoint_v1_answer__request_id__checkpoints__checkpoint_id__branch_post", "parameters": [ { "in": "path", "name": "request_id", "required": true, "schema": { "title": "Request Id", "type": "string" } }, { "in": "path", "name": "checkpoint_id", "required": true, "schema": { "title": "Checkpoint Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/CheckpointBranchPayload" }, { "type": "null" } ], "title": "Body" } } } }, "responses": { "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Branch a new answer run from a checkpoint", "tags": [ "Answer Engine" ], "x-q-capability": { "id": "POST /v1/answer/{request_id}/checkpoints/{checkpoint_id}/branch", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": "Authenticated authorised requests return 409 permission_aware_replay_required; this backend is not implemented.", "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant and authenticated user/principal; delegated users require identity:delegate or *. Workspace grants and run approval ownership are checked separately." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Answer Engine", "Answer Engine" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/answer/{request_id}/checkpoints/{checkpoint_id}/resume": { "post": { "operationId": "answer_resume_checkpoint_v1_answer__request_id__checkpoints__checkpoint_id__resume_post", "parameters": [ { "in": "path", "name": "request_id", "required": true, "schema": { "title": "Request Id", "type": "string" } }, { "in": "path", "name": "checkpoint_id", "required": true, "schema": { "title": "Checkpoint Id", "type": "string" } } ], "responses": { "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Resume an answer run from a checkpoint", "tags": [ "Answer Engine" ], "x-q-capability": { "id": "POST /v1/answer/{request_id}/checkpoints/{checkpoint_id}/resume", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": "Authenticated authorised requests return 409 permission_aware_replay_required; this backend is not implemented.", "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant and authenticated user/principal; delegated users require identity:delegate or *. Workspace grants and run approval ownership are checked separately." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Answer Engine", "Answer Engine" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/answer/{request_id}/checkpoints/{checkpoint_id}/rollback": { "post": { "operationId": "answer_rollback_checkpoint_v1_answer__request_id__checkpoints__checkpoint_id__rollback_post", "parameters": [ { "in": "path", "name": "request_id", "required": true, "schema": { "title": "Request Id", "type": "string" } }, { "in": "path", "name": "checkpoint_id", "required": true, "schema": { "title": "Checkpoint Id", "type": "string" } } ], "responses": { "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Rollback an answer run to a checkpoint", "tags": [ "Answer Engine" ], "x-q-capability": { "id": "POST /v1/answer/{request_id}/checkpoints/{checkpoint_id}/rollback", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": "Authenticated authorised requests return 409 permission_aware_replay_required; this backend is not implemented.", "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant and authenticated user/principal; delegated users require identity:delegate or *. Workspace grants and run approval ownership are checked separately." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Answer Engine", "Answer Engine" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/answer/{request_id}/tool-approval/{approval_id}": { "post": { "description": "Used after a ``tool_approval_required`` SSE event when ``enable_tool_approval`` is enabled. POST ``{ \"approved\": true }`` to allow execution, or ``{ \"approved\": false, \"reason\": \"...\" }`` to deny.", "operationId": "answer_tool_approval_v1_answer__request_id__tool_approval__approval_id__post", "parameters": [ { "in": "path", "name": "request_id", "required": true, "schema": { "title": "Request Id", "type": "string" } }, { "in": "path", "name": "approval_id", "required": true, "schema": { "title": "Approval Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolApprovalPayload" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovalDecision" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Approve or reject a pending tool execution", "tags": [ "Answer Engine" ], "x-q-capability": { "id": "POST /v1/answer/{request_id}/tool-approval/{approval_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant and authenticated user/principal; delegated users require identity:delegate or *. Workspace grants and run approval ownership are checked separately." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Answer Engine", "Answer Engine" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/answer/{run_id}/approvals": { "get": { "operationId": "answer_approvals_v1_answer__run_id__approvals_get", "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovalList" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Inspect durable approvals for your run", "tags": [ "Answer Engine" ], "x-q-capability": { "id": "GET /v1/answer/{run_id}/approvals", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant and authenticated user/principal; delegated users require identity:delegate or *. Workspace grants and run approval ownership are checked separately." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Answer Engine", "Answer Engine" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/answer/{run_id}/approve": { "post": { "description": "Used after an ``approve_plan`` SSE event when ``plan_approval`` is enabled. POST an optional JSON body `{ \"plan\": { ... } }` to verify the reviewed plan; omit the body to approve as-is. Changed plans require a new run.", "operationId": "answer_plan_approve_v1_answer__run_id__approve_post", "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlanApprovePayload" }, { "type": "null" } ], "title": "Body" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovalDecision" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Approve the immutable pending query plan", "tags": [ "Answer Engine" ], "x-q-capability": { "id": "POST /v1/answer/{run_id}/approve", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant and authenticated user/principal; delegated users require identity:delegate or *. Workspace grants and run approval ownership are checked separately." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Answer Engine", "Answer Engine" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/answer/{run_id}/plan-clarify": { "post": { "operationId": "answer_plan_clarify_v1_answer__run_id__plan_clarify_post", "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanClarifyPayload" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanClarification" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Submit answers to PLAN mode clarifying questions", "tags": [ "Answer Engine" ], "x-q-capability": { "id": "POST /v1/answer/{run_id}/plan-clarify", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant and authenticated user/principal; delegated users require identity:delegate or *. Workspace grants and run approval ownership are checked separately." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Answer Engine", "Answer Engine" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/answer/{run_id}/reject": { "post": { "operationId": "answer_plan_reject_v1_answer__run_id__reject_post", "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlanRejectPayload" }, { "type": "null" } ], "title": "Body" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovalDecision" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Reject a run waiting for plan approval", "tags": [ "Answer Engine" ], "x-q-capability": { "id": "POST /v1/answer/{run_id}/reject", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant and authenticated user/principal; delegated users require identity:delegate or *. Workspace grants and run approval ownership are checked separately." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Answer Engine", "Answer Engine" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/answer/{run_id}/trace": { "get": { "description": "Returns persisted search trace plus session trace row. `run_id` is the `X-Request-Id` from the answer stream (also appears as `request_id` on the terminal `complete` event).", "operationId": "answer_trace_detail_v1_answer__run_id__trace_get", "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnswerTrace" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Retrieve full retrieval trace for a completed answer run", "tags": [ "Answer Engine" ], "x-q-capability": { "id": "GET /v1/answer/{run_id}/trace", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant and authenticated user/principal; delegated users require identity:delegate or *. Workspace grants and run approval ownership are checked separately." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Answer Engine", "Answer Engine" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/artifacts": { "get": { "operationId": "public_list_artifacts_v1_artifacts_get", "parameters": [ { "in": "query", "name": "thread_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Thread Id" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 2048, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPage_ArtifactResponse_" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "List artifacts scoped to a thread or tenant", "tags": [ "Artifacts" ], "x-q-capability": { "id": "GET /v1/artifacts", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Authenticated owner or explicit space collaborator; private content requires resource access." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "'/artifacts'", "source": "sdks/python/src/q_client/artifacts.py", "transport": "get_json" } ], "typescript": [ { "path": "\"/artifacts\"", "source": "sdks/typescript/src/artifacts.ts", "transport": "getJson" }, { "path": "\"/artifacts\"", "source": "sdks/typescript/src/artifacts.ts", "transport": "getJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "data": "data", "maximum_limit": 100, "mode": "cursor", "next": "next_cursor", "previous": "previous_cursor" }, "x-q-tags": [ "Artifacts", "Artifacts" ], "x-stability": "beta" }, "post": { "operationId": "public_generate_artifact_v1_artifacts_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateArtifactPayload" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactResponse" } }, "text/event-stream": { "schema": { "type": "string" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Generate an artifact (document / deck / chart / image / code_app)", "tags": [ "Artifacts" ], "x-q-capability": { "id": "POST /v1/artifacts", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Authenticated owner or explicit space collaborator; private content requires resource access." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "'/artifacts'", "source": "sdks/python/src/q_client/artifacts.py", "transport": "post_json" } ], "typescript": [ { "path": "\"/artifacts\"", "source": "sdks/typescript/src/artifacts.ts", "transport": "postJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Artifacts", "Artifacts" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/artifacts/{artifact_id}": { "get": { "operationId": "public_get_artifact_v1_artifacts__artifact_id__get", "parameters": [ { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } }, { "in": "query", "name": "include_body", "required": false, "schema": { "default": true, "title": "Include Body", "type": "boolean" } }, { "in": "query", "name": "version", "required": false, "schema": { "anyOf": [ { "minimum": 1, "type": "integer" }, { "type": "null" } ], "title": "Version" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Fetch an artifact + its latest body", "tags": [ "Artifacts" ], "x-q-capability": { "id": "GET /v1/artifacts/{artifact_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Authenticated owner or explicit space collaborator; private content requires resource access." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "f\"/artifacts/{quote(artifact_id, safe='')}\"", "source": "sdks/python/src/q_client/artifacts.py", "transport": "get_json" } ], "typescript": [ { "path": "`/artifacts/${encodeURIComponent(artifactId)}`", "source": "sdks/typescript/src/artifacts.ts", "transport": "getJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Artifacts", "Artifacts" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/artifacts/{artifact_id}/download": { "get": { "operationId": "public_download_artifact_v1_artifacts__artifact_id__download_get", "parameters": [ { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } }, { "in": "query", "name": "version", "required": false, "schema": { "anyOf": [ { "minimum": 1, "type": "integer" }, { "type": "null" } ], "title": "Version" } } ], "responses": { "200": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Download verified artifact bytes (authenticated, version-specific)", "tags": [ "Artifacts" ], "x-q-capability": { "id": "GET /v1/artifacts/{artifact_id}/download", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Authenticated owner or explicit space collaborator; private content requires resource access." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Artifacts", "Artifacts" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/artifacts/{artifact_id}/refine": { "post": { "operationId": "artifact_refine", "parameters": [ { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactRefineRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactReceipt" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Artifact Refine", "tags": [ "Knowledge" ], "x-q-capability": { "id": "POST /v1/artifacts/{artifact_id}/refine", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": { "retrieval": "ai:search" }, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "explicit", "scopes": [ "ai:generate" ], "settings": [ "HEADLESS_API_ENABLED" ], "stability": "beta", "tenant": "credential", "user": "Current principal, space and source permissions apply; configured endpoint credentials are never accepted from retrieval requests." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "f\"/artifacts/{quote(artifact_id, safe='')}/refine\"", "source": "sdks/python/src/q_client/artifacts.py", "transport": "post_json" } ], "typescript": [ { "path": "`/artifacts/${encodeURIComponent(artifactId)}/refine`", "source": "sdks/typescript/src/artifacts.ts", "transport": "postJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-stability": "beta" }, "x-stability": "beta" }, "/v1/best-of-n/merge": { "post": { "description": "Chat-flow merge for ``/best-of-n`` runs that execute via the answer engine.", "operationId": "merge_best_of_n_workspace_v1_best_of_n_merge_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BestOfNWorkspaceMergeRequest" } } }, "required": true }, "responses": { "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Merge a best-of-n worktree branch into the main workspace", "tags": [ "Answer Engine" ], "x-q-capability": { "id": "POST /v1/best-of-n/merge", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": "Authenticated authorised requests return 503 workspace_merge_backend_unavailable; this backend is not implemented.", "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant and authenticated user/principal; delegated users require identity:delegate or *. Workspace grants and run approval ownership are checked separately." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Answer Engine", "Answer Engine" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/billing/budget/user/{user_id}": { "get": { "description": "Return current per-end-user budget status for ISV budget dashboards.", "operationId": "get_user_budget_v1_billing_budget_user__user_id__get", "parameters": [ { "in": "path", "name": "user_id", "required": true, "schema": { "title": "User Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserBudget" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Per-end-user budget status", "tags": [ "Billing" ], "x-q-capability": { "id": "GET /v1/billing/budget/user/{user_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "stable", "tenant": "credential_or_validated_request", "user": "Tenant-wide billing administration and user usage, not individual-user isolation." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Billing", "Billing" ], "x-stability": "stable" }, "x-stability": "stable" }, "/v1/billing/cancel": { "post": { "operationId": "cancel_billing_subscription_v1_billing_cancel_post", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Cancel subscription at period end", "tags": [ "Billing" ], "x-q-capability": { "id": "POST /v1/billing/cancel", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [ "VELLON_ENABLED" ], "stability": "stable", "tenant": "credential_or_validated_request", "user": "Tenant-wide billing administration; configured billing provider required." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Billing", "Billing" ], "x-stability": "stable" }, "x-stability": "stable" }, "/v1/billing/change-plan": { "post": { "operationId": "change_billing_plan_v1_billing_change_plan_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangePlanRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Change subscription plan", "tags": [ "Billing" ], "x-q-capability": { "id": "POST /v1/billing/change-plan", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [ "VELLON_ENABLED" ], "stability": "stable", "tenant": "credential_or_validated_request", "user": "Tenant-wide billing administration; configured billing provider required." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Billing", "Billing" ], "x-stability": "stable" }, "x-stability": "stable" }, "/v1/billing/credits": { "get": { "description": "Fetch credit notes and adjustments from Vellon for the tenant.", "operationId": "get_credits_v1_billing_credits_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditsResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Credit notes and adjustments", "tags": [ "Billing" ], "x-q-capability": { "id": "GET /v1/billing/credits", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [ "VELLON_ENABLED" ], "stability": "stable", "tenant": "credential_or_validated_request", "user": "Tenant-wide billing administration; configured billing provider required." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Billing", "Billing" ], "x-stability": "stable" }, "x-stability": "stable" }, "/v1/billing/entitlements": { "get": { "operationId": "get_billing_entitlements_v1_billing_entitlements_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementsResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Feature entitlements for the tenant", "tags": [ "Billing" ], "x-q-capability": { "id": "GET /v1/billing/entitlements", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "stable", "tenant": "credential_or_validated_request", "user": "Tenant-wide billing administration and user usage, not individual-user isolation." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Billing", "Billing" ], "x-stability": "stable" }, "x-stability": "stable" }, "/v1/billing/portal-session": { "post": { "operationId": "create_billing_portal_session_v1_billing_portal_session_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalSessionRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalSessionResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Create a Vellon customer portal session", "tags": [ "Billing" ], "x-q-capability": { "id": "POST /v1/billing/portal-session", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [ "VELLON_ENABLED" ], "stability": "stable", "tenant": "credential_or_validated_request", "user": "Tenant-wide billing administration; configured billing provider required." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Billing", "Billing" ], "x-stability": "stable" }, "x-stability": "stable" }, "/v1/billing/proration-preview": { "get": { "description": "Preview the prorated charges for a mid-cycle plan change before confirming.", "operationId": "get_proration_preview_v1_billing_proration_preview_get", "parameters": [ { "in": "query", "name": "new_price_id", "required": true, "schema": { "title": "New Price Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProrationResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Preview proration for a plan change", "tags": [ "Billing" ], "x-q-capability": { "id": "GET /v1/billing/proration-preview", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [ "VELLON_ENABLED" ], "stability": "stable", "tenant": "credential_or_validated_request", "user": "Tenant-wide billing administration; configured billing provider required." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Billing", "Billing" ], "x-stability": "stable" }, "x-stability": "stable" }, "/v1/billing/rates": { "get": { "operationId": "get_rates_v1_billing_rates_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingRates" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Current rate card for the Q public API", "tags": [ "Billing" ], "x-q-capability": { "id": "GET /v1/billing/rates", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "stable", "tenant": "credential_or_validated_request", "user": "Tenant-wide billing administration and user usage, not individual-user isolation." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "'/billing/rates'", "source": "sdks/python/src/q_client/billing.py", "transport": "get_json" } ], "typescript": [ { "path": "\"/billing/rates\"", "source": "sdks/typescript/src/client.ts", "transport": "getJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Billing", "Billing" ], "x-stability": "stable" }, "x-stability": "stable" }, "/v1/billing/spend": { "get": { "description": "Provider expenditure with explicit actual, provisional, reserved and tariff totals.", "operationId": "get_spend_v1_billing_spend_get", "parameters": [ { "in": "query", "name": "since", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Since" } }, { "in": "query", "name": "until", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Until" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpendResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Provider expenditure and separate customer charges", "tags": [ "Billing" ], "x-q-capability": { "id": "GET /v1/billing/spend", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "stable", "tenant": "credential_or_validated_request", "user": "Tenant-wide billing administration and user usage, not individual-user isolation." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Billing", "Billing" ], "x-stability": "stable" }, "x-stability": "stable" }, "/v1/billing/subscribe": { "post": { "operationId": "subscribe_v1_billing_subscribe_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscribeRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Create a Vellon subscription", "tags": [ "Billing" ], "x-q-capability": { "id": "POST /v1/billing/subscribe", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [ "VELLON_ENABLED" ], "stability": "stable", "tenant": "credential_or_validated_request", "user": "Tenant-wide billing administration; configured billing provider required." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Billing", "Billing" ], "x-stability": "stable" }, "x-stability": "stable" }, "/v1/billing/subscription": { "get": { "operationId": "get_billing_subscription_v1_billing_subscription_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Current Vellon subscription", "tags": [ "Billing" ], "x-q-capability": { "id": "GET /v1/billing/subscription", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [ "VELLON_ENABLED" ], "stability": "stable", "tenant": "credential_or_validated_request", "user": "Tenant-wide billing administration; configured billing provider required." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Billing", "Billing" ], "x-stability": "stable" }, "x-stability": "stable" }, "/v1/billing/usage": { "get": { "operationId": "get_usage_v1_billing_usage_get", "parameters": [ { "in": "query", "name": "since", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Since" } }, { "in": "query", "name": "until", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Until" } }, { "in": "query", "name": "group_by", "required": false, "schema": { "default": "surface", "enum": [ "surface", "model", "day" ], "title": "Group By", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingUsage" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Rolling usage + cost summary", "tags": [ "Billing" ], "x-q-capability": { "id": "GET /v1/billing/usage", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "stable", "tenant": "credential_or_validated_request", "user": "Tenant-wide billing administration and user usage, not individual-user isolation." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "'/billing/usage'", "source": "sdks/python/src/q_client/billing.py", "transport": "get_json" } ], "typescript": [ { "path": "\"/billing/usage\"", "source": "sdks/typescript/src/client.ts", "transport": "getJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Billing", "Billing" ], "x-stability": "stable" }, "x-stability": "stable" }, "/v1/billing/usage/user/{user_id}": { "get": { "description": "Per-end-user usage within the caller's tenant.\n\nISVs that pass ``user_id`` when calling the AI endpoints can query\nper-user cost here to build their own invoicing / budget dashboards.", "operationId": "get_user_usage_v1_billing_usage_user__user_id__get", "parameters": [ { "in": "path", "name": "user_id", "required": true, "schema": { "title": "User Id", "type": "string" } }, { "in": "query", "name": "since", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Since" } }, { "in": "query", "name": "until", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Until" } }, { "in": "query", "name": "group_by", "required": false, "schema": { "default": "surface", "enum": [ "surface", "model", "day" ], "title": "Group By", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingUsage" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Per-end-user usage (ISV pass-through billing)", "tags": [ "Billing" ], "x-q-capability": { "id": "GET /v1/billing/usage/user/{user_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "stable", "tenant": "credential_or_validated_request", "user": "Tenant-wide billing administration and user usage, not individual-user isolation." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Billing", "Billing" ], "x-stability": "stable" }, "x-stability": "stable" }, "/v1/capabilities": { "get": { "operationId": "list_capabilities_v1_capabilities_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Discovery" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [], "summary": "List Capabilities", "tags": [ "Capabilities" ], "x-q-capability": { "id": "GET /v1/capabilities", "policy": { "audience": "public", "auth": "anonymous", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "stable", "tenant": "none", "user": "No user or tenant context." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-stability": "stable" }, "x-stability": "stable" }, "/v1/channels": { "get": { "operationId": "public_list_connections_v1_channels_get", "parameters": [ { "in": "query", "name": "channel_type", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Type" } }, { "description": "Tenant ID (CUID from Route Royal)", "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tenant ID (CUID from Route Royal)", "title": "Tenant Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelList" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Public List Connections", "tags": [ "Channels" ], "x-q-capability": { "id": "GET /v1/channels", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [ "CHANNELS_ENABLED" ], "stability": "alpha", "tenant": "credential_or_validated_request", "user": "Tenant-wide channel connections; provider configuration and outbound policy required." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Channels", "Channels" ], "x-stability": "alpha" }, "post": { "operationId": "public_create_connection_v1_channels_post", "parameters": [ { "description": "Tenant ID (CUID from Route Royal)", "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tenant ID (CUID from Route Royal)", "title": "Tenant Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelConnectionCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Public Create Connection", "tags": [ "Channels" ], "x-q-capability": { "id": "POST /v1/channels", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [ "CHANNELS_ENABLED" ], "stability": "alpha", "tenant": "credential_or_validated_request", "user": "Tenant-wide channel connections; provider configuration and outbound policy required." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Channels", "Channels" ], "x-stability": "alpha" }, "x-stability": "alpha" }, "/v1/channels/types": { "get": { "operationId": "public_list_channel_types_v1_channels_types_get", "parameters": [ { "description": "Tenant ID (CUID from Route Royal)", "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tenant ID (CUID from Route Royal)", "title": "Tenant Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelTypes" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "List available channel types", "tags": [ "Channels" ], "x-q-capability": { "id": "GET /v1/channels/types", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [ "CHANNELS_ENABLED" ], "stability": "alpha", "tenant": "credential_or_validated_request", "user": "Tenant-wide channel connections; provider configuration and outbound policy required." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Channels", "Channels" ], "x-stability": "alpha" }, "x-stability": "alpha" }, "/v1/channels/{connection_id}/send": { "post": { "operationId": "public_send_message_v1_channels__connection_id__send_post", "parameters": [ { "in": "path", "name": "connection_id", "required": true, "schema": { "format": "uuid", "title": "Connection Id", "type": "string" } }, { "description": "Tenant ID (CUID from Route Royal)", "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tenant ID (CUID from Route Royal)", "title": "Tenant Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelSendMessage" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelDelivery" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Public Send Message", "tags": [ "Channels" ], "x-q-capability": { "id": "POST /v1/channels/{connection_id}/send", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [ "CHANNELS_ENABLED" ], "stability": "alpha", "tenant": "credential_or_validated_request", "user": "Tenant-wide channel connections; provider configuration and outbound policy required." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Channels", "Channels" ], "x-stability": "alpha" }, "x-stability": "alpha" }, "/v1/chat/completions": { "post": { "description": "Create a chat completion using the specified model.\n\nThis implements Q's documented text chat compatibility profile. Usage is automatically tracked for billing.\n\n**Authentication**: Requires an API key or trusted service-to-service auth.\n\n**Usage Tracking**: All requests are logged with:\n- Tenant ID (from API key or trusted service tenant context)\n- User ID (from X-User-Id header or request body)\n- Token counts and estimated cost\n- Tags for cost attribution\n\n**Example**:\n```bash\ncurl -X POST https://your-q-instance.com/api/v1/chat/completions \\\n -H \"Authorization: Bearer YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"model\": \"gpt-4o-mini\",\n \"messages\": [{\"role\": \"user\", \"content\": \"Hello!\"}],\n \"max_tokens\": 100\n }'\n```", "operationId": "create_chat_completion_v1_chat_completions_post", "parameters": [ { "description": "Tenant ID for trusted service callers", "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tenant ID for trusted service callers", "title": "Tenant Id" } }, { "description": "User ID for tracking", "in": "header", "name": "X-User-Id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "User ID for tracking", "title": "X-User-Id" } }, { "description": "Tenant ID for trusted service callers", "in": "header", "name": "X-Tenant-ID", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tenant ID for trusted service callers", "title": "X-Tenant-Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatCompletionRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatCompletionResponse" } }, "text/event-stream": { "schema": { "type": "string" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Create Chat Completion", "tags": [ "Completions" ], "x-q-capability": { "id": "POST /v1/chat/completions", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:chat" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-bound computation; supplied user is attribution, not authorisation." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Completions", "Completions" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/chat/models": { "get": { "description": "List available chat models with pricing.\n\nReturns models that are configured and available for chat completions.", "operationId": "list_chat_models_v1_chat_models_get", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ChatModel" }, "title": "Response List Chat Models V1 Chat Models Get", "type": "array" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "List Chat Models", "tags": [ "Completions" ], "x-q-capability": { "id": "GET /v1/chat/models", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:chat" ], "settings": [], "stability": "beta", "tenant": "none", "user": "Authenticated model metadata; no user data." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Completions", "Completions" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/connectors": { "get": { "operationId": "public_list_connectors_v1_connectors_get", "parameters": [ { "description": "Required for S2S / internal auth", "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required for S2S / internal auth", "title": "Tenant Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ConnectorOut" }, "title": "Response Public List Connectors V1 Connectors Get", "type": "array" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Public List Connectors", "tags": [ "Connectors API" ], "x-q-capability": { "id": "GET /v1/connectors", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "alpha", "tenant": "credential_or_validated_request", "user": "Tenant-scoped connectors; content writes enforce delegated owner and collection permissions." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Connectors API", "Connectors (Public API)" ], "x-stability": "alpha" }, "post": { "operationId": "public_create_connector_v1_connectors_post", "parameters": [ { "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorOut" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Public Create Connector", "tags": [ "Connectors API" ], "x-q-capability": { "id": "POST /v1/connectors", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "alpha", "tenant": "credential_or_validated_request", "user": "Tenant-scoped connectors; content writes enforce delegated owner and collection permissions." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Connectors API", "Connectors (Public API)" ], "x-stability": "alpha" }, "x-stability": "alpha" }, "/v1/connectors/{connector_id}/sync": { "post": { "operationId": "public_trigger_sync_v1_connectors__connector_id__sync_post", "parameters": [ { "in": "path", "name": "connector_id", "required": true, "schema": { "format": "uuid", "title": "Connector Id", "type": "string" } }, { "description": "Required for S2S / internal auth", "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required for S2S / internal auth", "title": "Tenant Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncTriggerBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorSyncResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Public Trigger Sync", "tags": [ "Connectors API" ], "x-q-capability": { "id": "POST /v1/connectors/{connector_id}/sync", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "alpha", "tenant": "credential_or_validated_request", "user": "Tenant-scoped connectors; content writes enforce delegated owner and collection permissions." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Connectors API", "Connectors (Public API)" ], "x-stability": "alpha" }, "x-stability": "alpha" }, "/v1/custom-modes": { "get": { "operationId": "list_custom_modes_v1_custom_modes_get", "parameters": [ { "in": "query", "name": "workspace_id", "required": true, "schema": { "title": "Workspace Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomModes" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "List user-defined custom modes from a workspace", "tags": [ "Answer Engine" ], "x-q-capability": { "id": "GET /v1/custom-modes", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant and authenticated user/principal; delegated users require identity:delegate or *. Workspace grants and run approval ownership are checked separately." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Answer Engine", "Answer Engine" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/devtools/service-objectives": { "get": { "operationId": "service_objectives", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceObjectives" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Service objectives and owned durable-run observations", "tags": [ "DevTools" ], "x-q-capability": { "id": "GET /v1/devtools/service-objectives", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [ "ENABLE_DEVTOOLS" ], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Only version-2 durable runs owned by the authenticated principal, within current diagnostic retention." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "DevTools", "DevTools" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/devtools/stream": { "get": { "description": "Server-sent events stream of API calls for the authenticated key.", "operationId": "devtools_stream_v1_devtools_stream_get", "responses": { "200": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Stream real-time API activity (SSE)", "tags": [ "DevTools" ], "x-q-capability": { "id": "GET /v1/devtools/stream", "policy": { "audience": "public", "auth": "api_key", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [ "ENABLE_DEVTOOLS" ], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Stream scoped to the authenticated API key hash." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "DevTools", "DevTools" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/devtools/traces/{request_id}": { "get": { "description": "Return owner-authorised trace measurements without historical content.", "operationId": "devtools_trace_v1_devtools_traces__request_id__get", "parameters": [ { "in": "path", "name": "request_id", "required": true, "schema": { "title": "Request Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DevtoolsTrace" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Execution trace for a request", "tags": [ "DevTools" ], "x-q-capability": { "id": "GET /v1/devtools/traces/{request_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [ "ENABLE_DEVTOOLS" ], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant usage/traces; request logs additionally filtered by API key when available." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "DevTools", "DevTools" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/devtools/usage": { "get": { "description": "Summarise metered usage for the authenticated tenant.", "operationId": "devtools_usage_v1_devtools_usage_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DevtoolsUsage" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Token usage and cost for current billing period", "tags": [ "DevTools" ], "x-q-capability": { "id": "GET /v1/devtools/usage", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [ "ENABLE_DEVTOOLS" ], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant usage/traces; request logs additionally filtered by API key when available." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "DevTools", "DevTools" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/documents/{document_id}/ingestion": { "get": { "operationId": "get_document_ingestion_status", "parameters": [ { "in": "path", "name": "document_id", "required": true, "schema": { "format": "uuid", "title": "Document Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentIngestionStatus" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Document Ingestion Status", "tags": [ "Document ingestion" ], "x-q-capability": { "id": "GET /v1/documents/{document_id}/ingestion", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [ "read" ], "settings": [], "stability": "beta", "tenant": "credential", "user": "Current document and Space permissions govern status, including retained deletion receipts." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "f\"/documents/{quote(document_id, safe='')}/ingestion\"", "source": "sdks/python/src/q_client/knowledge.py", "transport": "get_json" } ], "typescript": [ { "path": "`/documents/${encodeURIComponent(documentId)}/ingestion`", "source": "sdks/typescript/src/knowledge.ts", "transport": "getJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-stability": "beta" }, "x-stability": "beta" }, "/v1/embeddings": { "post": { "operationId": "embeddings_endpoint_v1_embeddings_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/app__api__public_embeddings__EmbeddingsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/app__api__public_embeddings__EmbeddingsResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "OpenAI-compatible embeddings", "tags": [ "Embeddings API" ], "x-q-capability": { "id": "POST /v1/embeddings", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "embeddings_api" ], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:embeddings" ], "settings": [], "stability": "stable", "tenant": "credential_or_validated_request", "user": "Tenant-bound computation; user is attribution only." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "'/embeddings'", "source": "sdks/python/src/q_client/embeddings.py", "transport": "post_json" } ], "typescript": [ { "path": "\"/embeddings\"", "source": "sdks/typescript/src/client.ts", "transport": "postJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Embeddings API", "Embeddings API" ], "x-stability": "stable" }, "x-stability": "stable" }, "/v1/extensions": { "get": { "operationId": "extensions_list", "parameters": [ { "in": "query", "name": "after", "required": false, "schema": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "After" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtensionPage" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "List Extensions", "tags": [ "Extensions" ], "x-q-capability": { "id": "GET /v1/extensions", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": { "include_memory": "memory:read" }, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "explicit", "scopes": [ "extensions:read" ], "settings": [ "EXTENSIONS_API_ENABLED" ], "stability": "alpha", "tenant": "credential", "user": "Tenant and authenticated principal. Only owners manage registrations; explicit principal grants permit tool/skill use or connector sync. Versions and revocations are revalidated at use." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "'/extensions'", "source": "sdks/python/src/q_client/extensions.py", "transport": "get_json" } ], "typescript": [ { "path": "\"/extensions\"", "source": "sdks/typescript/src/extensions.ts", "transport": "getJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-stability": "alpha" }, "post": { "operationId": "extensions_register", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtensionRegister" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtensionOut" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Register Extension", "tags": [ "Extensions" ], "x-q-capability": { "id": "POST /v1/extensions", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": { "include_memory": "memory:read" }, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "explicit", "scopes": [ "extensions:manage" ], "settings": [ "EXTENSIONS_API_ENABLED" ], "stability": "alpha", "tenant": "credential", "user": "Tenant and authenticated principal. Only owners manage registrations; explicit principal grants permit tool/skill use or connector sync. Versions and revocations are revalidated at use." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "'/extensions'", "source": "sdks/python/src/q_client/extensions.py", "transport": "post_json" } ], "typescript": [ { "path": "\"/extensions\"", "source": "sdks/typescript/src/extensions.ts", "transport": "postJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-stability": "alpha" }, "x-stability": "alpha" }, "/v1/extensions/validate": { "post": { "operationId": "extensions_validate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtensionManifest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationReceipt" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Validate Extension", "tags": [ "Extensions" ], "x-q-capability": { "id": "POST /v1/extensions/validate", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": { "include_memory": "memory:read" }, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "explicit", "scopes": [ "extensions:manage" ], "settings": [ "EXTENSIONS_API_ENABLED" ], "stability": "alpha", "tenant": "credential", "user": "Tenant and authenticated principal. Only owners manage registrations; explicit principal grants permit tool/skill use or connector sync. Versions and revocations are revalidated at use." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "'/extensions/validate'", "source": "sdks/python/src/q_client/extensions.py", "transport": "post_json" } ], "typescript": [ { "path": "\"/extensions/validate\"", "source": "sdks/typescript/src/extensions.ts", "transport": "postJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-stability": "alpha" }, "x-stability": "alpha" }, "/v1/extensions/{extension_id}": { "get": { "operationId": "extensions_get", "parameters": [ { "in": "path", "name": "extension_id", "required": true, "schema": { "format": "uuid", "title": "Extension Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtensionOut" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Extension", "tags": [ "Extensions" ], "x-q-capability": { "id": "GET /v1/extensions/{extension_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": { "include_memory": "memory:read" }, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "explicit", "scopes": [ "extensions:read" ], "settings": [ "EXTENSIONS_API_ENABLED" ], "stability": "alpha", "tenant": "credential", "user": "Tenant and authenticated principal. Only owners manage registrations; explicit principal grants permit tool/skill use or connector sync. Versions and revocations are revalidated at use." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "f\"/extensions/{quote(extension_id, safe='')}\"", "source": "sdks/python/src/q_client/extensions.py", "transport": "get_json" } ], "typescript": [ { "path": "`/extensions/${encodeURIComponent(id)}`", "source": "sdks/typescript/src/extensions.ts", "transport": "getJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-stability": "alpha" }, "x-stability": "alpha" }, "/v1/extensions/{extension_id}/events": { "get": { "operationId": "extensions_events", "parameters": [ { "in": "path", "name": "extension_id", "required": true, "schema": { "format": "uuid", "title": "Extension Id", "type": "string" } }, { "in": "query", "name": "after", "required": false, "schema": { "default": 0, "minimum": 0, "title": "After", "type": "integer" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventPage" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Events", "tags": [ "Extensions" ], "x-q-capability": { "id": "GET /v1/extensions/{extension_id}/events", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": { "include_memory": "memory:read" }, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "explicit", "scopes": [ "extensions:read" ], "settings": [ "EXTENSIONS_API_ENABLED" ], "stability": "alpha", "tenant": "credential", "user": "Tenant and authenticated principal. Only owners manage registrations; explicit principal grants permit tool/skill use or connector sync. Versions and revocations are revalidated at use." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "f\"/extensions/{quote(extension_id, safe='')}/events\"", "source": "sdks/python/src/q_client/extensions.py", "transport": "get_json" } ], "typescript": [ { "path": "`/extensions/${encodeURIComponent(id)}/events`", "source": "sdks/typescript/src/extensions.ts", "transport": "getJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-stability": "alpha" }, "x-stability": "alpha" }, "/v1/extensions/{extension_id}/grants": { "get": { "operationId": "extensions_grants", "parameters": [ { "in": "path", "name": "extension_id", "required": true, "schema": { "format": "uuid", "title": "Extension Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GrantPage" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Grants", "tags": [ "Extensions" ], "x-q-capability": { "id": "GET /v1/extensions/{extension_id}/grants", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": { "include_memory": "memory:read" }, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "explicit", "scopes": [ "extensions:manage" ], "settings": [ "EXTENSIONS_API_ENABLED" ], "stability": "alpha", "tenant": "credential", "user": "Tenant and authenticated principal. Only owners manage registrations; explicit principal grants permit tool/skill use or connector sync. Versions and revocations are revalidated at use." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "f\"/extensions/{quote(extension_id, safe='')}/grants\"", "source": "sdks/python/src/q_client/extensions.py", "transport": "get_json" } ], "typescript": [ { "path": "`/extensions/${encodeURIComponent(id)}/grants`", "source": "sdks/typescript/src/extensions.ts", "transport": "getJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-stability": "alpha" }, "post": { "operationId": "extensions_grant", "parameters": [ { "in": "path", "name": "extension_id", "required": true, "schema": { "format": "uuid", "title": "Extension Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GrantRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtensionOut" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Grant", "tags": [ "Extensions" ], "x-q-capability": { "id": "POST /v1/extensions/{extension_id}/grants", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": { "include_memory": "memory:read" }, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "explicit", "scopes": [ "extensions:manage" ], "settings": [ "EXTENSIONS_API_ENABLED" ], "stability": "alpha", "tenant": "credential", "user": "Tenant and authenticated principal. Only owners manage registrations; explicit principal grants permit tool/skill use or connector sync. Versions and revocations are revalidated at use." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "f\"/extensions/{quote(extension_id, safe='')}/grants\"", "source": "sdks/python/src/q_client/extensions.py", "transport": "post_json" } ], "typescript": [ { "path": "`/extensions/${encodeURIComponent(id)}/grants`", "source": "sdks/typescript/src/extensions.ts", "transport": "postJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-stability": "alpha" }, "x-stability": "alpha" }, "/v1/extensions/{extension_id}/lifecycle": { "post": { "operationId": "extensions_lifecycle", "parameters": [ { "in": "path", "name": "extension_id", "required": true, "schema": { "format": "uuid", "title": "Extension Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LifecycleRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtensionOut" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Lifecycle", "tags": [ "Extensions" ], "x-q-capability": { "id": "POST /v1/extensions/{extension_id}/lifecycle", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": { "include_memory": "memory:read" }, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "explicit", "scopes": [ "extensions:manage" ], "settings": [ "EXTENSIONS_API_ENABLED" ], "stability": "alpha", "tenant": "credential", "user": "Tenant and authenticated principal. Only owners manage registrations; explicit principal grants permit tool/skill use or connector sync. Versions and revocations are revalidated at use." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "f\"/extensions/{quote(extension_id, safe='')}/lifecycle\"", "source": "sdks/python/src/q_client/extensions.py", "transport": "post_json" } ], "typescript": [ { "path": "`/extensions/${encodeURIComponent(id)}/lifecycle`", "source": "sdks/typescript/src/extensions.ts", "transport": "postJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-stability": "alpha" }, "x-stability": "alpha" }, "/v1/extensions/{extension_id}/syncs": { "get": { "operationId": "extensions_syncs", "parameters": [ { "in": "path", "name": "extension_id", "required": true, "schema": { "format": "uuid", "title": "Extension Id", "type": "string" } }, { "in": "query", "name": "after", "required": false, "schema": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "After" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncPage" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Syncs", "tags": [ "Extensions" ], "x-q-capability": { "id": "GET /v1/extensions/{extension_id}/syncs", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": { "include_memory": "memory:read" }, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "explicit", "scopes": [ "extensions:read" ], "settings": [ "EXTENSIONS_API_ENABLED" ], "stability": "alpha", "tenant": "credential", "user": "Tenant and authenticated principal. Only owners manage registrations; explicit principal grants permit tool/skill use or connector sync. Versions and revocations are revalidated at use." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "f\"/extensions/{quote(extension_id, safe='')}/syncs\"", "source": "sdks/python/src/q_client/extensions.py", "transport": "get_json" } ], "typescript": [ { "path": "`/extensions/${encodeURIComponent(id)}/syncs`", "source": "sdks/typescript/src/extensions.ts", "transport": "getJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-stability": "alpha" }, "post": { "operationId": "extensions_sync", "parameters": [ { "in": "path", "name": "extension_id", "required": true, "schema": { "format": "uuid", "title": "Extension Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorBatch" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncReceipt" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Push", "tags": [ "Extensions" ], "x-q-capability": { "id": "POST /v1/extensions/{extension_id}/syncs", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": { "include_memory": "memory:read" }, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "explicit", "scopes": [ "connectors:sync" ], "settings": [ "EXTENSIONS_API_ENABLED" ], "stability": "alpha", "tenant": "credential", "user": "Tenant and authenticated principal. Only owners manage registrations; explicit principal grants permit tool/skill use or connector sync. Versions and revocations are revalidated at use." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "f\"/extensions/{quote(extension_id, safe='')}/syncs\"", "source": "sdks/python/src/q_client/extensions.py", "transport": "post_json" } ], "typescript": [ { "path": "`/extensions/${encodeURIComponent(id)}/syncs`", "source": "sdks/typescript/src/extensions.ts", "transport": "postJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-stability": "alpha" }, "x-stability": "alpha" }, "/v1/extensions/{extension_id}/syncs/{batch_id}": { "get": { "operationId": "extensions_sync_status", "parameters": [ { "in": "path", "name": "extension_id", "required": true, "schema": { "format": "uuid", "title": "Extension Id", "type": "string" } }, { "in": "path", "name": "batch_id", "required": true, "schema": { "format": "uuid", "title": "Batch Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncReceipt" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Sync Status", "tags": [ "Extensions" ], "x-q-capability": { "id": "GET /v1/extensions/{extension_id}/syncs/{batch_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": { "include_memory": "memory:read" }, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "explicit", "scopes": [ "extensions:read" ], "settings": [ "EXTENSIONS_API_ENABLED" ], "stability": "alpha", "tenant": "credential", "user": "Tenant and authenticated principal. Only owners manage registrations; explicit principal grants permit tool/skill use or connector sync. Versions and revocations are revalidated at use." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "f\"/extensions/{quote(extension_id, safe='')}/syncs/{quote(batch_id, safe='')}\"", "source": "sdks/python/src/q_client/extensions.py", "transport": "get_json" } ], "typescript": [ { "path": "`/extensions/${encodeURIComponent(id)}/syncs/${encodeURIComponent(batch)}`", "source": "sdks/typescript/src/extensions.ts", "transport": "getJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-stability": "alpha" }, "x-stability": "alpha" }, "/v1/extensions/{extension_id}/syncs/{batch_id}/retry": { "post": { "operationId": "extensions_sync_retry", "parameters": [ { "in": "path", "name": "extension_id", "required": true, "schema": { "format": "uuid", "title": "Extension Id", "type": "string" } }, { "in": "path", "name": "batch_id", "required": true, "schema": { "format": "uuid", "title": "Batch Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncReceipt" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Sync Retry", "tags": [ "Extensions" ], "x-q-capability": { "id": "POST /v1/extensions/{extension_id}/syncs/{batch_id}/retry", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": { "include_memory": "memory:read" }, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "explicit", "scopes": [ "connectors:sync" ], "settings": [ "EXTENSIONS_API_ENABLED" ], "stability": "alpha", "tenant": "credential", "user": "Tenant and authenticated principal. Only owners manage registrations; explicit principal grants permit tool/skill use or connector sync. Versions and revocations are revalidated at use." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "f\"/extensions/{quote(extension_id, safe='')}/syncs/{quote(batch_id, safe='')}/retry\"", "source": "sdks/python/src/q_client/extensions.py", "transport": "post_json" } ], "typescript": [ { "path": "`/extensions/${encodeURIComponent(id)}/syncs/${encodeURIComponent(batch)}/retry`", "source": "sdks/typescript/src/extensions.ts", "transport": "postJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-stability": "alpha" }, "x-stability": "alpha" }, "/v1/extensions/{extension_id}/versions/{version}": { "get": { "operationId": "extensions_version", "parameters": [ { "in": "path", "name": "extension_id", "required": true, "schema": { "format": "uuid", "title": "Extension Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtensionManifest" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Version", "tags": [ "Extensions" ], "x-q-capability": { "id": "GET /v1/extensions/{extension_id}/versions/{version}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": { "include_memory": "memory:read" }, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "explicit", "scopes": [ "extensions:read" ], "settings": [ "EXTENSIONS_API_ENABLED" ], "stability": "alpha", "tenant": "credential", "user": "Tenant and authenticated principal. Only owners manage registrations; explicit principal grants permit tool/skill use or connector sync. Versions and revocations are revalidated at use." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "f\"/extensions/{quote(extension_id, safe='')}/versions/{quote(version, safe='')}\"", "source": "sdks/python/src/q_client/extensions.py", "transport": "get_json" } ], "typescript": [ { "path": "`/extensions/${encodeURIComponent(id)}/versions/${encodeURIComponent(version)}`", "source": "sdks/typescript/src/extensions.ts", "transport": "getJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-stability": "alpha" }, "x-stability": "alpha" }, "/v1/health/tenant": { "get": { "description": "Returns retrieval callback latency, MCP tool success rates, Answer Engine stream completion rates, and budget utilisation for the authenticated tenant.", "operationId": "tenant_health_v1_health_tenant_get", "parameters": [ { "in": "query", "name": "window_hours", "required": false, "schema": { "default": 24, "maximum": 168, "minimum": 1, "title": "Window Hours", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantHealth" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Tenant-scoped health metrics", "tags": [ "Tenant Health" ], "x-q-capability": { "id": "GET /v1/health/tenant", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide aggregate metrics; ai:answer scope is required." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Tenant Health", "Tenant Health" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/hooks": { "get": { "operationId": "list_hooks_v1_hooks_get", "parameters": [ { "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" } }, { "in": "query", "name": "event_type", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/HookEventType" }, { "type": "null" } ], "title": "Event Type" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HookList" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "List Hooks", "tags": [ "Hooks" ], "x-q-capability": { "id": "GET /v1/hooks", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide; resource-specific permissions still apply." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "'/hooks'", "source": "sdks/python/src/q_client/hooks.py", "transport": "get_json" } ], "typescript": [ { "path": "\"/hooks\"", "source": "sdks/typescript/src/hooks.ts", "transport": "getJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Hooks", "Hooks" ], "x-stability": "beta" }, "post": { "operationId": "create_hook_v1_hooks_post", "parameters": [ { "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HookCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HookResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Create Hook", "tags": [ "Hooks" ], "x-q-capability": { "id": "POST /v1/hooks", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide; resource-specific permissions still apply." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "'/hooks'", "source": "sdks/python/src/q_client/hooks.py", "transport": "post_json" } ], "typescript": [ { "path": "\"/hooks\"", "source": "sdks/typescript/src/hooks.ts", "transport": "postJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Hooks", "Hooks" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/hooks/test": { "post": { "operationId": "test_hook_v1_hooks_test_post", "parameters": [ { "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HookTestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HookExecution" }, { "$ref": "#/components/schemas/HookExecutions" } ], "title": "Response Test Hook V1 Hooks Test Post" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Test Hook", "tags": [ "Hooks" ], "x-q-capability": { "id": "POST /v1/hooks/test", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide; resource-specific permissions still apply." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Hooks", "Hooks" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/hooks/{hook_id}": { "delete": { "operationId": "delete_hook_v1_hooks__hook_id__delete", "parameters": [ { "in": "path", "name": "hook_id", "required": true, "schema": { "format": "uuid", "title": "Hook Id", "type": "string" } }, { "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Delete Hook", "tags": [ "Hooks" ], "x-q-capability": { "id": "DELETE /v1/hooks/{hook_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide; resource-specific permissions still apply." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "f'/hooks/{hook_id}'", "source": "sdks/python/src/q_client/hooks.py", "transport": "delete_request" } ], "typescript": [ { "path": "`/hooks/${encodeURIComponent(hookId)}`", "source": "sdks/typescript/src/hooks.ts", "transport": "deleteRequest" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Hooks", "Hooks" ], "x-stability": "beta" }, "get": { "operationId": "get_hook_v1_hooks__hook_id__get", "parameters": [ { "in": "path", "name": "hook_id", "required": true, "schema": { "format": "uuid", "title": "Hook Id", "type": "string" } }, { "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HookResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Hook", "tags": [ "Hooks" ], "x-q-capability": { "id": "GET /v1/hooks/{hook_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide; resource-specific permissions still apply." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "f'/hooks/{hook_id}'", "source": "sdks/python/src/q_client/hooks.py", "transport": "get_json" } ], "typescript": [ { "path": "`/hooks/${encodeURIComponent(hookId)}`", "source": "sdks/typescript/src/hooks.ts", "transport": "getJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Hooks", "Hooks" ], "x-stability": "beta" }, "put": { "operationId": "update_hook_v1_hooks__hook_id__put", "parameters": [ { "in": "path", "name": "hook_id", "required": true, "schema": { "format": "uuid", "title": "Hook Id", "type": "string" } }, { "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HookUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HookResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Update Hook", "tags": [ "Hooks" ], "x-q-capability": { "id": "PUT /v1/hooks/{hook_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide; resource-specific permissions still apply." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Hooks", "Hooks" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/knowledge/context": { "post": { "operationId": "knowledge_context", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeContextRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeContextResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Knowledge Context", "tags": [ "Knowledge" ], "x-q-capability": { "id": "POST /v1/knowledge/context", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": { "include_memory": "memory:read" }, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "explicit", "scopes": [ "ai:search" ], "settings": [ "HEADLESS_API_ENABLED" ], "stability": "beta", "tenant": "credential", "user": "Current principal, space and source permissions apply; configured endpoint credentials are never accepted from retrieval requests." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "'/knowledge/context'", "source": "sdks/python/src/q_client/knowledge.py", "transport": "post_json" } ], "typescript": [ { "path": "\"/knowledge/context\"", "source": "sdks/typescript/src/knowledge.ts", "transport": "postJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-stability": "beta" }, "x-stability": "beta" }, "/v1/knowledge/documents": { "post": { "operationId": "knowledge_document", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeDocumentRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactReceipt" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Knowledge Document", "tags": [ "Knowledge" ], "x-q-capability": { "id": "POST /v1/knowledge/documents", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": { "retrieval": "ai:search" }, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "explicit", "scopes": [ "ai:generate" ], "settings": [ "HEADLESS_API_ENABLED" ], "stability": "beta", "tenant": "credential", "user": "Current principal, space and source permissions apply; configured endpoint credentials are never accepted from retrieval requests." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "'/knowledge/documents'", "source": "sdks/python/src/q_client/knowledge.py", "transport": "post_json" } ], "typescript": [ { "path": "\"/knowledge/documents\"", "source": "sdks/typescript/src/knowledge.ts", "transport": "postJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-stability": "beta" }, "x-stability": "beta" }, "/v1/knowledge/extract": { "post": { "operationId": "knowledge_extract", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeExtractRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeExtractResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Knowledge Extract", "tags": [ "Knowledge" ], "x-q-capability": { "id": "POST /v1/knowledge/extract", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": { "retrieval": "ai:search" }, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "explicit", "scopes": [ "ai:generate" ], "settings": [ "HEADLESS_API_ENABLED" ], "stability": "beta", "tenant": "credential", "user": "Current principal, space and source permissions apply; configured endpoint credentials are never accepted from retrieval requests." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "'/knowledge/extract'", "source": "sdks/python/src/q_client/knowledge.py", "transport": "post_json" } ], "typescript": [ { "path": "\"/knowledge/extract\"", "source": "sdks/typescript/src/knowledge.ts", "transport": "postJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-stability": "beta" }, "x-stability": "beta" }, "/v1/knowledge/retrieve": { "post": { "operationId": "knowledge_retrieve", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeRetrieveRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeRetrieveResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Knowledge Retrieve", "tags": [ "Knowledge" ], "x-q-capability": { "id": "POST /v1/knowledge/retrieve", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": { "include_memory": "memory:read" }, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "explicit", "scopes": [ "ai:search" ], "settings": [ "HEADLESS_API_ENABLED" ], "stability": "beta", "tenant": "credential", "user": "Current principal, space and source permissions apply; configured endpoint credentials are never accepted from retrieval requests." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "'/knowledge/retrieve'", "source": "sdks/python/src/q_client/knowledge.py", "transport": "post_json" } ], "typescript": [ { "path": "\"/knowledge/retrieve\"", "source": "sdks/typescript/src/knowledge.ts", "transport": "postJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-stability": "beta" }, "x-stability": "beta" }, "/v1/knowledge/sources": { "get": { "operationId": "knowledge_sources", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeSources" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Knowledge Sources", "tags": [ "Knowledge" ], "x-q-capability": { "id": "GET /v1/knowledge/sources", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": { "include_memory": "memory:read" }, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "explicit", "scopes": [ "ai:search" ], "settings": [ "HEADLESS_API_ENABLED" ], "stability": "beta", "tenant": "credential", "user": "Current principal, space and source permissions apply; configured endpoint credentials are never accepted from retrieval requests." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "'/knowledge/sources'", "source": "sdks/python/src/q_client/knowledge.py", "transport": "get_json" } ], "typescript": [ { "path": "\"/knowledge/sources\"", "source": "sdks/typescript/src/knowledge.ts", "transport": "getJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-stability": "beta" }, "x-stability": "beta" }, "/v1/logs": { "get": { "operationId": "list_request_logs_v1_logs_get", "parameters": [ { "description": "Pagination cursor", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pagination cursor", "title": "Cursor" } }, { "in": "query", "name": "limit", "required": false, "schema": { "anyOf": [ { "maximum": 100, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": 20, "title": "Limit" } }, { "description": "1h, 6h, 24h, or 7d", "in": "query", "name": "time_range", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "1h, 6h, 24h, or 7d", "title": "Time Range" } }, { "in": "query", "name": "status_code", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Status Code" } }, { "description": "Path prefix filter", "in": "query", "name": "endpoint", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Path prefix filter", "title": "Endpoint" } }, { "in": "query", "name": "error_code", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Code" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPage_RequestLogSummary_" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "List request logs for the authenticated API key", "tags": [ "Request Logs" ], "x-q-capability": { "id": "GET /v1/logs", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant request logs, additionally filtered by API key hash when present." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "data": "data", "maximum_limit": 100, "mode": "cursor", "next": "next_cursor", "previous": "previous_cursor" }, "x-q-tags": [ "Request Logs", "Request Logs" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/logs/{request_id}": { "get": { "operationId": "get_request_log_v1_logs__request_id__get", "parameters": [ { "in": "path", "name": "request_id", "required": true, "schema": { "title": "Request Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestLogDetail" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Get a specific request log", "tags": [ "Request Logs" ], "x-q-capability": { "id": "GET /v1/logs/{request_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant request logs, additionally filtered by API key hash when present." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Request Logs", "Request Logs" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/mcp": { "delete": { "operationId": "mcp_http_delete_v1_mcp_delete", "responses": { "200": { "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/JsonRpcFailure" }, { "$ref": "#/components/schemas/UnifiedErrorEnvelope" } ] } } }, "description": "MCP transport error or Q authentication/admission error", "x-q-error-contract": "mcp-or-q" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/JsonRpcFailure" }, { "$ref": "#/components/schemas/UnifiedErrorEnvelope" } ] } } }, "description": "MCP transport error or Q authentication/admission error", "x-q-error-contract": "mcp-or-q" }, "404": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/JsonRpcFailure" }, { "$ref": "#/components/schemas/UnifiedErrorEnvelope" } ] } } }, "description": "MCP transport error or Q authentication/admission error", "x-q-error-contract": "mcp-or-q" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "406": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/JsonRpcFailure" }, { "$ref": "#/components/schemas/UnifiedErrorEnvelope" } ] } } }, "description": "MCP transport error or Q authentication/admission error", "x-q-error-contract": "mcp-or-q" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/JsonRpcFailure" }, { "$ref": "#/components/schemas/UnifiedErrorEnvelope" } ] } } }, "description": "MCP transport error or Q authentication/admission error", "x-q-error-contract": "mcp-or-q" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/JsonRpcFailure" }, { "$ref": "#/components/schemas/UnifiedErrorEnvelope" } ] } } }, "description": "MCP transport error or Q authentication/admission error", "x-q-error-contract": "mcp-or-q" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/JsonRpcFailure" }, { "$ref": "#/components/schemas/UnifiedErrorEnvelope" } ] } } }, "description": "MCP transport error or Q authentication/admission error", "x-q-error-contract": "mcp-or-q" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/JsonRpcFailure" }, { "$ref": "#/components/schemas/UnifiedErrorEnvelope" } ] } } }, "description": "MCP transport error or Q authentication/admission error", "x-q-error-contract": "mcp-or-q" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Mcp Http Delete", "tags": [ "MCP Server HTTP" ], "x-q-capability": { "id": "DELETE /v1/mcp", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": { "tools/call:other": "ai:answer", "tools/call:q_list_spaces": "ai:search", "tools/call:q_search": "ai:search", "tools/call:q_space_search": "ai:search" }, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [], "settings": [ "MCP_SERVER_PROFILE_ENABLED" ], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Authenticated tenant and owner derived by DataAccess; API key identity is separate from end-user identity." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-mcp": { "preferredVersion": "2025-11-25", "requestBody": "one JSON-RPC message; batches unsupported", "sessionAffinityRequired": true, "supportedVersions": [ "2025-03-26", "2025-06-18", "2025-11-25" ], "transport": "streamable-http" }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "MCP Server HTTP", "MCP Servers" ], "x-stability": "beta" }, "get": { "operationId": "mcp_http_get_v1_mcp_get", "responses": { "400": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/JsonRpcFailure" }, { "$ref": "#/components/schemas/UnifiedErrorEnvelope" } ] } } }, "description": "MCP transport error or Q authentication/admission error", "x-q-error-contract": "mcp-or-q" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/JsonRpcFailure" }, { "$ref": "#/components/schemas/UnifiedErrorEnvelope" } ] } } }, "description": "MCP transport error or Q authentication/admission error", "x-q-error-contract": "mcp-or-q" }, "404": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/JsonRpcFailure" }, { "$ref": "#/components/schemas/UnifiedErrorEnvelope" } ] } } }, "description": "MCP transport error or Q authentication/admission error", "x-q-error-contract": "mcp-or-q" }, "405": { "description": "Successful Response" }, "406": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/JsonRpcFailure" }, { "$ref": "#/components/schemas/UnifiedErrorEnvelope" } ] } } }, "description": "MCP transport error or Q authentication/admission error", "x-q-error-contract": "mcp-or-q" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/JsonRpcFailure" }, { "$ref": "#/components/schemas/UnifiedErrorEnvelope" } ] } } }, "description": "MCP transport error or Q authentication/admission error", "x-q-error-contract": "mcp-or-q" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/JsonRpcFailure" }, { "$ref": "#/components/schemas/UnifiedErrorEnvelope" } ] } } }, "description": "MCP transport error or Q authentication/admission error", "x-q-error-contract": "mcp-or-q" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/JsonRpcFailure" }, { "$ref": "#/components/schemas/UnifiedErrorEnvelope" } ] } } }, "description": "MCP transport error or Q authentication/admission error", "x-q-error-contract": "mcp-or-q" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/JsonRpcFailure" }, { "$ref": "#/components/schemas/UnifiedErrorEnvelope" } ] } } }, "description": "MCP transport error or Q authentication/admission error", "x-q-error-contract": "mcp-or-q" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Mcp Http Get", "tags": [ "MCP Server HTTP" ], "x-q-capability": { "id": "GET /v1/mcp", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": { "tools/call:other": "ai:answer", "tools/call:q_list_spaces": "ai:search", "tools/call:q_search": "ai:search", "tools/call:q_space_search": "ai:search" }, "disabled_reason": "Standalone server-initiated SSE and resumption are not supported; GET returns 405.", "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [], "settings": [ "MCP_SERVER_PROFILE_ENABLED" ], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Authenticated tenant and owner derived by DataAccess; API key identity is separate from end-user identity." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-mcp": { "preferredVersion": "2025-11-25", "requestBody": "one JSON-RPC message; batches unsupported", "sessionAffinityRequired": true, "supportedVersions": [ "2025-03-26", "2025-06-18", "2025-11-25" ], "transport": "streamable-http" }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "MCP Server HTTP", "MCP Servers" ], "x-stability": "beta" }, "post": { "operationId": "mcp_http_endpoint_v1_mcp_post", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "jsonrpc": { "const": "2.0", "default": "2.0", "title": "Jsonrpc", "type": "string" }, "method": { "maxLength": 256, "minLength": 1, "title": "Method", "type": "string" }, "params": { "additionalProperties": true, "title": "Params", "type": "object" } }, "required": [ "method" ], "title": "JsonRpcRequest", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/JsonRpcSuccess" }, { "$ref": "#/components/schemas/JsonRpcFailure" } ], "title": "Response Mcp Http Endpoint V1 Mcp Post" } }, "text/event-stream": { "schema": { "type": "string" } } }, "description": "Successful Response" }, "202": { "description": "Notification accepted; empty body" }, "400": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/JsonRpcFailure" }, { "$ref": "#/components/schemas/UnifiedErrorEnvelope" } ] } } }, "description": "MCP transport error or Q authentication/admission error", "x-q-error-contract": "mcp-or-q" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/JsonRpcFailure" }, { "$ref": "#/components/schemas/UnifiedErrorEnvelope" } ] } } }, "description": "MCP transport error or Q authentication/admission error", "x-q-error-contract": "mcp-or-q" }, "404": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/JsonRpcFailure" }, { "$ref": "#/components/schemas/UnifiedErrorEnvelope" } ] } } }, "description": "MCP transport error or Q authentication/admission error", "x-q-error-contract": "mcp-or-q" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "406": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/JsonRpcFailure" }, { "$ref": "#/components/schemas/UnifiedErrorEnvelope" } ] } } }, "description": "MCP transport error or Q authentication/admission error", "x-q-error-contract": "mcp-or-q" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/JsonRpcFailure" }, { "$ref": "#/components/schemas/UnifiedErrorEnvelope" } ] } } }, "description": "MCP transport error or Q authentication/admission error", "x-q-error-contract": "mcp-or-q" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/JsonRpcFailure" }, { "$ref": "#/components/schemas/UnifiedErrorEnvelope" } ] } } }, "description": "MCP transport error or Q authentication/admission error", "x-q-error-contract": "mcp-or-q" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/JsonRpcFailure" }, { "$ref": "#/components/schemas/UnifiedErrorEnvelope" } ] } } }, "description": "MCP transport error or Q authentication/admission error", "x-q-error-contract": "mcp-or-q" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/JsonRpcFailure" }, { "$ref": "#/components/schemas/UnifiedErrorEnvelope" } ] } } }, "description": "MCP transport error or Q authentication/admission error", "x-q-error-contract": "mcp-or-q" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Mcp Http Endpoint", "tags": [ "MCP Server HTTP" ], "x-q-capability": { "id": "POST /v1/mcp", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": { "tools/call:other": "ai:answer", "tools/call:q_list_spaces": "ai:search", "tools/call:q_search": "ai:search", "tools/call:q_space_search": "ai:search" }, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [], "settings": [ "MCP_SERVER_PROFILE_ENABLED" ], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Authenticated tenant and owner derived by DataAccess; API key identity is separate from end-user identity." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-mcp": { "preferredVersion": "2025-11-25", "requestBody": "one JSON-RPC message; batches unsupported", "sessionAffinityRequired": true, "supportedVersions": [ "2025-03-26", "2025-06-18", "2025-11-25" ], "transport": "streamable-http" }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "MCP Server HTTP", "MCP Servers" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/mcp/chat/completions": { "post": { "description": "Create a chat completion with MCP tool support.\n\nThis endpoint starts a Temporal workflow and returns immediately\nwith a job_id. Client polls GET /mcp/jobs/{job_id} for the result.\n\nWhy async/job pattern?\n- Agentic loops with multiple tool calls can take minutes\n- Gateway timeouts (30-60s) would kill long-running requests\n- Temporal provides durability and observability", "operationId": "create_mcp_chat_completion_v1_mcp_chat_completions_post", "parameters": [ { "description": "Tenant ID (CUID from Route Royal)", "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tenant ID (CUID from Route Royal)", "title": "Tenant Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpChatCompletionRequest" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpChatCompletionJobResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Create a chat completion with MCP tool support", "tags": [ "MCP" ], "x-q-capability": { "id": "POST /v1/mcp/chat/completions", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "custom_agents" ], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide MCP registration and job access; outbound endpoint policy applies." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "MCP", "MCP" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/mcp/jobs": { "get": { "description": "List MCP agent jobs for the current tenant.", "operationId": "list_mcp_agent_jobs_v1_mcp_jobs_get", "parameters": [ { "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/McpJobStatus" }, { "type": "null" } ], "title": "Status" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "Tenant ID (CUID from Route Royal)", "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tenant ID (CUID from Route Royal)", "title": "Tenant Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/McpAgentJobResponse" }, "title": "Response List Mcp Agent Jobs V1 Mcp Jobs Get", "type": "array" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "List MCP agent jobs", "tags": [ "MCP" ], "x-q-capability": { "id": "GET /v1/mcp/jobs", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "custom_agents" ], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide MCP registration and job access; outbound endpoint policy applies." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "MCP", "MCP" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/mcp/jobs/{job_id}": { "get": { "description": "Get the status and result of an MCP agent job.\n\nPoll this endpoint to check job progress and retrieve the final result.", "operationId": "get_mcp_agent_job_v1_mcp_jobs__job_id__get", "parameters": [ { "description": "Job ID", "in": "path", "name": "job_id", "required": true, "schema": { "description": "Job ID", "format": "uuid", "title": "Job Id", "type": "string" } }, { "description": "Tenant ID (CUID from Route Royal)", "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tenant ID (CUID from Route Royal)", "title": "Tenant Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpAgentJobResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Get MCP agent job status and result", "tags": [ "MCP" ], "x-q-capability": { "id": "GET /v1/mcp/jobs/{job_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "custom_agents" ], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide MCP registration and job access; outbound endpoint policy applies." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "MCP", "MCP" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/mcp/jobs/{job_id}/cancel": { "post": { "description": "Cancel a pending or running MCP agent job.\n\nThis marks the job as cancelled. If the workflow is already running,\nit will be terminated on the next heartbeat.", "operationId": "cancel_mcp_agent_job_v1_mcp_jobs__job_id__cancel_post", "parameters": [ { "description": "Job ID", "in": "path", "name": "job_id", "required": true, "schema": { "description": "Job ID", "format": "uuid", "title": "Job Id", "type": "string" } }, { "description": "Tenant ID (CUID from Route Royal)", "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tenant ID (CUID from Route Royal)", "title": "Tenant Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpCancellation" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Cancel an MCP agent job", "tags": [ "MCP" ], "x-q-capability": { "id": "POST /v1/mcp/jobs/{job_id}/cancel", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "custom_agents" ], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide MCP registration and job access; outbound endpoint policy applies." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "MCP", "MCP" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/mcp/jobs/{job_id}/stream": { "get": { "description": "Server-Sent Events stream for real-time MCP agent job progress.\n\nUses Redis Pub/Sub for sub-200ms latency push-based streaming,\nwith automatic fallback to database polling if Redis is unavailable.\n\nEvents emitted:\n- thinking: Agent reasoning steps\n- tool_use: Tool invocation with name and arguments\n- tool_result: Tool execution result summary\n- progress: Percentage and step description\n- complete: Final result with agent output\n- error: Error details if the job fails\n- heartbeat: Keep-alive signal (DB polling mode only)", "operationId": "stream_mcp_agent_job_v1_mcp_jobs__job_id__stream_get", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } }, { "description": "Tenant ID (CUID from Route Royal)", "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tenant ID (CUID from Route Royal)", "title": "Tenant Id" } } ], "responses": { "200": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "SSE stream for MCP agent job progress", "tags": [ "MCP" ], "x-q-capability": { "id": "GET /v1/mcp/jobs/{job_id}/stream", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "custom_agents" ], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide MCP registration and job access; outbound endpoint policy applies." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "MCP", "MCP" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/mcp/resources": { "get": { "description": "List all MCP resources available for the current tenant.\n\nResources are read-only data sources from MCP servers (e.g., files, configs).", "operationId": "list_mcp_resources_v1_mcp_resources_get", "parameters": [ { "description": "Filter by server name", "in": "query", "name": "server_name", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by server name", "title": "Server Name" } }, { "description": "Tenant ID (CUID from Route Royal)", "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tenant ID (CUID from Route Royal)", "title": "Tenant Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpResourceListResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "List all available resources for current tenant", "tags": [ "MCP" ], "x-q-capability": { "id": "GET /v1/mcp/resources", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "custom_agents" ], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide MCP registration and job access; outbound endpoint policy applies." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "MCP", "MCP" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/mcp/resources/read": { "post": { "description": "Read the content of an MCP resource.\n\nResources are cached for 1 hour by default. Use force_refresh=true to bypass cache.", "operationId": "read_mcp_resource_v1_mcp_resources_read_post", "parameters": [ { "description": "MCP server ID", "in": "query", "name": "server_id", "required": true, "schema": { "description": "MCP server ID", "format": "uuid", "title": "Server Id", "type": "string" } }, { "description": "Resource URI to read", "in": "query", "name": "resource_uri", "required": true, "schema": { "description": "Resource URI to read", "title": "Resource Uri", "type": "string" } }, { "description": "Bypass cache", "in": "query", "name": "force_refresh", "required": false, "schema": { "default": false, "description": "Bypass cache", "title": "Force Refresh", "type": "boolean" } }, { "description": "Tenant ID (CUID from Route Royal)", "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tenant ID (CUID from Route Royal)", "title": "Tenant Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpResourceContentResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Read content from an MCP resource", "tags": [ "MCP" ], "x-q-capability": { "id": "POST /v1/mcp/resources/read", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "custom_agents" ], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide MCP registration and job access; outbound endpoint policy applies." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "MCP", "MCP" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/mcp/servers": { "get": { "operationId": "public_list_mcp_servers_v1_mcp_servers_get", "parameters": [ { "description": "Only return active servers", "in": "query", "name": "active_only", "required": false, "schema": { "default": true, "description": "Only return active servers", "title": "Active Only", "type": "boolean" } }, { "description": "Filter by tags (any match)", "in": "query", "name": "tags", "required": false, "schema": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Filter by tags (any match)", "title": "Tags" } }, { "description": "Tenant ID (CUID from Route Royal)", "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tenant ID (CUID from Route Royal)", "title": "Tenant Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/app__models__mcp_schemas__McpServerListResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "List MCP servers for current tenant", "tags": [ "MCP Servers" ], "x-q-capability": { "id": "GET /v1/mcp/servers", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "custom_agents" ], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide MCP registration and job access; outbound endpoint policy applies." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "'/mcp/servers'", "source": "sdks/python/src/q_client/mcp.py", "transport": "get_json" } ], "typescript": [ { "path": "\"/mcp/servers\"", "source": "sdks/typescript/src/mcp.ts", "transport": "getJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "MCP Servers", "MCP Servers" ], "x-stability": "beta" }, "post": { "operationId": "public_create_mcp_server_v1_mcp_servers_post", "parameters": [ { "description": "Tenant ID (CUID from Route Royal)", "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tenant ID (CUID from Route Royal)", "title": "Tenant Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpServerCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpServerResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Register a new MCP server", "tags": [ "MCP Servers" ], "x-q-capability": { "id": "POST /v1/mcp/servers", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "custom_agents" ], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide MCP registration and job access; outbound endpoint policy applies." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "'/mcp/servers'", "source": "sdks/python/src/q_client/mcp.py", "transport": "post_json" } ], "typescript": [ { "path": "\"/mcp/servers\"", "source": "sdks/typescript/src/mcp.ts", "transport": "postJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "MCP Servers", "MCP Servers" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/mcp/servers/{server_id}": { "delete": { "operationId": "public_delete_mcp_server_v1_mcp_servers__server_id__delete", "parameters": [ { "description": "MCP server ID", "in": "path", "name": "server_id", "required": true, "schema": { "description": "MCP server ID", "format": "uuid", "title": "Server Id", "type": "string" } }, { "description": "Tenant ID (CUID from Route Royal)", "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tenant ID (CUID from Route Royal)", "title": "Tenant Id" } } ], "responses": { "204": { "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Remove an MCP server", "tags": [ "MCP Servers" ], "x-q-capability": { "id": "DELETE /v1/mcp/servers/{server_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "custom_agents" ], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide MCP registration and job access; outbound endpoint policy applies." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "f'/mcp/servers/{server_id}'", "source": "sdks/python/src/q_client/mcp.py", "transport": "delete_request" } ], "typescript": [ { "path": "`/mcp/servers/${encodeURIComponent(serverId)}`", "source": "sdks/typescript/src/mcp.ts", "transport": "deleteRequest" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "MCP Servers", "MCP Servers" ], "x-stability": "beta" }, "get": { "description": "Get details for a specific MCP server.", "operationId": "get_mcp_server_v1_mcp_servers__server_id__get", "parameters": [ { "description": "MCP server ID", "in": "path", "name": "server_id", "required": true, "schema": { "description": "MCP server ID", "format": "uuid", "title": "Server Id", "type": "string" } }, { "description": "Tenant ID (CUID from Route Royal)", "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tenant ID (CUID from Route Royal)", "title": "Tenant Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpServerResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Get MCP server details", "tags": [ "MCP" ], "x-q-capability": { "id": "GET /v1/mcp/servers/{server_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "custom_agents" ], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide MCP registration and job access; outbound endpoint policy applies." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "MCP", "MCP" ], "x-stability": "beta" }, "patch": { "description": "Update an MCP server's configuration.", "operationId": "update_mcp_server_v1_mcp_servers__server_id__patch", "parameters": [ { "description": "MCP server ID", "in": "path", "name": "server_id", "required": true, "schema": { "description": "MCP server ID", "format": "uuid", "title": "Server Id", "type": "string" } }, { "description": "Tenant ID (CUID from Route Royal)", "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tenant ID (CUID from Route Royal)", "title": "Tenant Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpServerUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpServerResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Update MCP server configuration", "tags": [ "MCP" ], "x-q-capability": { "id": "PATCH /v1/mcp/servers/{server_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "custom_agents" ], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide MCP registration and job access; outbound endpoint policy applies." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "MCP", "MCP" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/mcp/servers/{server_id}/refresh": { "post": { "description": "Refresh the cached capabilities (tools, resources) from an MCP server.\n\nThis connects to the MCP server and fetches the latest tool/resource definitions.", "operationId": "refresh_mcp_server_capabilities_v1_mcp_servers__server_id__refresh_post", "parameters": [ { "description": "MCP server ID", "in": "path", "name": "server_id", "required": true, "schema": { "description": "MCP server ID", "format": "uuid", "title": "Server Id", "type": "string" } }, { "description": "Tenant ID (CUID from Route Royal)", "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tenant ID (CUID from Route Royal)", "title": "Tenant Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpRefreshCapabilitiesResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Refresh cached capabilities from MCP server", "tags": [ "MCP" ], "x-q-capability": { "id": "POST /v1/mcp/servers/{server_id}/refresh", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "custom_agents" ], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide MCP registration and job access; outbound endpoint policy applies." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "MCP", "MCP" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/mcp/servers/{server_id}/tools": { "get": { "operationId": "public_list_mcp_server_tools_v1_mcp_servers__server_id__tools_get", "parameters": [ { "description": "MCP server ID", "in": "path", "name": "server_id", "required": true, "schema": { "description": "MCP server ID", "format": "uuid", "title": "Server Id", "type": "string" } }, { "description": "Tenant ID (CUID from Route Royal)", "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tenant ID (CUID from Route Royal)", "title": "Tenant Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpToolListResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "List tools exposed by an MCP server", "tags": [ "MCP Servers" ], "x-q-capability": { "id": "GET /v1/mcp/servers/{server_id}/tools", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "custom_agents" ], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide MCP registration and job access; outbound endpoint policy applies." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "MCP Servers", "MCP Servers" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/mcp/tools": { "get": { "description": "List all MCP tools available for the current tenant.\n\nTools are aggregated from all active MCP servers and cached.", "operationId": "list_mcp_tools_v1_mcp_tools_get", "parameters": [ { "description": "Filter by server name", "in": "query", "name": "server_name", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by server name", "title": "Server Name" } }, { "description": "Tenant ID (CUID from Route Royal)", "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tenant ID (CUID from Route Royal)", "title": "Tenant Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpToolListResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "List all available tools for current tenant", "tags": [ "MCP" ], "x-q-capability": { "id": "GET /v1/mcp/tools", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "custom_agents" ], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide MCP registration and job access; outbound endpoint policy applies." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "'/mcp/tools'", "source": "sdks/python/src/q_client/mcp.py", "transport": "get_json" } ], "typescript": [ { "path": "\"/mcp/tools\"", "source": "sdks/typescript/src/mcp.ts", "transport": "getJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "MCP", "MCP" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/memory": { "get": { "operationId": "list_user_memory_v1_memory_get", "parameters": [ { "in": "query", "name": "category", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 200, "maximum": 500, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemoryListResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "List User Memory", "tags": [ "Memory" ], "x-q-capability": { "id": "GET /v1/memory", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Authenticated tenant and owner derived by DataAccess; API key identity is separate from end-user identity." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "'/memory'", "source": "sdks/python/src/q_client/memory.py", "transport": "get_json" } ], "typescript": [ { "path": "\"/memory\"", "source": "sdks/typescript/src/memory.ts", "transport": "getJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Memory", "Memory" ], "x-stability": "beta" }, "post": { "operationId": "create_user_memory_v1_memory_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/app__api__memory__MemoryCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemoryModel" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Create User Memory", "tags": [ "Memory" ], "x-q-capability": { "id": "POST /v1/memory", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Authenticated tenant and owner derived by DataAccess; API key identity is separate from end-user identity." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "'/memory'", "source": "sdks/python/src/q_client/memory.py", "transport": "post_json" } ], "typescript": [ { "path": "\"/memory\"", "source": "sdks/typescript/src/memory.ts", "transport": "postJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Memory", "Memory" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/memory/{memory_id}": { "delete": { "operationId": "delete_user_memory_v1_memory__memory_id__delete", "parameters": [ { "in": "path", "name": "memory_id", "required": true, "schema": { "title": "Memory Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Delete User Memory", "tags": [ "Memory" ], "x-q-capability": { "id": "DELETE /v1/memory/{memory_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Authenticated tenant and owner derived by DataAccess; API key identity is separate from end-user identity." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "f\"/memory/{quote(memory_id, safe='')}\"", "source": "sdks/python/src/q_client/memory.py", "transport": "delete_request" } ], "typescript": [ { "path": "`/memory/${encodeURIComponent(id)}`", "source": "sdks/typescript/src/memory.ts", "transport": "request" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Memory", "Memory" ], "x-stability": "beta" }, "patch": { "operationId": "update_user_memory_v1_memory__memory_id__patch", "parameters": [ { "in": "path", "name": "memory_id", "required": true, "schema": { "title": "Memory Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemoryUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemoryModel" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Update User Memory", "tags": [ "Memory" ], "x-q-capability": { "id": "PATCH /v1/memory/{memory_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Authenticated tenant and owner derived by DataAccess; API key identity is separate from end-user identity." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "f\"/memory/{quote(memory_id, safe='')}\"", "source": "sdks/python/src/q_client/memory.py", "transport": "patch_json" } ], "typescript": [ { "path": "`/memory/${encodeURIComponent(id)}`", "source": "sdks/typescript/src/memory.ts", "transport": "request" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Memory", "Memory" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/models": { "get": { "description": "List all available models with their capabilities and pricing.\n\nThis endpoint is public and does not require authentication.\nReturns models that are configured and enabled in Q.\n\nFor providers like Gemini, we query their ListModels API to get\nactual valid model names, avoiding LiteLLM aliases that may not work.", "operationId": "list_models_v1_models_get", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ModelInfo" }, "title": "Response List Models V1 Models Get", "type": "array" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [], "summary": "List Models", "tags": [ "Platform" ], "x-q-capability": { "id": "GET /v1/models", "policy": { "audience": "public", "auth": "anonymous", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "stable", "tenant": "none", "user": "No user or tenant context." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Platform", "Platform" ], "x-stability": "stable" }, "x-stability": "stable" }, "/v1/models/meta": { "get": { "description": "Unified model meta-router: resolves the best model for a purpose.\n\nReturns the resolved model id, fallbacks, and governance status for the\nauthenticated tenant. Consumers should call this before making a chat\nrequest to discover which model to use.\n\nQuery params:\n purpose: ``default``, ``fast``, ``vision``, ``precision``,\n ``embedding``, ``high_context``, etc.", "operationId": "model_meta_router_v1_models_meta_get", "parameters": [ { "in": "query", "name": "purpose", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Purpose" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelRouting" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Model Meta Router", "tags": [ "Platform" ], "x-q-capability": { "id": "GET /v1/models/meta", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "none", "user": "Authenticated model metadata; no user data." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Platform", "Platform" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/openapi.public.json": { "get": { "description": "A registry-selected view of /openapi.json. Capability prerequisites and source-level SDK coverage are available at /v1/capabilities.", "operationId": "public_openapi_v1_openapi_public_json_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenAPIDocument" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [], "summary": "OpenAPI spec for the public (third-party) API surfaces", "tags": [ "OpenAPI" ], "x-q-capability": { "id": "GET /v1/openapi.public.json", "policy": { "audience": "public", "auth": "anonymous", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "stable", "tenant": "none", "user": "No user or tenant context." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "OpenAPI", "OpenAPI" ], "x-stability": "stable" }, "x-stability": "stable" }, "/v1/pages/{page_id}": { "get": { "operationId": "public_get_page_v1_pages__page_id__get", "parameters": [ { "in": "path", "name": "page_id", "required": true, "schema": { "title": "Page Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Get a Page by id", "tags": [ "Pages" ], "x-q-capability": { "id": "GET /v1/pages/{page_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "pages_publish" ], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Authenticated owner or explicit space collaborator; private content requires resource access." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "f'/pages/{page_id}'", "source": "sdks/python/src/q_client/pages.py", "transport": "get_json" } ], "typescript": [ { "path": "`/pages/${encodeURIComponent(pageId)}`", "source": "sdks/typescript/src/pages.ts", "transport": "getJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Pages", "Pages" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/persona": { "get": { "operationId": "public_get_persona_v1_persona_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonaResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Public Get Persona", "tags": [ "Persona" ], "x-q-capability": { "id": "GET /v1/persona", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Authenticated user_id/sub when present; otherwise tenant-wide default persona." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Persona", "Persona" ], "x-stability": "beta" }, "put": { "operationId": "public_upsert_persona_v1_persona_put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonaUpsert" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonaResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Public Upsert Persona", "tags": [ "Persona" ], "x-q-capability": { "id": "PUT /v1/persona", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Authenticated user_id/sub when present; otherwise tenant-wide default persona." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Persona", "Persona" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/plans": { "get": { "operationId": "list_plans_v1_plans_get", "parameters": [ { "in": "query", "name": "workspace_id", "required": true, "schema": { "title": "Workspace Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanList" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "List saved execution plans in a workspace", "tags": [ "Answer Engine" ], "x-q-capability": { "id": "GET /v1/plans", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant and authenticated user/principal; delegated users require identity:delegate or *. Workspace grants and run approval ownership are checked separately." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Answer Engine", "Answer Engine" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/plans/{plan_id}": { "delete": { "operationId": "delete_plan_v1_plans__plan_id__delete", "parameters": [ { "in": "path", "name": "plan_id", "required": true, "schema": { "title": "Plan Id", "type": "string" } }, { "in": "query", "name": "workspace_id", "required": true, "schema": { "title": "Workspace Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanDeleted" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Delete a saved execution plan", "tags": [ "Answer Engine" ], "x-q-capability": { "id": "DELETE /v1/plans/{plan_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant and authenticated user/principal; delegated users require identity:delegate or *. Workspace grants and run approval ownership are checked separately." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Answer Engine", "Answer Engine" ], "x-stability": "beta" }, "get": { "operationId": "get_plan_v1_plans__plan_id__get", "parameters": [ { "in": "path", "name": "plan_id", "required": true, "schema": { "title": "Plan Id", "type": "string" } }, { "in": "query", "name": "workspace_id", "required": true, "schema": { "title": "Workspace Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Load a saved execution plan", "tags": [ "Answer Engine" ], "x-q-capability": { "id": "GET /v1/plans/{plan_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant and authenticated user/principal; delegated users require identity:delegate or *. Workspace grants and run approval ownership are checked separately." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Answer Engine", "Answer Engine" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/providers": { "get": { "description": "List all available providers with their configuration status.\n\nThis endpoint is public and does not require authentication.\nReturns providers that are available in Q.", "operationId": "list_providers_v1_providers_get", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ProviderInfo" }, "title": "Response List Providers V1 Providers Get", "type": "array" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [], "summary": "List Providers", "tags": [ "Platform" ], "x-q-capability": { "id": "GET /v1/providers", "policy": { "audience": "public", "auth": "anonymous", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "stable", "tenant": "none", "user": "No user or tenant context." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Platform", "Platform" ], "x-stability": "stable" }, "x-stability": "stable" }, "/v1/retrieval-quality-config": { "get": { "description": "Return the effective retrieval quality config for the caller's tenant.", "operationId": "get_retrieval_quality_config_v1_retrieval_quality_config_get", "parameters": [ { "description": "Tenant ID (CUID from Route Royal)", "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tenant ID (CUID from Route Royal)", "title": "Tenant Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievalQualityResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Retrieval Quality Config", "tags": [ "Retrieval Quality" ], "x-q-capability": { "id": "GET /v1/retrieval-quality-config", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide; resource-specific permissions still apply." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Retrieval Quality", "Retrieval Quality" ], "x-stability": "beta" }, "put": { "description": "Deep-merge primary knobs into the caller's tenant retrieval quality blob.", "operationId": "put_retrieval_quality_config_v1_retrieval_quality_config_put", "parameters": [ { "description": "Tenant ID (CUID from Route Royal)", "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tenant ID (CUID from Route Royal)", "title": "Tenant Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievalQualityPrimaryPayload" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievalQualityResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Put Retrieval Quality Config", "tags": [ "Retrieval Quality" ], "x-q-capability": { "id": "PUT /v1/retrieval-quality-config", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide; resource-specific permissions still apply." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Retrieval Quality", "Retrieval Quality" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/rules": { "get": { "operationId": "list_rules_v1_rules_get", "parameters": [ { "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" } }, { "in": "query", "name": "space_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Space Id" } }, { "in": "query", "name": "scope", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RuleScope" }, { "type": "null" } ], "title": "Scope" } }, { "in": "query", "name": "active_only", "required": false, "schema": { "default": true, "title": "Active Only", "type": "boolean" } }, { "in": "query", "name": "include_builtin", "required": false, "schema": { "default": false, "title": "Include Builtin", "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuleList" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "List Rules", "tags": [ "Rules" ], "x-q-capability": { "id": "GET /v1/rules", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide; resource-specific permissions still apply." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "'/rules'", "source": "sdks/python/src/q_client/rules.py", "transport": "get_json" } ], "typescript": [ { "path": "\"/rules\"", "source": "sdks/typescript/src/rules.ts", "transport": "getJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Rules", "Rules" ], "x-stability": "beta" }, "post": { "operationId": "create_rule_v1_rules_post", "parameters": [ { "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuleCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuleResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Create Rule", "tags": [ "Rules" ], "x-q-capability": { "id": "POST /v1/rules", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide; resource-specific permissions still apply." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "'/rules'", "source": "sdks/python/src/q_client/rules.py", "transport": "post_json" } ], "typescript": [ { "path": "\"/rules\"", "source": "sdks/typescript/src/rules.ts", "transport": "postJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Rules", "Rules" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/rules/effective": { "get": { "operationId": "effective_rules_v1_rules_effective_get", "parameters": [ { "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" } }, { "in": "query", "name": "space_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Space Id" } }, { "in": "query", "name": "task_type", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Task Type" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolvedRules" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Effective Rules", "tags": [ "Rules" ], "x-q-capability": { "id": "GET /v1/rules/effective", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide; resource-specific permissions still apply." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Rules", "Rules" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/rules/resolve": { "post": { "operationId": "resolve_rules_v1_rules_resolve_post", "parameters": [ { "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolveRulesBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolvedRules" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Resolve Rules", "tags": [ "Rules" ], "x-q-capability": { "id": "POST /v1/rules/resolve", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide; resource-specific permissions still apply." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "'/rules/resolve'", "source": "sdks/python/src/q_client/rules.py", "transport": "post_json" } ], "typescript": [ { "path": "\"/rules/resolve\"", "source": "sdks/typescript/src/rules.ts", "transport": "postJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Rules", "Rules" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/rules/{rule_id}": { "delete": { "operationId": "delete_rule_v1_rules__rule_id__delete", "parameters": [ { "in": "path", "name": "rule_id", "required": true, "schema": { "format": "uuid", "title": "Rule Id", "type": "string" } }, { "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Delete Rule", "tags": [ "Rules" ], "x-q-capability": { "id": "DELETE /v1/rules/{rule_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide; resource-specific permissions still apply." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "f'/rules/{rule_id}'", "source": "sdks/python/src/q_client/rules.py", "transport": "delete_request" } ], "typescript": [ { "path": "`/rules/${encodeURIComponent(ruleId)}`", "source": "sdks/typescript/src/rules.ts", "transport": "deleteRequest" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Rules", "Rules" ], "x-stability": "beta" }, "get": { "operationId": "get_rule_v1_rules__rule_id__get", "parameters": [ { "in": "path", "name": "rule_id", "required": true, "schema": { "format": "uuid", "title": "Rule Id", "type": "string" } }, { "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuleResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Rule", "tags": [ "Rules" ], "x-q-capability": { "id": "GET /v1/rules/{rule_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide; resource-specific permissions still apply." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "f'/rules/{rule_id}'", "source": "sdks/python/src/q_client/rules.py", "transport": "get_json" } ], "typescript": [ { "path": "`/rules/${encodeURIComponent(ruleId)}`", "source": "sdks/typescript/src/rules.ts", "transport": "getJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Rules", "Rules" ], "x-stability": "beta" }, "put": { "operationId": "update_rule_v1_rules__rule_id__put", "parameters": [ { "in": "path", "name": "rule_id", "required": true, "schema": { "format": "uuid", "title": "Rule Id", "type": "string" } }, { "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuleUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuleResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Update Rule", "tags": [ "Rules" ], "x-q-capability": { "id": "PUT /v1/rules/{rule_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide; resource-specific permissions still apply." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Rules", "Rules" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/schedules": { "get": { "operationId": "public_list_schedules_v1_schedules_get", "parameters": [ { "in": "query", "name": "status_filter", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status Filter" } }, { "description": "Tenant ID (CUID from Route Royal)", "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tenant ID (CUID from Route Royal)", "title": "Tenant Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleList" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Public List Schedules", "tags": [ "Schedules" ], "x-q-capability": { "id": "GET /v1/schedules", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [ "SCHEDULES_ENABLED" ], "stability": "alpha", "tenant": "credential_or_validated_request", "user": "Tenant-wide schedules; Temporal worker configuration required." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Schedules", "Schedules" ], "x-stability": "alpha" }, "post": { "operationId": "public_create_schedule_v1_schedules_post", "parameters": [ { "description": "Tenant ID (CUID from Route Royal)", "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tenant ID (CUID from Route Royal)", "title": "Tenant Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Public Create Schedule", "tags": [ "Schedules" ], "x-q-capability": { "id": "POST /v1/schedules", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [ "SCHEDULES_ENABLED" ], "stability": "alpha", "tenant": "credential_or_validated_request", "user": "Tenant-wide schedules; Temporal worker configuration required." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Schedules", "Schedules" ], "x-stability": "alpha" }, "x-stability": "alpha" }, "/v1/schedules/{schedule_id}": { "delete": { "operationId": "public_delete_schedule_v1_schedules__schedule_id__delete", "parameters": [ { "in": "path", "name": "schedule_id", "required": true, "schema": { "format": "uuid", "title": "Schedule Id", "type": "string" } }, { "description": "Tenant ID (CUID from Route Royal)", "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tenant ID (CUID from Route Royal)", "title": "Tenant Id" } } ], "responses": { "204": { "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Public Delete Schedule", "tags": [ "Schedules" ], "x-q-capability": { "id": "DELETE /v1/schedules/{schedule_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [ "SCHEDULES_ENABLED" ], "stability": "alpha", "tenant": "credential_or_validated_request", "user": "Tenant-wide schedules; Temporal worker configuration required." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Schedules", "Schedules" ], "x-stability": "alpha" }, "get": { "operationId": "public_get_schedule_v1_schedules__schedule_id__get", "parameters": [ { "in": "path", "name": "schedule_id", "required": true, "schema": { "format": "uuid", "title": "Schedule Id", "type": "string" } }, { "description": "Tenant ID (CUID from Route Royal)", "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tenant ID (CUID from Route Royal)", "title": "Tenant Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Public Get Schedule", "tags": [ "Schedules" ], "x-q-capability": { "id": "GET /v1/schedules/{schedule_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [ "SCHEDULES_ENABLED" ], "stability": "alpha", "tenant": "credential_or_validated_request", "user": "Tenant-wide schedules; Temporal worker configuration required." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Schedules", "Schedules" ], "x-stability": "alpha" }, "x-stability": "alpha" }, "/v1/schedules/{schedule_id}/pause": { "post": { "operationId": "public_pause_schedule_v1_schedules__schedule_id__pause_post", "parameters": [ { "in": "path", "name": "schedule_id", "required": true, "schema": { "format": "uuid", "title": "Schedule Id", "type": "string" } }, { "description": "Tenant ID (CUID from Route Royal)", "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tenant ID (CUID from Route Royal)", "title": "Tenant Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Public Pause Schedule", "tags": [ "Schedules" ], "x-q-capability": { "id": "POST /v1/schedules/{schedule_id}/pause", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [ "SCHEDULES_ENABLED" ], "stability": "alpha", "tenant": "credential_or_validated_request", "user": "Tenant-wide schedules; Temporal worker configuration required." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Schedules", "Schedules" ], "x-stability": "alpha" }, "x-stability": "alpha" }, "/v1/schedules/{schedule_id}/resume": { "post": { "operationId": "public_resume_schedule_v1_schedules__schedule_id__resume_post", "parameters": [ { "in": "path", "name": "schedule_id", "required": true, "schema": { "format": "uuid", "title": "Schedule Id", "type": "string" } }, { "description": "Tenant ID (CUID from Route Royal)", "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tenant ID (CUID from Route Royal)", "title": "Tenant Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Public Resume Schedule", "tags": [ "Schedules" ], "x-q-capability": { "id": "POST /v1/schedules/{schedule_id}/resume", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [ "SCHEDULES_ENABLED" ], "stability": "alpha", "tenant": "credential_or_validated_request", "user": "Tenant-wide schedules; Temporal worker configuration required." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Schedules", "Schedules" ], "x-stability": "alpha" }, "x-stability": "alpha" }, "/v1/search": { "post": { "operationId": "public_search_v1_search_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicSearchRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicSearchResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Search-only retrieval (enhanced modes and filters)", "tags": [ "Search API" ], "x-q-capability": { "id": "POST /v1/search", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "search_api" ], "reason": "", "scope_policy": "ai_compat", "scopes": [ "read" ], "settings": [], "stability": "stable", "tenant": "credential_or_validated_request", "user": "Authenticated user/principal determines private retrieval visibility; delegated users require separate authority." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "'/search'", "source": "sdks/python/src/q_client/search.py", "transport": "post_json" } ], "typescript": [ { "path": "\"/search\"", "source": "sdks/typescript/src/client.ts", "transport": "postJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Search API", "Search API" ], "x-stability": "stable" }, "x-stability": "stable" }, "/v1/search/semantic": { "post": { "operationId": "public_semantic_search_v1_search_semantic_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SemanticSearchRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Semantic search over indexed knowledge", "tags": [ "Semantic Search" ], "x-q-capability": { "id": "POST /v1/search/semantic", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "embeddings_api" ], "reason": "", "scope_policy": "ai_compat", "scopes": [ "read" ], "settings": [], "stability": "stable", "tenant": "credential_or_validated_request", "user": "Authenticated user/principal determines private retrieval visibility; delegated users require separate authority." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Semantic Search", "Semantic Search" ], "x-stability": "stable" }, "x-stability": "stable" }, "/v1/skills": { "get": { "operationId": "public_list_skills_v1_skills_get", "parameters": [ { "in": "query", "name": "category", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/SkillCategory" }, { "type": "null" } ], "title": "Category" } }, { "in": "query", "name": "active_only", "required": false, "schema": { "default": true, "title": "Active Only", "type": "boolean" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 2048, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "limit", "required": false, "schema": { "anyOf": [ { "maximum": 100, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": 20, "title": "Limit" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPage_SkillSummaryOut_" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Public List Skills", "tags": [ "Skills" ], "x-q-capability": { "id": "GET /v1/skills", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide; resource-specific permissions still apply." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "'/skills'", "source": "sdks/python/src/q_client/skills.py", "transport": "get_json" } ], "typescript": [ { "path": "\"/skills\"", "source": "sdks/typescript/src/skills.ts", "transport": "getJson" }, { "path": "\"/skills\"", "source": "sdks/typescript/src/skills.ts", "transport": "getJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "data": "data", "maximum_limit": 100, "mode": "cursor", "next": "next_cursor", "previous": "previous_cursor" }, "x-q-tags": [ "Skills", "Skills" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/skills-hub/browse": { "get": { "operationId": "public_browse_skills_v1_skills_hub_browse_get", "parameters": [ { "in": "query", "name": "category", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" } }, { "in": "query", "name": "search", "required": false, "schema": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "in": "query", "name": "sort_by", "required": false, "schema": { "default": "downloads", "title": "Sort By", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubSkillPage" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Public Browse Skills", "tags": [ "Skills Hub" ], "x-q-capability": { "id": "GET /v1/skills-hub/browse", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "alpha", "tenant": "credential_or_validated_request", "user": "Marketplace catalogue shared; installations scoped to the authenticated tenant." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "offset" }, "x-q-tags": [ "Skills Hub", "Skills Hub" ], "x-stability": "alpha" }, "x-stability": "alpha" }, "/v1/skills-hub/install": { "post": { "operationId": "public_install_skill_v1_skills_hub_install_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillInstall" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillInstallation" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Public Install Skill", "tags": [ "Skills Hub" ], "x-q-capability": { "id": "POST /v1/skills-hub/install", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "alpha", "tenant": "credential_or_validated_request", "user": "Marketplace catalogue shared; installations scoped to the authenticated tenant." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Skills Hub", "Skills Hub" ], "x-stability": "alpha" }, "x-stability": "alpha" }, "/v1/skills-hub/installed": { "get": { "operationId": "public_list_installed_v1_skills_hub_installed_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubSkillsInstalled" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Public List Installed", "tags": [ "Skills Hub" ], "x-q-capability": { "id": "GET /v1/skills-hub/installed", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "alpha", "tenant": "credential_or_validated_request", "user": "Marketplace catalogue shared; installations scoped to the authenticated tenant." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Skills Hub", "Skills Hub" ], "x-stability": "alpha" }, "x-stability": "alpha" }, "/v1/skills-hub/skill/{slug}": { "get": { "operationId": "public_get_skill_v1_skills_hub_skill__slug__get", "parameters": [ { "in": "path", "name": "slug", "required": true, "schema": { "title": "Slug", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubSkillResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Public Get Skill", "tags": [ "Skills Hub" ], "x-q-capability": { "id": "GET /v1/skills-hub/skill/{slug}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "alpha", "tenant": "credential_or_validated_request", "user": "Marketplace catalogue shared; installations scoped to the authenticated tenant." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Skills Hub", "Skills Hub" ], "x-stability": "alpha" }, "x-stability": "alpha" }, "/v1/skills/import": { "post": { "description": "Import a YAML skill pack for the authenticated API-key tenant.", "operationId": "public_import_skill_v1_skills_import_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillImportBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillOut" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Public Import Skill", "tags": [ "Skills" ], "x-q-capability": { "id": "POST /v1/skills/import", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide; resource-specific permissions still apply." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Skills", "Skills" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/skills/resolve": { "post": { "operationId": "public_resolve_skills_v1_skills_resolve_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillResolveRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ResolvedSkillOut" }, "title": "Response Public Resolve Skills V1 Skills Resolve Post", "type": "array" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Public Resolve Skills", "tags": [ "Skills" ], "x-q-capability": { "id": "POST /v1/skills/resolve", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide; resource-specific permissions still apply." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "'/skills/resolve'", "source": "sdks/python/src/q_client/skills.py", "transport": "post_json" } ], "typescript": [ { "path": "\"/skills/resolve\"", "source": "sdks/typescript/src/skills.ts", "transport": "postJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Skills", "Skills" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/skills/{skill_id}/export": { "get": { "description": "Export a skill as YAML (fail-closed to the caller's tenant).", "operationId": "public_export_skill_v1_skills__skill_id__export_get", "parameters": [ { "in": "path", "name": "skill_id", "required": true, "schema": { "format": "uuid", "title": "Skill Id", "type": "string" } } ], "responses": { "200": { "content": { "text/yaml": { "schema": { "type": "string" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Public Export Skill", "tags": [ "Skills" ], "x-q-capability": { "id": "GET /v1/skills/{skill_id}/export", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide; resource-specific permissions still apply." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "f'/skills/{skill_id}/export'", "source": "sdks/python/src/q_client/skills.py", "transport": "get_text" } ], "typescript": [ { "path": "`/skills/${encodeURIComponent(skillId)}/export`", "source": "sdks/typescript/src/skills.ts", "transport": "getText" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Skills", "Skills" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/sonar": { "post": { "description": "Drop-in replacement for Perplexity's /chat/completions endpoint. Accepts the same request shape (model, messages, temperature, search_context_size, ...) and returns the same response shape (choices, citations, search_results, usage).", "operationId": "sonar_chat_v1_sonar_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SonarRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SonarResponse" } }, "text/event-stream": { "schema": { "type": "string" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Sonar-compatible chat completion", "tags": [ "Sonar API" ], "x-q-capability": { "id": "POST /v1/sonar", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "sonar_api" ], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:chat" ], "settings": [], "stability": "stable", "tenant": "credential_or_validated_request", "user": "Tenant-wide; resource-specific permissions still apply." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "'/sonar'", "source": "sdks/python/src/q_client/sonar.py", "transport": "post_json" } ], "typescript": [ { "path": "\"/sonar\"", "source": "sdks/typescript/src/client.ts", "transport": "postJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Sonar API", "Sonar API" ], "x-stability": "stable" }, "x-stability": "stable" }, "/v1/sonar/chat/completions": { "post": { "description": "Alias of ``POST /v1/sonar``. Accepts and returns the same Sonar wire format; the canonical route remains ``POST /v1/sonar``.", "operationId": "sonar_chat_completions_v1_sonar_chat_completions_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SonarRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SonarResponse" } }, "text/event-stream": { "schema": { "type": "string" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "OpenAI-compatible chat completions (Sonar drop-in alias)", "tags": [ "Sonar API" ], "x-q-capability": { "id": "POST /v1/sonar/chat/completions", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "sonar_api" ], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:chat" ], "settings": [], "stability": "stable", "tenant": "credential_or_validated_request", "user": "Tenant-wide; resource-specific permissions still apply." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Sonar API", "Sonar API" ], "x-stability": "stable" }, "x-stability": "stable" }, "/v1/sonar/models": { "get": { "description": "Returns the Sonar model catalogue supported by Q. Each entry maps onto an internal AnswerMode / FocusMode combination.", "operationId": "list_sonar_models_v1_sonar_models_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SonarModels" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "List Sonar-compatible model identifiers", "tags": [ "Sonar API" ], "x-q-capability": { "id": "GET /v1/sonar/models", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "sonar_api" ], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:chat" ], "settings": [], "stability": "stable", "tenant": "credential_or_validated_request", "user": "Tenant-wide; resource-specific permissions still apply." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "'/sonar/models'", "source": "sdks/python/src/q_client/models.py", "transport": "get_json" }, { "path": "'/sonar/models'", "source": "sdks/python/src/q_client/sonar.py", "transport": "get_json" } ], "typescript": [ { "path": "\"/sonar/models\"", "source": "sdks/typescript/src/client.ts", "transport": "getJson" }, { "path": "\"/sonar/models\"", "source": "sdks/typescript/src/models.ts", "transport": "getJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Sonar API", "Sonar API" ], "x-stability": "stable" }, "x-stability": "stable" }, "/v1/spaces": { "get": { "operationId": "public_list_spaces_v1_spaces_get", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 2048, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPage_SpaceResponse_" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "List Spaces for the current tenant", "tags": [ "Spaces" ], "x-q-capability": { "id": "GET /v1/spaces", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "spaces" ], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Authenticated owner or explicit collaborator; tenant alone does not grant access." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "'/spaces'", "source": "sdks/python/src/q_client/spaces.py", "transport": "get_json" } ], "typescript": [ { "path": "\"/spaces\"", "source": "sdks/typescript/src/spaces.ts", "transport": "getJson" }, { "path": "\"/spaces\"", "source": "sdks/typescript/src/spaces.ts", "transport": "getJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "data": "data", "maximum_limit": 100, "mode": "cursor", "next": "next_cursor", "previous": "previous_cursor" }, "x-q-tags": [ "Spaces", "Spaces" ], "x-stability": "beta" }, "post": { "operationId": "public_create_space_v1_spaces_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpaceCreate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpaceResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Create a Space", "tags": [ "Spaces" ], "x-q-capability": { "id": "POST /v1/spaces", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "spaces" ], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Authenticated owner or explicit collaborator; tenant alone does not grant access." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "'/spaces'", "source": "sdks/python/src/q_client/spaces.py", "transport": "post_json" } ], "typescript": [ { "path": "\"/spaces\"", "source": "sdks/typescript/src/spaces.ts", "transport": "postJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Spaces", "Spaces" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/spaces/{space_id}": { "get": { "operationId": "public_get_space_v1_spaces__space_id__get", "parameters": [ { "in": "path", "name": "space_id", "required": true, "schema": { "title": "Space Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpaceResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Get a Space", "tags": [ "Spaces" ], "x-q-capability": { "id": "GET /v1/spaces/{space_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "spaces" ], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Authenticated owner or explicit collaborator; tenant alone does not grant access." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "f'/spaces/{space_id}'", "source": "sdks/python/src/q_client/spaces.py", "transport": "get_json" } ], "typescript": [ { "path": "`/spaces/${encodeURIComponent(spaceId)}`", "source": "sdks/typescript/src/spaces.ts", "transport": "getJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Spaces", "Spaces" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/spaces/{space_id}/pages": { "get": { "operationId": "public_list_space_pages_v1_spaces__space_id__pages_get", "parameters": [ { "in": "path", "name": "space_id", "required": true, "schema": { "title": "Space Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageList" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "List Pages in a Space", "tags": [ "Spaces" ], "x-q-capability": { "id": "GET /v1/spaces/{space_id}/pages", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "spaces" ], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Authenticated owner or explicit collaborator; tenant alone does not grant access." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "f\"/spaces/{quote(space_id, safe='')}/pages\"", "source": "sdks/python/src/q_client/pages.py", "transport": "get_json" } ], "typescript": [ { "path": "pageListPath(options)", "source": "sdks/typescript/src/pages.ts", "transport": "getJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Spaces", "Spaces" ], "x-stability": "beta" }, "post": { "operationId": "public_create_space_page_v1_spaces__space_id__pages_post", "parameters": [ { "in": "path", "name": "space_id", "required": true, "schema": { "title": "Space Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpacePageCreatePayload" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Create a Page in a Space", "tags": [ "Spaces" ], "x-q-capability": { "id": "POST /v1/spaces/{space_id}/pages", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "spaces" ], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Authenticated owner or explicit collaborator; tenant alone does not grant access." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "f\"/spaces/{quote(space_id, safe='')}/pages\"", "source": "sdks/python/src/q_client/pages.py", "transport": "post_json" } ], "typescript": [ { "path": "`/spaces/${encodeURIComponent(spaceId)}/pages`", "source": "sdks/typescript/src/pages.ts", "transport": "postJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Spaces", "Spaces" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/spaces/{space_id}/search": { "post": { "operationId": "public_search_space_v1_spaces__space_id__search_post", "parameters": [ { "in": "path", "name": "space_id", "required": true, "schema": { "title": "Space Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpaceSearchPayload" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpaceSearchResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Search within a Space", "tags": [ "Spaces" ], "x-q-capability": { "id": "POST /v1/spaces/{space_id}/search", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [ "spaces" ], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Authenticated owner or explicit collaborator; tenant alone does not grant access." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "f'/spaces/{space_id}/search'", "source": "sdks/python/src/q_client/spaces.py", "transport": "post_json" } ], "typescript": [ { "path": "`/spaces/${encodeURIComponent(spaceId)}/search`", "source": "sdks/typescript/src/spaces.ts", "transport": "postJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Spaces", "Spaces" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/status": { "get": { "operationId": "platform_status_v1_status_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformStatus" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformStatus" } } }, "description": "Degraded platform status document", "x-q-error-contract": "status-document" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [], "summary": "Platform health and degraded capabilities", "tags": [ "Status" ], "x-q-capability": { "id": "GET /v1/status", "policy": { "audience": "public", "auth": "anonymous", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "stable", "tenant": "none", "user": "No user or tenant context." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Status", "Status" ], "x-stability": "stable" }, "x-stability": "stable" }, "/v1/status/feed.xml": { "get": { "operationId": "status_rss_feed_v1_status_feed_xml_get", "responses": { "200": { "content": { "application/rss+xml": { "schema": { "type": "string" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [], "summary": "RSS feed for status updates", "tags": [ "Status" ], "x-q-capability": { "id": "GET /v1/status/feed.xml", "policy": { "audience": "public", "auth": "anonymous", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "stable", "tenant": "none", "user": "No user or tenant context." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Status", "Status" ], "x-stability": "stable" }, "x-stability": "stable" }, "/v1/status/incidents": { "get": { "operationId": "status_incidents_v1_status_incidents_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncidentList" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [], "summary": "Incident history", "tags": [ "Status" ], "x-q-capability": { "id": "GET /v1/status/incidents", "policy": { "audience": "public", "auth": "anonymous", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "stable", "tenant": "none", "user": "No user or tenant context." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Status", "Status" ], "x-stability": "stable" }, "x-stability": "stable" }, "/v1/usage": { "get": { "description": "Get usage records with optional filters.\n\nRequires API key authentication. Returns usage for the authenticated client\nunless admin privileges allow querying other tenants.", "operationId": "get_usage_v1_usage_get", "parameters": [ { "description": "Filter by organisation ID", "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by organisation ID", "title": "Tenant Id" } }, { "description": "Filter by user ID", "in": "query", "name": "user_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by user ID", "title": "User Id" } }, { "description": "Filter by tag", "in": "query", "name": "tag", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by tag", "title": "Tag" } }, { "description": "Filter by model", "in": "query", "name": "model", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by model", "title": "Model" } }, { "description": "Maximum records to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "description": "Maximum records to return", "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "Offset for pagination", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "description": "Offset for pagination", "minimum": 0, "title": "Offset", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/UsageRecord_Response" }, "title": "Response Get Usage V1 Usage Get", "type": "array" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Usage", "tags": [ "Platform" ], "x-q-capability": { "id": "GET /v1/usage", "policy": { "audience": "public", "auth": "api_key", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "API key tenant; admin scope may query across tenants." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "offset" }, "x-q-tags": [ "Platform", "Platform" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/usage/costs": { "get": { "description": "Get detailed cost breakdown by model and tag.\n\nRequires API key authentication.", "operationId": "get_cost_breakdown_v1_usage_costs_get", "parameters": [ { "description": "Filter by organisation ID", "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by organisation ID", "title": "Tenant Id" } }, { "description": "Filter by user ID", "in": "query", "name": "user_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by user ID", "title": "User Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostSummary" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Cost Breakdown", "tags": [ "Platform" ], "x-q-capability": { "id": "GET /v1/usage/costs", "policy": { "audience": "public", "auth": "api_key", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "API key tenant; admin scope may query across tenants." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Platform", "Platform" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/usage/summary": { "get": { "description": "Get aggregated usage summary.\n\nAccepts developer API keys (tenant derived from the key) or Black Ink-style\nservice auth (``X-Internal-Secret``), where ``tenant_id`` must be supplied\nexplicitly when no API key client scope is present.", "operationId": "get_usage_summary_v1_usage_summary_get", "parameters": [ { "description": "Filter by organisation ID", "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by organisation ID", "title": "Tenant Id" } }, { "description": "Filter by user ID", "in": "query", "name": "user_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by user ID", "title": "User Id" } }, { "description": "Optional reporting window label (e.g. \"30d\") \u2014 reserved for future filtering", "in": "query", "name": "period", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional reporting window label (e.g. \"30d\") \u2014 reserved for future filtering", "title": "Period" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageSummary" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Usage Summary", "tags": [ "Platform" ], "x-q-capability": { "id": "GET /v1/usage/summary", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide; resource-specific permissions still apply." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Platform", "Platform" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/usage/tags": { "get": { "description": "Get list of all unique tags used in usage records.\n\nRequires API key authentication.", "operationId": "get_available_tags_v1_usage_tags_get", "parameters": [ { "description": "Filter by organisation ID", "in": "query", "name": "tenant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by organisation ID", "title": "Tenant Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "title": "Response Get Available Tags V1 Usage Tags Get", "type": "array" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Available Tags", "tags": [ "Platform" ], "x-q-capability": { "id": "GET /v1/usage/tags", "policy": { "audience": "public", "auth": "api_key", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "API key tenant; admin scope may query across tenants." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Platform", "Platform" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/webhooks": { "get": { "operationId": "list_webhooks_v1_webhooks_get", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 2048, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "limit", "required": false, "schema": { "anyOf": [ { "maximum": 100, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": 20, "title": "Limit" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPage" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "List webhook subscriptions", "tags": [ "Webhooks" ], "x-q-capability": { "id": "GET /v1/webhooks", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide; resource-specific permissions still apply." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "'/webhooks'", "source": "sdks/python/src/q_client/webhooks.py", "transport": "get_json" } ], "typescript": [ { "path": "\"/webhooks\"", "source": "sdks/typescript/src/client.ts", "transport": "getJson" }, { "path": "\"/webhooks\"", "source": "sdks/typescript/src/client.ts", "transport": "getJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "data": "data", "maximum_limit": 100, "mode": "cursor", "next": "next_cursor", "previous": "previous_cursor" }, "x-q-tags": [ "Webhooks", "Webhooks" ], "x-stability": "beta" }, "post": { "operationId": "create_webhook_v1_webhooks_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Create a webhook subscription", "tags": [ "Webhooks" ], "x-q-capability": { "id": "POST /v1/webhooks", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide; resource-specific permissions still apply." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "'/webhooks'", "source": "sdks/python/src/q_client/webhooks.py", "transport": "post_json" } ], "typescript": [ { "path": "\"/webhooks\"", "source": "sdks/typescript/src/client.ts", "transport": "postJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Webhooks", "Webhooks" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/webhooks/{webhook_id}": { "delete": { "operationId": "delete_webhook_v1_webhooks__webhook_id__delete", "parameters": [ { "in": "path", "name": "webhook_id", "required": true, "schema": { "title": "Webhook Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Delete a webhook subscription", "tags": [ "Webhooks" ], "x-q-capability": { "id": "DELETE /v1/webhooks/{webhook_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide; resource-specific permissions still apply." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Webhooks", "Webhooks" ], "x-stability": "beta" }, "patch": { "operationId": "update_webhook_v1_webhooks__webhook_id__patch", "parameters": [ { "in": "path", "name": "webhook_id", "required": true, "schema": { "title": "Webhook Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookResponse" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Update a webhook subscription", "tags": [ "Webhooks" ], "x-q-capability": { "id": "PATCH /v1/webhooks/{webhook_id}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide; resource-specific permissions still apply." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Webhooks", "Webhooks" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/webhooks/{webhook_id}/deliveries": { "get": { "description": "Return the last 50 delivery attempts for a subscription.", "operationId": "list_webhook_deliveries_v1_webhooks__webhook_id__deliveries_get", "parameters": [ { "in": "path", "name": "webhook_id", "required": true, "schema": { "title": "Webhook Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookDeliveries" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "List recent webhook deliveries", "tags": [ "Webhooks" ], "x-q-capability": { "id": "GET /v1/webhooks/{webhook_id}/deliveries", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide; resource-specific permissions still apply." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "f\"/webhooks/{quote(webhook_id, safe='')}/deliveries\"", "source": "sdks/python/src/q_client/webhooks.py", "transport": "get_json" } ], "typescript": [ { "path": "`/webhooks/${encodeURIComponent(id)}/deliveries`", "source": "sdks/typescript/src/client.ts", "transport": "getJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Webhooks", "Webhooks" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/webhooks/{webhook_id}/deliveries/{delivery_id}/replay": { "post": { "operationId": "replay_webhook_delivery_v1_webhooks__webhook_id__deliveries__delivery_id__replay_post", "parameters": [ { "in": "path", "name": "webhook_id", "required": true, "schema": { "title": "Webhook Id", "type": "string" } }, { "in": "path", "name": "delivery_id", "required": true, "schema": { "format": "uuid", "title": "Delivery Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookDelivery" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Requeue an exhausted delivery with its original identity", "tags": [ "Webhooks" ], "x-q-capability": { "id": "POST /v1/webhooks/{webhook_id}/deliveries/{delivery_id}/replay", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide; resource-specific permissions still apply." }, "registry_version": "2026-10-12.1", "sdk": { "python": [ { "path": "f\"/webhooks/{quote(webhook_id, safe='')}/deliveries/{quote(delivery_id, safe='')}/replay\"", "source": "sdks/python/src/q_client/webhooks.py", "transport": "post_json" } ], "typescript": [ { "path": "`/webhooks/${encodeURIComponent(id)}/deliveries/${encodeURIComponent(deliveryId)}/replay`", "source": "sdks/typescript/src/client.ts", "transport": "postJson" } ] } }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Webhooks", "Webhooks" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/webhooks/{webhook_id}/test": { "post": { "description": "POST a ``webhook.test`` event to the subscription URL and return the result.", "operationId": "test_webhook_v1_webhooks__webhook_id__test_post", "parameters": [ { "in": "path", "name": "webhook_id", "required": true, "schema": { "title": "Webhook Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookTest" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Send a test webhook event", "tags": [ "Webhooks" ], "x-q-capability": { "id": "POST /v1/webhooks/{webhook_id}/test", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "none", "scopes": [], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant-wide; resource-specific permissions still apply." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Webhooks", "Webhooks" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/workspace/files": { "get": { "operationId": "search_workspace_files_v1_workspace_files_get", "parameters": [ { "in": "query", "name": "workspace_id", "required": true, "schema": { "title": "Workspace Id", "type": "string" } }, { "in": "query", "name": "q", "required": false, "schema": { "default": "", "title": "Q", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 30, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceFiles" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Search workspace files for the @file mention picker", "tags": [ "Answer Engine" ], "x-q-capability": { "id": "GET /v1/workspace/files", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "ai_compat", "scopes": [ "ai:answer" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Tenant and authenticated user/principal; delegated users require identity:delegate or *. Workspace grants and run approval ownership are checked separately." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-q-tags": [ "Answer Engine", "Answer Engine" ], "x-stability": "beta" }, "x-stability": "beta" }, "/v1/workspaces": { "get": { "operationId": "list_workspaces_v1_workspaces_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceList" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "List Workspaces", "tags": [ "Workspaces" ], "x-q-capability": { "id": "GET /v1/workspaces", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "workspace", "scopes": [ "workspace:read" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Workspace grant and principal binding; path confined to the authorised resource." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-stability": "beta" }, "x-stability": "beta" }, "/v1/workspaces/{workspace_id}/artifacts/{path}": { "get": { "operationId": "read_artifact_v1_workspaces__workspace_id__artifacts__path__get", "parameters": [ { "in": "path", "name": "workspace_id", "required": true, "schema": { "title": "Workspace Id", "type": "string" } }, { "in": "path", "name": "path", "required": true, "schema": { "title": "Path", "type": "string" } } ], "responses": { "200": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Read Artifact", "tags": [ "Workspaces" ], "x-q-capability": { "id": "GET /v1/workspaces/{workspace_id}/artifacts/{path}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "workspace", "scopes": [ "workspace:read" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Workspace grant and principal binding; path confined to the authorised resource." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-stability": "beta" }, "x-stability": "beta" }, "/v1/workspaces/{workspace_id}/files": { "get": { "operationId": "list_files_v1_workspaces__workspace_id__files_get", "parameters": [ { "in": "path", "name": "workspace_id", "required": true, "schema": { "title": "Workspace Id", "type": "string" } }, { "in": "query", "name": "q", "required": false, "schema": { "default": "", "title": "Q", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 30, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileList" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "List Files", "tags": [ "Workspaces" ], "x-q-capability": { "id": "GET /v1/workspaces/{workspace_id}/files", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "workspace", "scopes": [ "workspace:read" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Workspace grant and principal binding; path confined to the authorised resource." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-stability": "beta" }, "x-stability": "beta" }, "/v1/workspaces/{workspace_id}/files/{path}": { "get": { "operationId": "read_file_v1_workspaces__workspace_id__files__path__get", "parameters": [ { "in": "path", "name": "workspace_id", "required": true, "schema": { "title": "Workspace Id", "type": "string" } }, { "in": "path", "name": "path", "required": true, "schema": { "title": "Path", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileContent" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Read File", "tags": [ "Workspaces" ], "x-q-capability": { "id": "GET /v1/workspaces/{workspace_id}/files/{path}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "workspace", "scopes": [ "workspace:read" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Workspace grant and principal binding; path confined to the authorised resource." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-stability": "beta" }, "put": { "operationId": "write_file_v1_workspaces__workspace_id__files__path__put", "parameters": [ { "in": "path", "name": "workspace_id", "required": true, "schema": { "title": "Workspace Id", "type": "string" } }, { "in": "path", "name": "path", "required": true, "schema": { "title": "Path", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WriteFile" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileWritten" } } }, "description": "Successful Response" }, "400": { "$ref": "#/components/responses/UnifiedError" }, "401": { "$ref": "#/components/responses/UnifiedError" }, "402": { "$ref": "#/components/responses/UnifiedError" }, "403": { "$ref": "#/components/responses/UnifiedError" }, "404": { "$ref": "#/components/responses/UnifiedError" }, "405": { "$ref": "#/components/responses/UnifiedError" }, "408": { "$ref": "#/components/responses/UnifiedError" }, "409": { "$ref": "#/components/responses/UnifiedError" }, "413": { "$ref": "#/components/responses/UnifiedError" }, "414": { "$ref": "#/components/responses/UnifiedError" }, "415": { "$ref": "#/components/responses/UnifiedError" }, "422": { "$ref": "#/components/responses/UnifiedError" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/UnifiedError" }, "502": { "$ref": "#/components/responses/UnifiedError" }, "503": { "$ref": "#/components/responses/UnifiedError" }, "504": { "$ref": "#/components/responses/UnifiedError" }, "default": { "$ref": "#/components/responses/UnifiedError" } }, "security": [ { "BearerAuth": [] } ], "summary": "Write File", "tags": [ "Workspaces" ], "x-q-capability": { "id": "PUT /v1/workspaces/{workspace_id}/files/{path}", "policy": { "audience": "public", "auth": "credential", "conditional_scopes": {}, "disabled_reason": null, "features": [], "reason": "", "scope_policy": "workspace", "scopes": [ "workspace:write" ], "settings": [], "stability": "beta", "tenant": "credential_or_validated_request", "user": "Workspace write grant and principal binding; path confined to the authorised resource." }, "registry_version": "2026-10-12.1", "sdk": {} }, "x-q-input-limits": { "body_bytes": 2097152, "cursor_characters": 2048, "query_bytes": 16384 }, "x-q-pagination": { "mode": "none" }, "x-stability": "beta" }, "x-stability": "beta" } }, "servers": [ { "description": "Default Q API origin; confirm your deployment before calling.", "url": "https://api.qdivision.ai" } ], "tags": [ { "name": "A2A Public" }, { "name": "AI Services" }, { "name": "Agent API" }, { "name": "Agent Gateway" }, { "name": "Agents v2 Public" }, { "name": "Answer Engine" }, { "name": "Artifacts" }, { "name": "Billing" }, { "name": "Capabilities" }, { "name": "Channels" }, { "name": "Completions" }, { "name": "Connectors API" }, { "name": "DevTools" }, { "name": "Document ingestion" }, { "name": "Embeddings API" }, { "name": "Extensions" }, { "name": "Hooks" }, { "name": "Knowledge" }, { "name": "MCP" }, { "name": "MCP Server HTTP" }, { "name": "MCP Servers" }, { "name": "Memory" }, { "name": "OpenAPI" }, { "name": "Pages" }, { "name": "Persona" }, { "name": "Platform" }, { "name": "Request Logs" }, { "name": "Retrieval Quality" }, { "name": "Rules" }, { "name": "Schedules" }, { "name": "Search API" }, { "name": "Semantic Search" }, { "name": "Skills" }, { "name": "Skills Hub" }, { "name": "Sonar API" }, { "name": "Spaces" }, { "name": "Status" }, { "name": "Tenant Health" }, { "name": "Trading Analyst" }, { "name": "Webhooks" }, { "name": "Workspaces" } ] }