{ "components": { "schemas": { "A2AAPIKeySecurityScheme": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "Defines a security scheme using an API key.", "properties": { "description": { "default": "", "description": "An optional description for the security scheme.", "type": "string" }, "location": { "default": "", "description": "The location of the API key. Valid values are \"query\", \"header\", or \"cookie\".", "type": "string" }, "name": { "default": "", "description": "The name of the header, query, or cookie parameter to be used.", "type": "string" } }, "title": "API Key Security Scheme", "type": "object" }, "A2AAgentCapabilities": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "Defines optional capabilities supported by an agent.", "patternProperties": { "^(extended_agent_card)$": { "description": "Indicates if the agent supports providing an extended agent card when authenticated.", "type": "boolean" }, "^(push_notifications)$": { "description": "Indicates if the agent supports sending push notifications for asynchronous task updates.", "type": "boolean" } }, "properties": { "extendedAgentCard": { "description": "Indicates if the agent supports providing an extended agent card when authenticated.", "type": "boolean" }, "extensions": { "description": "A list of protocol extensions supported by the agent.", "items": { "$ref": "#/components/schemas/A2AAgentExtension" }, "type": "array" }, "pushNotifications": { "description": "Indicates if the agent supports sending push notifications for asynchronous task updates.", "type": "boolean" }, "streaming": { "description": "Indicates if the agent supports streaming responses.", "type": "boolean" } }, "title": "Agent Capabilities", "type": "object" }, "A2AAgentCard": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "A self-describing manifest for an agent. It provides essential\n metadata including the agent's identity, capabilities, skills, supported\n communication methods, and security requirements.\n Next ID: 20", "patternProperties": { "^(default_input_modes)$": { "description": "The set of interaction modes that the agent supports across all skills.\n This can be overridden per skill. Defined as media types.", "items": { "type": "string" }, "type": "array" }, "^(default_output_modes)$": { "description": "The media types supported as outputs from this agent.", "items": { "type": "string" }, "type": "array" }, "^(documentation_url)$": { "description": "A URL providing additional documentation about the agent.", "type": "string" }, "^(icon_url)$": { "description": "Optional. A URL to an icon for the agent.", "type": "string" }, "^(security_requirements)$": { "description": "Security requirements for contacting the agent.", "items": { "$ref": "#/components/schemas/A2ASecurityRequirement" }, "type": "array" }, "^(security_schemes)$": { "additionalProperties": { "$ref": "#/components/schemas/A2ASecurityScheme" }, "description": "The security scheme details used for authenticating with this agent.", "propertyNames": { "type": "string" }, "type": "object" }, "^(supported_interfaces)$": { "description": "Ordered list of supported interfaces. The first entry is preferred.", "items": { "$ref": "#/components/schemas/A2AAgentInterface" }, "type": "array" } }, "properties": { "capabilities": { "$ref": "#/components/schemas/A2AAgentCapabilities", "description": "A2A Capability set supported by the agent." }, "defaultInputModes": { "description": "The set of interaction modes that the agent supports across all skills.\n This can be overridden per skill. Defined as media types.", "items": { "type": "string" }, "type": "array" }, "defaultOutputModes": { "description": "The media types supported as outputs from this agent.", "items": { "type": "string" }, "type": "array" }, "description": { "default": "", "description": "A human-readable description of the agent, assisting users and other agents\n in understanding its purpose.\n Example: \"Agent that helps users with recipes and cooking.\"", "type": "string" }, "documentationUrl": { "description": "A URL providing additional documentation about the agent.", "type": "string" }, "iconUrl": { "description": "Optional. A URL to an icon for the agent.", "type": "string" }, "name": { "default": "", "description": "A human readable name for the agent.\n Example: \"Recipe Agent\"", "type": "string" }, "provider": { "$ref": "#/components/schemas/A2AAgentProvider", "description": "The service provider of the agent." }, "securityRequirements": { "description": "Security requirements for contacting the agent.", "items": { "$ref": "#/components/schemas/A2ASecurityRequirement" }, "type": "array" }, "securitySchemes": { "additionalProperties": { "$ref": "#/components/schemas/A2ASecurityScheme" }, "description": "The security scheme details used for authenticating with this agent.", "propertyNames": { "type": "string" }, "type": "object" }, "signatures": { "description": "JSON Web Signatures computed for this `AgentCard`.", "items": { "$ref": "#/components/schemas/A2AAgentCardSignature" }, "type": "array" }, "skills": { "description": "Skills represent the abilities of an agent.\n It is largely a descriptive concept but represents a more focused set of behaviors that the\n agent is likely to succeed at.", "items": { "$ref": "#/components/schemas/A2AAgentSkill" }, "type": "array" }, "supportedInterfaces": { "description": "Ordered list of supported interfaces. The first entry is preferred.", "items": { "$ref": "#/components/schemas/A2AAgentInterface" }, "type": "array" }, "version": { "default": "", "description": "The version of the agent.\n Example: \"1.0.0\"", "type": "string" } }, "title": "Agent Card", "type": "object" }, "A2AAgentCardSignature": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "AgentCardSignature represents a JWS signature of an AgentCard.\n This follows the JSON format of an RFC 7515 JSON Web Signature (JWS).", "properties": { "header": { "$ref": "#/components/schemas/A2AStruct", "description": "The unprotected JWS header values." }, "protected": { "default": "", "description": "(-- api-linter: core::0140::reserved-words=disabled\n aip.dev/not-precedent: Backwards compatibility --)\n Required. The protected JWS header for the signature. This is always a\n base64url-encoded JSON object.", "type": "string" }, "signature": { "default": "", "description": "Required. The computed signature, base64url-encoded.", "type": "string" } }, "title": "Agent Card Signature", "type": "object" }, "A2AAgentExtension": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "A declaration of a protocol extension supported by an Agent.", "properties": { "description": { "default": "", "description": "A human-readable description of how this agent uses the extension.", "type": "string" }, "params": { "$ref": "#/components/schemas/A2AStruct", "description": "Optional. Extension-specific configuration parameters." }, "required": { "default": false, "description": "If true, the client must understand and comply with the extension's requirements.", "type": "boolean" }, "uri": { "default": "", "description": "The unique URI identifying the extension.", "type": "string" } }, "title": "Agent Extension", "type": "object" }, "A2AAgentInterface": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "Declares a combination of a target URL, transport and protocol version for interacting with the agent.\n This allows agents to expose the same functionality over multiple protocol binding mechanisms.", "patternProperties": { "^(protocol_binding)$": { "default": "", "description": "The protocol binding supported at this URL. This is an open form string, to be\n easily extended for other protocol bindings. The core ones officially\n supported are `JSONRPC`, `GRPC` and `HTTP+JSON`.", "type": "string" }, "^(protocol_version)$": { "default": "", "description": "The version of the A2A protocol this interface exposes.\n Use the latest supported minor version per major version.\n Examples: \"0.3\", \"1.0\"", "type": "string" } }, "properties": { "protocolBinding": { "default": "", "description": "The protocol binding supported at this URL. This is an open form string, to be\n easily extended for other protocol bindings. The core ones officially\n supported are `JSONRPC`, `GRPC` and `HTTP+JSON`.", "type": "string" }, "protocolVersion": { "default": "", "description": "The version of the A2A protocol this interface exposes.\n Use the latest supported minor version per major version.\n Examples: \"0.3\", \"1.0\"", "type": "string" }, "tenant": { "default": "", "description": "Tenant ID to be used in the request when calling the agent.", "type": "string" }, "url": { "default": "", "description": "The URL where this interface is available. Must be a valid absolute HTTPS URL in production.\n Example: \"https://api.example.com/a2a/v1\", \"https://grpc.example.com/a2a\"", "type": "string" } }, "title": "Agent Interface", "type": "object" }, "A2AAgentProvider": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "Represents the service provider of an agent.", "properties": { "organization": { "default": "", "description": "The name of the agent provider's organization.\n Example: \"Google\"", "type": "string" }, "url": { "default": "", "description": "A URL for the agent provider's website or relevant documentation.\n Example: \"https://ai.google.dev\"", "type": "string" } }, "title": "Agent Provider", "type": "object" }, "A2AAgentSkill": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "Represents a distinct capability or function that an agent can perform.", "patternProperties": { "^(input_modes)$": { "description": "The set of supported input media types for this skill, overriding the agent's defaults.", "items": { "type": "string" }, "type": "array" }, "^(output_modes)$": { "description": "The set of supported output media types for this skill, overriding the agent's defaults.", "items": { "type": "string" }, "type": "array" }, "^(security_requirements)$": { "description": "Security schemes necessary for this skill.", "items": { "$ref": "#/components/schemas/A2ASecurityRequirement" }, "type": "array" } }, "properties": { "description": { "default": "", "description": "A detailed description of the skill.", "type": "string" }, "examples": { "description": "Example prompts or scenarios that this skill can handle.", "items": { "type": "string" }, "type": "array" }, "id": { "default": "", "description": "A unique identifier for the agent's skill.", "type": "string" }, "inputModes": { "description": "The set of supported input media types for this skill, overriding the agent's defaults.", "items": { "type": "string" }, "type": "array" }, "name": { "default": "", "description": "A human-readable name for the skill.", "type": "string" }, "outputModes": { "description": "The set of supported output media types for this skill, overriding the agent's defaults.", "items": { "type": "string" }, "type": "array" }, "securityRequirements": { "description": "Security schemes necessary for this skill.", "items": { "$ref": "#/components/schemas/A2ASecurityRequirement" }, "type": "array" }, "tags": { "description": "A set of keywords describing the skill's capabilities.", "items": { "type": "string" }, "type": "array" } }, "title": "Agent Skill", "type": "object" }, "A2AArtifact": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "Artifacts represent task outputs.", "patternProperties": { "^(artifact_id)$": { "default": "", "description": "Unique identifier (e.g. UUID) for the artifact. It must be unique within a task.", "type": "string" } }, "properties": { "artifactId": { "default": "", "description": "Unique identifier (e.g. UUID) for the artifact. It must be unique within a task.", "type": "string" }, "description": { "default": "", "description": "Optional. A human readable description of the artifact.", "type": "string" }, "extensions": { "description": "The URIs of extensions that are present or contributed to this Artifact.", "items": { "type": "string" }, "type": "array" }, "metadata": { "$ref": "#/components/schemas/A2AStruct", "description": "Optional. Metadata included with the artifact." }, "name": { "default": "", "description": "A human readable name for the artifact.", "type": "string" }, "parts": { "description": "The content of the artifact. Must contain at least one part.", "items": { "$ref": "#/components/schemas/A2APart" }, "type": "array" } }, "title": "Artifact", "type": "object" }, "A2AAuthenticationInfo": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "Defines authentication details, used for push notifications.", "properties": { "credentials": { "default": "", "description": "Push Notification credentials. Format depends on the scheme (e.g., token for Bearer).", "type": "string" }, "scheme": { "default": "", "description": "HTTP Authentication Scheme from the [IANA registry](https://www.iana.org/assignments/http-authschemes/).\n Examples: `Bearer`, `Basic`, `Digest`.\n Scheme names are case-insensitive per [RFC 9110 Section 11.1](https://www.rfc-editor.org/rfc/rfc9110#section-11.1).", "type": "string" } }, "title": "Authentication Info", "type": "object" }, "A2AAuthorizationCodeOAuthFlow": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "Defines configuration details for the OAuth 2.0 Authorization Code flow.", "patternProperties": { "^(authorization_url)$": { "default": "", "description": "The authorization URL to be used for this flow.", "type": "string" }, "^(pkce_required)$": { "default": false, "description": "Indicates if PKCE (RFC 7636) is required for this flow.\n PKCE should always be used for public clients and is recommended for all clients.", "type": "boolean" }, "^(refresh_url)$": { "default": "", "description": "The URL to be used for obtaining refresh tokens.", "type": "string" }, "^(token_url)$": { "default": "", "description": "The token URL to be used for this flow.", "type": "string" } }, "properties": { "authorizationUrl": { "default": "", "description": "The authorization URL to be used for this flow.", "type": "string" }, "pkceRequired": { "default": false, "description": "Indicates if PKCE (RFC 7636) is required for this flow.\n PKCE should always be used for public clients and is recommended for all clients.", "type": "boolean" }, "refreshUrl": { "default": "", "description": "The URL to be used for obtaining refresh tokens.", "type": "string" }, "scopes": { "additionalProperties": { "type": "string" }, "description": "The available scopes for the OAuth2 security scheme.", "propertyNames": { "type": "string" }, "type": "object" }, "tokenUrl": { "default": "", "description": "The token URL to be used for this flow.", "type": "string" } }, "title": "Authorization CodeO Auth Flow", "type": "object" }, "A2ACancelTaskRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "Represents a request for the `CancelTask` method.", "properties": { "id": { "default": "", "description": "The resource ID of the task to cancel.", "type": "string" }, "metadata": { "$ref": "#/components/schemas/A2AStruct", "description": "A flexible key-value map for passing additional context or parameters." }, "tenant": { "default": "", "description": "Optional. Tenant ID, provided as a path parameter.", "type": "string" } }, "title": "Cancel Task Request", "type": "object" }, "A2AClientCredentialsOAuthFlow": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "Defines configuration details for the OAuth 2.0 Client Credentials flow.", "patternProperties": { "^(refresh_url)$": { "default": "", "description": "The URL to be used for obtaining refresh tokens.", "type": "string" }, "^(token_url)$": { "default": "", "description": "The token URL to be used for this flow.", "type": "string" } }, "properties": { "refreshUrl": { "default": "", "description": "The URL to be used for obtaining refresh tokens.", "type": "string" }, "scopes": { "additionalProperties": { "type": "string" }, "description": "The available scopes for the OAuth2 security scheme.", "propertyNames": { "type": "string" }, "type": "object" }, "tokenUrl": { "default": "", "description": "The token URL to be used for this flow.", "type": "string" } }, "title": "Client CredentialsO Auth Flow", "type": "object" }, "A2ADeleteTaskPushNotificationConfigRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "Represents a request for the `DeleteTaskPushNotificationConfig` method.", "patternProperties": { "^(task_id)$": { "default": "", "description": "The parent task resource ID.", "type": "string" } }, "properties": { "id": { "default": "", "description": "The resource ID of the configuration to delete.", "type": "string" }, "taskId": { "default": "", "description": "The parent task resource ID.", "type": "string" }, "tenant": { "default": "", "description": "Optional. Tenant ID, provided as a path parameter.", "type": "string" } }, "title": "Delete Task Push Notification Config Request", "type": "object" }, "A2ADeviceCodeOAuthFlow": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "Defines configuration details for the OAuth 2.0 Device Code flow (RFC 8628).\n This flow is designed for input-constrained devices such as IoT devices,\n and CLI tools where the user authenticates on a separate device.", "patternProperties": { "^(device_authorization_url)$": { "default": "", "description": "The device authorization endpoint URL.", "type": "string" }, "^(refresh_url)$": { "default": "", "description": "The URL to be used for obtaining refresh tokens.", "type": "string" }, "^(token_url)$": { "default": "", "description": "The token URL to be used for this flow.", "type": "string" } }, "properties": { "deviceAuthorizationUrl": { "default": "", "description": "The device authorization endpoint URL.", "type": "string" }, "refreshUrl": { "default": "", "description": "The URL to be used for obtaining refresh tokens.", "type": "string" }, "scopes": { "additionalProperties": { "type": "string" }, "description": "The available scopes for the OAuth2 security scheme.", "propertyNames": { "type": "string" }, "type": "object" }, "tokenUrl": { "default": "", "description": "The token URL to be used for this flow.", "type": "string" } }, "title": "Device CodeO Auth Flow", "type": "object" }, "A2AGetExtendedAgentCardRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "Represents a request for the `GetExtendedAgentCard` method.", "properties": { "tenant": { "default": "", "description": "Optional. Tenant ID, provided as a path parameter.", "type": "string" } }, "title": "Get Extended Agent Card Request", "type": "object" }, "A2AGetTaskPushNotificationConfigRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "Represents a request for the `GetTaskPushNotificationConfig` method.", "patternProperties": { "^(task_id)$": { "default": "", "description": "The parent task resource ID.", "type": "string" } }, "properties": { "id": { "default": "", "description": "The resource ID of the configuration to retrieve.", "type": "string" }, "taskId": { "default": "", "description": "The parent task resource ID.", "type": "string" }, "tenant": { "default": "", "description": "Optional. Tenant ID, provided as a path parameter.", "type": "string" } }, "title": "Get Task Push Notification Config Request", "type": "object" }, "A2AGetTaskRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "Represents a request for the `GetTask` method.", "patternProperties": { "^(history_length)$": { "anyOf": [ { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, { "pattern": "^-?[0-9]+$", "type": "string" } ], "description": "The maximum number of most recent messages from the task's history to retrieve. An\n unset value means the client does not impose any limit. A value of zero is\n a request to not include any messages. The server MUST NOT return more\n messages than the provided value, but MAY apply a lower limit." } }, "properties": { "historyLength": { "anyOf": [ { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, { "pattern": "^-?[0-9]+$", "type": "string" } ], "description": "The maximum number of most recent messages from the task's history to retrieve. An\n unset value means the client does not impose any limit. A value of zero is\n a request to not include any messages. The server MUST NOT return more\n messages than the provided value, but MAY apply a lower limit." }, "id": { "default": "", "description": "The resource ID of the task to retrieve.", "type": "string" }, "tenant": { "default": "", "description": "Optional. Tenant ID, provided as a path parameter.", "type": "string" } }, "title": "Get Task Request", "type": "object" }, "A2AHTTPAuthSecurityScheme": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "Defines a security scheme using HTTP authentication.", "patternProperties": { "^(bearer_format)$": { "default": "", "description": "A hint to the client to identify how the bearer token is formatted (e.g., \"JWT\").\n Primarily for documentation purposes.", "type": "string" } }, "properties": { "bearerFormat": { "default": "", "description": "A hint to the client to identify how the bearer token is formatted (e.g., \"JWT\").\n Primarily for documentation purposes.", "type": "string" }, "description": { "default": "", "description": "An optional description for the security scheme.", "type": "string" }, "scheme": { "default": "", "description": "The name of the HTTP Authentication scheme to be used in the Authorization header,\n as defined in RFC7235 (e.g., \"Bearer\").\n This value should be registered in the IANA Authentication Scheme registry.", "type": "string" } }, "title": "HTTP Auth Security Scheme", "type": "object" }, "A2AImplicitOAuthFlow": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "Deprecated: Use Authorization Code + PKCE instead.", "patternProperties": { "^(authorization_url)$": { "default": "", "description": "The authorization URL to be used for this flow. This MUST be in the\n form of a URL. The OAuth2 standard requires the use of TLS", "type": "string" }, "^(refresh_url)$": { "default": "", "description": "The URL to be used for obtaining refresh tokens. This MUST be in the\n form of a URL. The OAuth2 standard requires the use of TLS.", "type": "string" } }, "properties": { "authorizationUrl": { "default": "", "description": "The authorization URL to be used for this flow. This MUST be in the\n form of a URL. The OAuth2 standard requires the use of TLS", "type": "string" }, "refreshUrl": { "default": "", "description": "The URL to be used for obtaining refresh tokens. This MUST be in the\n form of a URL. The OAuth2 standard requires the use of TLS.", "type": "string" }, "scopes": { "additionalProperties": { "type": "string" }, "description": "The available scopes for the OAuth2 security scheme. A map between the\n scope name and a short description for it. The map MAY be empty.", "propertyNames": { "type": "string" }, "type": "object" } }, "title": "ImplicitO Auth Flow", "type": "object" }, "A2AListTaskPushNotificationConfigsRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "Represents a request for the `ListTaskPushNotificationConfigs` method.", "patternProperties": { "^(page_size)$": { "anyOf": [ { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, { "pattern": "^-?[0-9]+$", "type": "string" } ], "default": 0, "description": "The maximum number of configurations to return." }, "^(page_token)$": { "default": "", "description": "A page token received from a previous `ListTaskPushNotificationConfigsRequest` call.", "type": "string" }, "^(task_id)$": { "default": "", "description": "The parent task resource ID.", "type": "string" } }, "properties": { "pageSize": { "anyOf": [ { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, { "pattern": "^-?[0-9]+$", "type": "string" } ], "default": 0, "description": "The maximum number of configurations to return." }, "pageToken": { "default": "", "description": "A page token received from a previous `ListTaskPushNotificationConfigsRequest` call.", "type": "string" }, "taskId": { "default": "", "description": "The parent task resource ID.", "type": "string" }, "tenant": { "default": "", "description": "Optional. Tenant ID, provided as a path parameter.", "type": "string" } }, "title": "List Task Push Notification Configs Request", "type": "object" }, "A2AListTaskPushNotificationConfigsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "Represents a successful response for the `ListTaskPushNotificationConfigs`\n method.", "patternProperties": { "^(next_page_token)$": { "default": "", "description": "A token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" } }, "properties": { "configs": { "description": "The list of push notification configurations.", "items": { "$ref": "#/components/schemas/A2ATaskPushNotificationConfig" }, "type": "array" }, "nextPageToken": { "default": "", "description": "A token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" } }, "title": "List Task Push Notification Configs Response", "type": "object" }, "A2AListTasksRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "Parameters for listing tasks with optional filtering criteria.", "patternProperties": { "^(context_id)$": { "default": "", "description": "Filter tasks by context ID to get tasks from a specific conversation or session.", "type": "string" }, "^(history_length)$": { "anyOf": [ { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, { "pattern": "^-?[0-9]+$", "type": "string" } ], "description": "The maximum number of messages to include in each task's history." }, "^(include_artifacts)$": { "description": "Whether to include artifacts in the returned tasks.\n Defaults to false to reduce payload size.", "type": "boolean" }, "^(page_size)$": { "anyOf": [ { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, { "pattern": "^-?[0-9]+$", "type": "string" } ], "description": "The maximum number of tasks to return. The service may return fewer than this value.\n If unspecified, at most 50 tasks will be returned.\n The minimum value is 1.\n The maximum value is 100." }, "^(page_token)$": { "default": "", "description": "A page token, received from a previous `ListTasks` call.\n `ListTasksResponse.next_page_token`.\n Provide this to retrieve the subsequent page.", "type": "string" }, "^(status_timestamp_after)$": { "$ref": "#/components/schemas/A2ATimestamp", "description": "Filter tasks which have a status updated after the provided timestamp in ISO 8601 format (e.g., \"2023-10-27T10:00:00Z\").\n Only tasks with a status timestamp time greater than or equal to this value will be returned." } }, "properties": { "contextId": { "default": "", "description": "Filter tasks by context ID to get tasks from a specific conversation or session.", "type": "string" }, "historyLength": { "anyOf": [ { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, { "pattern": "^-?[0-9]+$", "type": "string" } ], "description": "The maximum number of messages to include in each task's history." }, "includeArtifacts": { "description": "Whether to include artifacts in the returned tasks.\n Defaults to false to reduce payload size.", "type": "boolean" }, "pageSize": { "anyOf": [ { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, { "pattern": "^-?[0-9]+$", "type": "string" } ], "description": "The maximum number of tasks to return. The service may return fewer than this value.\n If unspecified, at most 50 tasks will be returned.\n The minimum value is 1.\n The maximum value is 100." }, "pageToken": { "default": "", "description": "A page token, received from a previous `ListTasks` call.\n `ListTasksResponse.next_page_token`.\n Provide this to retrieve the subsequent page.", "type": "string" }, "status": { "anyOf": [ { "pattern": "^TASK_STATE_UNSPECIFIED$", "type": "string" }, { "enum": [ "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" ], "type": "string" }, { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" } ], "default": 0, "description": "Filter tasks by their current status state.", "title": "Task State" }, "statusTimestampAfter": { "$ref": "#/components/schemas/A2ATimestamp", "description": "Filter tasks which have a status updated after the provided timestamp in ISO 8601 format (e.g., \"2023-10-27T10:00:00Z\").\n Only tasks with a status timestamp time greater than or equal to this value will be returned." }, "tenant": { "default": "", "description": "Tenant ID, provided as a path parameter.", "type": "string" } }, "title": "List Tasks Request", "type": "object" }, "A2AListTasksResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "Result object for `ListTasks` method containing an array of tasks and pagination information.", "patternProperties": { "^(next_page_token)$": { "default": "", "description": "A token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" }, "^(page_size)$": { "anyOf": [ { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, { "pattern": "^-?[0-9]+$", "type": "string" } ], "default": 0, "description": "The page size used for this response." }, "^(total_size)$": { "anyOf": [ { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, { "pattern": "^-?[0-9]+$", "type": "string" } ], "default": 0, "description": "Total number of tasks available (before pagination)." } }, "properties": { "nextPageToken": { "default": "", "description": "A token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" }, "pageSize": { "anyOf": [ { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, { "pattern": "^-?[0-9]+$", "type": "string" } ], "default": 0, "description": "The page size used for this response." }, "tasks": { "description": "Array of tasks matching the specified criteria.", "items": { "$ref": "#/components/schemas/A2ATask" }, "type": "array" }, "totalSize": { "anyOf": [ { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, { "pattern": "^-?[0-9]+$", "type": "string" } ], "default": 0, "description": "Total number of tasks available (before pagination)." } }, "title": "List Tasks Response", "type": "object" }, "A2AMessage": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "`Message` is one unit of communication between client and server. It can be\n associated with a context and/or a task. For server messages, `context_id` must\n be provided, and `task_id` only if a task was created. For client messages, both\n fields are optional, with the caveat that if both are provided, they have to\n match (the `context_id` has to be the one that is set on the task). If only\n `task_id` is provided, the server will infer `context_id` from it.", "patternProperties": { "^(context_id)$": { "default": "", "description": "Optional. The context id of the message. If set, the message will be associated with the given context.", "type": "string" }, "^(message_id)$": { "default": "", "description": "The unique identifier (e.g. UUID) of the message. This is created by the message creator.", "type": "string" }, "^(reference_task_ids)$": { "description": "A list of task IDs that this message references for additional context.", "items": { "type": "string" }, "type": "array" }, "^(task_id)$": { "default": "", "description": "Optional. The task id of the message. If set, the message will be associated with the given task.", "type": "string" } }, "properties": { "contextId": { "default": "", "description": "Optional. The context id of the message. If set, the message will be associated with the given context.", "type": "string" }, "extensions": { "description": "The URIs of extensions that are present or contributed to this Message.", "items": { "type": "string" }, "type": "array" }, "messageId": { "default": "", "description": "The unique identifier (e.g. UUID) of the message. This is created by the message creator.", "type": "string" }, "metadata": { "$ref": "#/components/schemas/A2AStruct", "description": "Optional. Any metadata to provide along with the message." }, "parts": { "description": "Parts is the container of the message content.", "items": { "$ref": "#/components/schemas/A2APart" }, "type": "array" }, "referenceTaskIds": { "description": "A list of task IDs that this message references for additional context.", "items": { "type": "string" }, "type": "array" }, "role": { "anyOf": [ { "pattern": "^ROLE_UNSPECIFIED$", "type": "string" }, { "enum": [ "ROLE_USER", "ROLE_AGENT" ], "type": "string" }, { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" } ], "default": 0, "description": "Identifies the sender of the message.", "title": "Role" }, "taskId": { "default": "", "description": "Optional. The task id of the message. If set, the message will be associated with the given task.", "type": "string" } }, "title": "Message", "type": "object" }, "A2AMutualTlsSecurityScheme": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "Defines a security scheme using mTLS authentication.", "properties": { "description": { "default": "", "description": "An optional description for the security scheme.", "type": "string" } }, "title": "Mutual Tls Security Scheme", "type": "object" }, "A2AOAuth2SecurityScheme": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "Defines a security scheme using OAuth 2.0.", "patternProperties": { "^(oauth2_metadata_url)$": { "default": "", "description": "URL to the OAuth2 authorization server metadata [RFC 8414](https://datatracker.ietf.org/doc/html/rfc8414).\n TLS is required.", "type": "string" } }, "properties": { "description": { "default": "", "description": "An optional description for the security scheme.", "type": "string" }, "flows": { "$ref": "#/components/schemas/A2AOAuthFlows", "description": "An object containing configuration information for the supported OAuth 2.0 flows." }, "oauth2MetadataUrl": { "default": "", "description": "URL to the OAuth2 authorization server metadata [RFC 8414](https://datatracker.ietf.org/doc/html/rfc8414).\n TLS is required.", "type": "string" } }, "title": "O Auth2 Security Scheme", "type": "object" }, "A2AOAuthFlows": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "Defines the configuration for the supported OAuth 2.0 flows.", "patternProperties": { "^(authorization_code)$": { "$ref": "#/components/schemas/A2AAuthorizationCodeOAuthFlow", "description": "Configuration for the OAuth Authorization Code flow." }, "^(client_credentials)$": { "$ref": "#/components/schemas/A2AClientCredentialsOAuthFlow", "description": "Configuration for the OAuth Client Credentials flow." }, "^(device_code)$": { "$ref": "#/components/schemas/A2ADeviceCodeOAuthFlow", "description": "Configuration for the OAuth Device Code flow." } }, "properties": { "authorizationCode": { "$ref": "#/components/schemas/A2AAuthorizationCodeOAuthFlow", "description": "Configuration for the OAuth Authorization Code flow." }, "clientCredentials": { "$ref": "#/components/schemas/A2AClientCredentialsOAuthFlow", "description": "Configuration for the OAuth Client Credentials flow." }, "deviceCode": { "$ref": "#/components/schemas/A2ADeviceCodeOAuthFlow", "description": "Configuration for the OAuth Device Code flow." }, "implicit": { "$ref": "#/components/schemas/A2AImplicitOAuthFlow", "description": "Deprecated: Use Authorization Code + PKCE instead." }, "password": { "$ref": "#/components/schemas/A2APasswordOAuthFlow", "description": "Deprecated: Use Authorization Code + PKCE or Device Code." } }, "title": "O Auth Flows", "type": "object" }, "A2AOpenIdConnectSecurityScheme": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "Defines a security scheme using OpenID Connect.", "patternProperties": { "^(open_id_connect_url)$": { "default": "", "description": "The [OpenID Connect Discovery URL](https://openid.net/specs/openid-connect-discovery-1_0.html) for the OIDC provider's metadata.", "type": "string" } }, "properties": { "description": { "default": "", "description": "An optional description for the security scheme.", "type": "string" }, "openIdConnectUrl": { "default": "", "description": "The [OpenID Connect Discovery URL](https://openid.net/specs/openid-connect-discovery-1_0.html) for the OIDC provider's metadata.", "type": "string" } }, "title": "Open Id Connect Security Scheme", "type": "object" }, "A2APart": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "`Part` represents a container for a section of communication content.\n Parts can be purely textual, some sort of file (image, video, etc) or\n a structured data blob (i.e. JSON).", "patternProperties": { "^(media_type)$": { "default": "", "description": "The `media_type` (MIME type) of the part content (e.g., \"text/plain\", \"application/json\", \"image/png\").\n This field is available for all part types.", "type": "string" } }, "properties": { "data": { "$ref": "#/components/schemas/A2AValue", "description": "Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null)." }, "filename": { "default": "", "description": "An optional `filename` for the file (e.g., \"document.pdf\").", "type": "string" }, "mediaType": { "default": "", "description": "The `media_type` (MIME type) of the part content (e.g., \"text/plain\", \"application/json\", \"image/png\").\n This field is available for all part types.", "type": "string" }, "metadata": { "$ref": "#/components/schemas/A2AStruct", "description": "Optional. metadata associated with this part." }, "raw": { "description": "The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.", "pattern": "^[A-Za-z0-9+/]*={0,2}$", "type": "string" }, "text": { "description": "The string content of the `text` part.", "type": "string" }, "url": { "description": "A `url` pointing to the file's content.", "type": "string" } }, "title": "Part", "type": "object" }, "A2APasswordOAuthFlow": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "Deprecated: Use Authorization Code + PKCE or Device Code.", "patternProperties": { "^(refresh_url)$": { "default": "", "description": "The URL to be used for obtaining refresh tokens. This MUST be in the\n form of a URL. The OAuth2 standard requires the use of TLS.", "type": "string" }, "^(token_url)$": { "default": "", "description": "The token URL to be used for this flow. This MUST be in the form of a URL.\n The OAuth2 standard requires the use of TLS.", "type": "string" } }, "properties": { "refreshUrl": { "default": "", "description": "The URL to be used for obtaining refresh tokens. This MUST be in the\n form of a URL. The OAuth2 standard requires the use of TLS.", "type": "string" }, "scopes": { "additionalProperties": { "type": "string" }, "description": "The available scopes for the OAuth2 security scheme. A map between the\n scope name and a short description for it. The map MAY be empty.", "propertyNames": { "type": "string" }, "type": "object" }, "tokenUrl": { "default": "", "description": "The token URL to be used for this flow. This MUST be in the form of a URL.\n The OAuth2 standard requires the use of TLS.", "type": "string" } }, "title": "PasswordO Auth Flow", "type": "object" }, "A2ASecurityRequirement": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "Defines the security requirements for an agent.", "properties": { "schemes": { "additionalProperties": { "$ref": "#/components/schemas/A2AStringList" }, "description": "A map of security schemes to the required scopes.", "propertyNames": { "type": "string" }, "type": "object" } }, "title": "Security Requirement", "type": "object" }, "A2ASecurityScheme": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "Defines a security scheme that can be used to secure an agent's endpoints.\n This is a discriminated union type based on the OpenAPI 3.2 Security Scheme Object.\n See: https://spec.openapis.org/oas/v3.2.0.html#security-scheme-object", "patternProperties": { "^(api_key_security_scheme)$": { "$ref": "#/components/schemas/A2AAPIKeySecurityScheme", "description": "API key-based authentication." }, "^(http_auth_security_scheme)$": { "$ref": "#/components/schemas/A2AHTTPAuthSecurityScheme", "description": "HTTP authentication (Basic, Bearer, etc.)." }, "^(mtls_security_scheme)$": { "$ref": "#/components/schemas/A2AMutualTlsSecurityScheme", "description": "Mutual TLS authentication." }, "^(oauth2_security_scheme)$": { "$ref": "#/components/schemas/A2AOAuth2SecurityScheme", "description": "OAuth 2.0 authentication." }, "^(open_id_connect_security_scheme)$": { "$ref": "#/components/schemas/A2AOpenIdConnectSecurityScheme", "description": "OpenID Connect authentication." } }, "properties": { "apiKeySecurityScheme": { "$ref": "#/components/schemas/A2AAPIKeySecurityScheme", "description": "API key-based authentication." }, "httpAuthSecurityScheme": { "$ref": "#/components/schemas/A2AHTTPAuthSecurityScheme", "description": "HTTP authentication (Basic, Bearer, etc.)." }, "mtlsSecurityScheme": { "$ref": "#/components/schemas/A2AMutualTlsSecurityScheme", "description": "Mutual TLS authentication." }, "oauth2SecurityScheme": { "$ref": "#/components/schemas/A2AOAuth2SecurityScheme", "description": "OAuth 2.0 authentication." }, "openIdConnectSecurityScheme": { "$ref": "#/components/schemas/A2AOpenIdConnectSecurityScheme", "description": "OpenID Connect authentication." } }, "title": "Security Scheme", "type": "object" }, "A2ASendMessageConfiguration": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "Configuration of a send message request.", "patternProperties": { "^(accepted_output_modes)$": { "description": "A list of media types the client is prepared to accept for response parts.\n Agents SHOULD use this to tailor their output.", "items": { "type": "string" }, "type": "array" }, "^(history_length)$": { "anyOf": [ { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, { "pattern": "^-?[0-9]+$", "type": "string" } ], "description": "The maximum number of most recent messages from the task's history to retrieve in\n the response. An unset value means the client does not impose any limit. A\n value of zero is a request to not include any messages. The server MUST NOT\n return more messages than the provided value, but MAY apply a lower limit." }, "^(return_immediately)$": { "default": false, "description": "If `true`, the operation returns immediately after creating the task,\n even if processing is still in progress.\n If `false` (default), the operation MUST wait until the task reaches a\n terminal (`COMPLETED`, `FAILED`, `CANCELED`, `REJECTED`) or interrupted\n (`INPUT_REQUIRED`, `AUTH_REQUIRED`) state before returning.", "type": "boolean" }, "^(task_push_notification_config)$": { "$ref": "#/components/schemas/A2ATaskPushNotificationConfig", "description": "Configuration for the agent to send push notifications for task updates.\n Task id should be empty when sending this configuration in a `SendMessage` request." } }, "properties": { "acceptedOutputModes": { "description": "A list of media types the client is prepared to accept for response parts.\n Agents SHOULD use this to tailor their output.", "items": { "type": "string" }, "type": "array" }, "historyLength": { "anyOf": [ { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, { "pattern": "^-?[0-9]+$", "type": "string" } ], "description": "The maximum number of most recent messages from the task's history to retrieve in\n the response. An unset value means the client does not impose any limit. A\n value of zero is a request to not include any messages. The server MUST NOT\n return more messages than the provided value, but MAY apply a lower limit." }, "returnImmediately": { "default": false, "description": "If `true`, the operation returns immediately after creating the task,\n even if processing is still in progress.\n If `false` (default), the operation MUST wait until the task reaches a\n terminal (`COMPLETED`, `FAILED`, `CANCELED`, `REJECTED`) or interrupted\n (`INPUT_REQUIRED`, `AUTH_REQUIRED`) state before returning.", "type": "boolean" }, "taskPushNotificationConfig": { "$ref": "#/components/schemas/A2ATaskPushNotificationConfig", "description": "Configuration for the agent to send push notifications for task updates.\n Task id should be empty when sending this configuration in a `SendMessage` request." } }, "title": "Send Message Configuration", "type": "object" }, "A2ASendMessageRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "Represents a request for the `SendMessage` method.", "properties": { "configuration": { "$ref": "#/components/schemas/A2ASendMessageConfiguration", "description": "Configuration for the send request." }, "message": { "$ref": "#/components/schemas/A2AMessage", "description": "The message to send to the agent." }, "metadata": { "$ref": "#/components/schemas/A2AStruct", "description": "A flexible key-value map for passing additional context or parameters." }, "tenant": { "default": "", "description": "Optional. Tenant ID, provided as a path parameter.", "type": "string" } }, "title": "Send Message Request", "type": "object" }, "A2ASendMessageResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "Represents the response for the `SendMessage` method.", "properties": { "message": { "$ref": "#/components/schemas/A2AMessage", "description": "A message from the agent." }, "task": { "$ref": "#/components/schemas/A2ATask", "description": "The task created or updated by the message." } }, "title": "Send Message Response", "type": "object" }, "A2AStreamResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "A wrapper object used in streaming operations to encapsulate different types of response data.", "patternProperties": { "^(artifact_update)$": { "$ref": "#/components/schemas/A2ATaskArtifactUpdateEvent", "description": "An event indicating a task artifact update." }, "^(status_update)$": { "$ref": "#/components/schemas/A2ATaskStatusUpdateEvent", "description": "An event indicating a task status update." } }, "properties": { "artifactUpdate": { "$ref": "#/components/schemas/A2ATaskArtifactUpdateEvent", "description": "An event indicating a task artifact update." }, "message": { "$ref": "#/components/schemas/A2AMessage", "description": "A Message object containing a message from the agent." }, "statusUpdate": { "$ref": "#/components/schemas/A2ATaskStatusUpdateEvent", "description": "An event indicating a task status update." }, "task": { "$ref": "#/components/schemas/A2ATask", "description": "A Task object containing the current state of the task." } }, "title": "Stream Response", "type": "object" }, "A2AStringList": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "A list of strings.", "properties": { "list": { "description": "The individual string values.", "items": { "type": "string" }, "type": "array" } }, "title": "String List", "type": "object" }, "A2AStruct": { "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Struct", "type": "object" }, "A2ASubscribeToTaskRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "Represents a request for the `SubscribeToTask` method.", "properties": { "id": { "default": "", "description": "The resource ID of the task to subscribe to.", "type": "string" }, "tenant": { "default": "", "description": "Optional. Tenant ID, provided as a path parameter.", "type": "string" } }, "title": "Subscribe To Task Request", "type": "object" }, "A2ATask": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "`Task` is the core unit of action for A2A. It has a current status\n and when results are created for the task they are stored in the\n artifact. If there are multiple turns for a task, these are stored in\n history.", "patternProperties": { "^(context_id)$": { "default": "", "description": "Unique identifier (e.g. UUID) for the contextual collection of interactions\n (tasks and messages).", "type": "string" } }, "properties": { "artifacts": { "description": "A set of output artifacts for a `Task`.", "items": { "$ref": "#/components/schemas/A2AArtifact" }, "type": "array" }, "contextId": { "default": "", "description": "Unique identifier (e.g. UUID) for the contextual collection of interactions\n (tasks and messages).", "type": "string" }, "history": { "description": "The history of interactions from a `Task`.", "items": { "$ref": "#/components/schemas/A2AMessage" }, "type": "array" }, "id": { "default": "", "description": "Unique identifier (e.g. UUID) for the task, generated by the server for a\n new task.", "type": "string" }, "metadata": { "$ref": "#/components/schemas/A2AStruct", "description": "A key/value object to store custom metadata about a task." }, "status": { "$ref": "#/components/schemas/A2ATaskStatus", "description": "The current status of a `Task`, including `state` and a `message`." } }, "title": "Task", "type": "object" }, "A2ATaskArtifactUpdateEvent": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "A task delta where an artifact has been generated.", "patternProperties": { "^(context_id)$": { "default": "", "description": "The ID of the context that this task belongs to.", "type": "string" }, "^(last_chunk)$": { "default": false, "description": "If true, this is the final chunk of the artifact.", "type": "boolean" }, "^(task_id)$": { "default": "", "description": "The ID of the task for this artifact.", "type": "string" } }, "properties": { "append": { "default": false, "description": "If true, the content of this artifact should be appended to a previously\n sent artifact with the same ID.", "type": "boolean" }, "artifact": { "$ref": "#/components/schemas/A2AArtifact", "description": "The artifact that was generated or updated." }, "contextId": { "default": "", "description": "The ID of the context that this task belongs to.", "type": "string" }, "lastChunk": { "default": false, "description": "If true, this is the final chunk of the artifact.", "type": "boolean" }, "metadata": { "$ref": "#/components/schemas/A2AStruct", "description": "Optional. Metadata associated with the artifact update." }, "taskId": { "default": "", "description": "The ID of the task for this artifact.", "type": "string" } }, "title": "Task Artifact Update Event", "type": "object" }, "A2ATaskPushNotificationConfig": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "A container associating a push notification configuration with a specific task.", "patternProperties": { "^(task_id)$": { "default": "", "description": "The ID of the task this configuration is associated with.", "type": "string" } }, "properties": { "authentication": { "$ref": "#/components/schemas/A2AAuthenticationInfo", "description": "Authentication information required to send the notification." }, "id": { "default": "", "description": "The push notification configuration details.\n A unique identifier (e.g. UUID) for this push notification configuration.", "type": "string" }, "taskId": { "default": "", "description": "The ID of the task this configuration is associated with.", "type": "string" }, "tenant": { "default": "", "description": "Optional. Tenant ID.", "type": "string" }, "token": { "default": "", "description": "A token unique for this task or session.", "type": "string" }, "url": { "default": "", "description": "The URL where the notification should be sent.", "type": "string" } }, "title": "Task Push Notification Config", "type": "object" }, "A2ATaskStatus": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "A container for the status of a task", "properties": { "message": { "$ref": "#/components/schemas/A2AMessage", "description": "A message associated with the status." }, "state": { "anyOf": [ { "pattern": "^TASK_STATE_UNSPECIFIED$", "type": "string" }, { "enum": [ "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" ], "type": "string" }, { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" } ], "default": 0, "description": "The current state of this task.", "title": "Task State" }, "timestamp": { "$ref": "#/components/schemas/A2ATimestamp", "description": "ISO 8601 Timestamp when the status was recorded.\n Example: \"2023-10-27T10:00:00Z\"" } }, "title": "Task Status", "type": "object" }, "A2ATaskStatusUpdateEvent": { "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "An event sent by the agent to notify the client of a change in a task's status.", "patternProperties": { "^(context_id)$": { "default": "", "description": "The ID of the context that the task belongs to.", "type": "string" }, "^(task_id)$": { "default": "", "description": "The ID of the task that has changed.", "type": "string" } }, "properties": { "contextId": { "default": "", "description": "The ID of the context that the task belongs to.", "type": "string" }, "metadata": { "$ref": "#/components/schemas/A2AStruct", "description": "Optional. Metadata associated with the task update." }, "status": { "$ref": "#/components/schemas/A2ATaskStatus", "description": "The new status of the task." }, "taskId": { "default": "", "description": "The ID of the task that has changed.", "type": "string" } }, "title": "Task Status Update Event", "type": "object" }, "A2ATimestamp": { "$schema": "https://json-schema.org/draft/2020-12/schema", "format": "date-time", "title": "Timestamp", "type": "string" }, "A2AValue": { "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Value" }, "AdminAgentCategory": { "description": "A category with the number of Agents it holds.", "properties": { "agents": { "title": "Agents", "type": "integer" }, "category_id": { "title": "Category Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "position": { "title": "Position", "type": "integer" } }, "required": [ "category_id", "name", "position", "agents" ], "title": "AdminAgentCategory", "type": "object" }, "AdminApiWorkspaceResult": { "additionalProperties": true, "description": "What a wake or hibernate did to one assistant's workspace.\n\nOnly ``assistant_id`` is this surface's own. The rest of the object is the\nworkspace state\n(:meth:`~astrabox.core.service.orchestrator.assistant.assistant_service.AssistantService.wake_workspace`\n/ ``hibernate_workspace``), which differs per branch — a wake that found a\nready box reports different facts from one that started a bootstrap — so it\nis carried rather than flattened into one shape that would be wrong for\nmost of them.", "properties": { "assistant_id": { "title": "Assistant Id", "type": "string" } }, "required": [ "assistant_id" ], "title": "AdminApiWorkspaceResult", "type": "object" }, "AdminAsyncioTasks": { "additionalProperties": true, "description": "Task totals, and the first 100 pending tasks themselves.", "properties": { "pending_task_count": { "title": "Pending Task Count", "type": "integer" }, "sample_pending_tasks": { "items": { "$ref": "#/components/schemas/AdminPendingTask" }, "title": "Sample Pending Tasks", "type": "array" }, "task_count": { "title": "Task Count", "type": "integer" } }, "required": [ "task_count", "pending_task_count", "sample_pending_tasks" ], "title": "AdminAsyncioTasks", "type": "object" }, "AdminDeletedRuntimeProfile": { "additionalProperties": true, "description": "The identity of the preset removed by an administrator.", "properties": { "deleted": { "title": "Deleted", "type": "boolean" }, "name": { "title": "Name", "type": "string" } }, "required": [ "name", "deleted" ], "title": "AdminDeletedRuntimeProfile", "type": "object" }, "AdminEnvironment": { "additionalProperties": true, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "display_name": { "title": "Display Name", "type": "string" }, "member_user_ids": { "items": { "type": "string" }, "title": "Member User Ids", "type": "array" }, "name": { "title": "Name", "type": "string" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "name", "display_name", "description", "version", "member_user_ids" ], "title": "AdminEnvironment", "type": "object" }, "AdminErrorsPage": { "additionalProperties": true, "description": "Recent failures, session rows and captured runtime errors together.\n\n``counts`` tallies the returned page by source and severity; ``limit`` is\nthe clamped limit that produced it, not the one that was asked for.", "properties": { "counts": { "additionalProperties": { "type": "integer" }, "title": "Counts", "type": "object" }, "errors": { "items": { "additionalProperties": true, "type": "object" }, "title": "Errors", "type": "array" }, "limit": { "title": "Limit", "type": "integer" } }, "required": [ "errors", "counts", "limit" ], "title": "AdminErrorsPage", "type": "object" }, "AdminEvictResult": { "additionalProperties": true, "description": "The session whose cached runtime was dropped from this process.", "properties": { "evicted": { "title": "Evicted", "type": "string" } }, "required": [ "evicted" ], "title": "AdminEvictResult", "type": "object" }, "AdminFileDescriptors": { "additionalProperties": true, "description": "Open descriptors against this process's own limit.\n\nEvery field is null on a platform that does not publish it; a null is\n\"unknown\", which a caller must not render as 0.", "properties": { "count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Count" }, "hard_limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Hard Limit" }, "soft_limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Soft Limit" }, "usage_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Usage Ratio" } }, "required": [ "count", "soft_limit", "hard_limit", "usage_ratio" ], "title": "AdminFileDescriptors", "type": "object" }, "AdminFormSchema": { "additionalProperties": true, "description": "The editable schema an admin form renders.\n\nOne grammar, two producers:\n:func:`~astrabox.core.service.orchestrator.agent_schema.get_agent_schema`\nand\n:func:`~astrabox.core.service.orchestrator.runtime_profile_schema.get_runtime_profile_schema`.\n``groups`` and ``fields`` are the form's own vocabulary (key, type, enum,\ndefault, help), which the console reads and this module does not interpret.", "properties": { "fields": { "items": { "additionalProperties": true, "type": "object" }, "title": "Fields", "type": "array" }, "groups": { "items": { "additionalProperties": true, "type": "object" }, "title": "Groups", "type": "array" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "version", "groups", "fields" ], "title": "AdminFormSchema", "type": "object" }, "AdminHistoryImportMessage": { "additionalProperties": false, "description": "One earlier message of a migrated conversation.\n\n``blocks`` use the transcript's content blocks: ``text`` and ``image`` for\na user message; for a reply also ``thinking``, ``tool_use`` and the\n``tool_result`` answering a call earlier in the same reply. ``completion``\nis required on a reply: ``unknown`` when the source recorded no ending.", "properties": { "blocks": { "items": { "additionalProperties": true, "type": "object" }, "title": "Blocks", "type": "array" }, "completion": { "anyOf": [ { "enum": [ "complete", "unknown" ], "type": "string" }, { "type": "null" } ], "title": "Completion" }, "created_at": { "title": "Created At", "type": "string" }, "parent_source_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Source Id" }, "role": { "enum": [ "user", "assistant" ], "title": "Role", "type": "string" }, "source_id": { "title": "Source Id", "type": "string" } }, "required": [ "source_id", "role", "created_at", "blocks" ], "title": "AdminHistoryImportMessage", "type": "object" }, "AdminHistoryImportRequest": { "additionalProperties": false, "description": "Messages in conversation order; a re-run carries the same ones first.", "properties": { "messages": { "items": { "$ref": "#/components/schemas/AdminHistoryImportMessage" }, "title": "Messages", "type": "array" } }, "required": [ "messages" ], "title": "AdminHistoryImportRequest", "type": "object" }, "AdminHistoryImportResult": { "additionalProperties": false, "description": "How many messages this call added, and how many were already imported.", "properties": { "imported": { "title": "Imported", "type": "integer" }, "unchanged": { "title": "Unchanged", "type": "integer" } }, "required": [ "imported", "unchanged" ], "title": "AdminHistoryImportResult", "type": "object" }, "AdminKillResult": { "additionalProperties": true, "description": "What an admin kill did to one session's sandbox.\n\n``killed`` is True only for a confirmed destruction — something other than\nthe delete call itself reported the box gone. ``destruction`` carries the\nverdict's own name and ``destruction_detail`` the reason, so an unconfirmed\nkill is legible as unconfirmed rather than as a failure or a success.", "properties": { "destruction": { "title": "Destruction", "type": "string" }, "destruction_detail": { "title": "Destruction Detail", "type": "string" }, "killed": { "title": "Killed", "type": "boolean" }, "sandbox_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sandbox Id" }, "session_id": { "title": "Session Id", "type": "string" } }, "required": [ "session_id", "sandbox_id", "killed", "destruction", "destruction_detail" ], "title": "AdminKillResult", "type": "object" }, "AdminLogsPage": { "additionalProperties": true, "description": "A tail of one log file on the host answering the request.\n\n``available_files`` is what this host actually has, which is empty when the\ndeployment logs to stderr; ``log_path`` and ``current_file`` name the file\nthe tail came from, and ``count`` is the number of lines after filtering.", "properties": { "available_files": { "items": { "type": "string" }, "title": "Available Files", "type": "array" }, "count": { "title": "Count", "type": "integer" }, "current_file": { "title": "Current File", "type": "string" }, "lines": { "items": { "type": "string" }, "title": "Lines", "type": "array" }, "log_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Log Path" }, "machine_id": { "title": "Machine Id", "type": "string" } }, "required": [ "machine_id", "log_path", "current_file", "available_files", "lines", "count" ], "title": "AdminLogsPage", "type": "object" }, "AdminMemory": { "additionalProperties": true, "description": "Resident memory, null where the platform does not report it.", "properties": { "max_rss_mb": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Max Rss Mb" }, "rss_mb": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Rss Mb" } }, "required": [ "rss_mb", "max_rss_mb" ], "title": "AdminMemory", "type": "object" }, "AdminNavigationSummary": { "additionalProperties": true, "description": "Collection totals displayed in the management rail.", "properties": { "agents": { "title": "Agents", "type": "integer" }, "runtime_profiles": { "title": "Runtime Profiles", "type": "integer" }, "sessions": { "title": "Sessions", "type": "integer" } }, "required": [ "agents", "runtime_profiles", "sessions" ], "title": "AdminNavigationSummary", "type": "object" }, "AdminOverviewProcessHealth": { "additionalProperties": true, "description": "The overview's four-number digest of :class:`AdminProcessHealth`.", "properties": { "fd_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fd Count" }, "pending_task_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Pending Task Count" }, "severity": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Severity" }, "thread_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Thread Count" } }, "required": [ "severity", "thread_count", "fd_count", "pending_task_count" ], "title": "AdminOverviewProcessHealth", "type": "object" }, "AdminPendingTask": { "additionalProperties": true, "properties": { "coro": { "title": "Coro", "type": "string" }, "name": { "title": "Name", "type": "string" } }, "required": [ "name", "coro" ], "title": "AdminPendingTask", "type": "object" }, "AdminProcessHealth": { "additionalProperties": true, "description": "A live reading of the process answering the request.\n\nNothing here is stored: every field is measured when the request arrives,\nso two calls a second apart legitimately disagree. ``severity`` is the\nserver's own verdict over these numbers — a caller renders it rather than\nrecomputing it, so one deployment's thresholds stay in one place.", "properties": { "asyncio": { "$ref": "#/components/schemas/AdminAsyncioTasks" }, "captured_at": { "title": "Captured At", "type": "string" }, "file_descriptors": { "$ref": "#/components/schemas/AdminFileDescriptors" }, "load_avg": { "items": { "type": "number" }, "title": "Load Avg", "type": "array" }, "machine_id": { "title": "Machine Id", "type": "string" }, "memory": { "$ref": "#/components/schemas/AdminMemory" }, "pid": { "title": "Pid", "type": "integer" }, "runtimes": { "$ref": "#/components/schemas/AdminRuntimes" }, "session_feed": { "$ref": "#/components/schemas/AdminSessionFeedHealth" }, "severity": { "title": "Severity", "type": "string" }, "threads": { "$ref": "#/components/schemas/AdminThreads" } }, "required": [ "severity", "machine_id", "pid", "captured_at", "threads", "file_descriptors", "asyncio", "memory", "load_avg", "runtimes", "session_feed" ], "title": "AdminProcessHealth", "type": "object" }, "AdminRuntimeProfileModels": { "additionalProperties": true, "description": "Model ids an environment's provider can offer.\n\nEmpty when the provider publishes no authoritative catalog; the console\nthen accepts a free-text model id.", "properties": { "models": { "items": { "type": "string" }, "title": "Models", "type": "array" } }, "required": [ "models" ], "title": "AdminRuntimeProfileModels", "type": "object" }, "AdminRuntimeRow": { "additionalProperties": true, "description": "One session runtime this process is holding open.\n\nThe three flags are null when the runtime does not carry that object at\nall, which is a different answer from False.", "properties": { "lock_locked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Lock Locked" }, "owner_loop_running": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Owner Loop Running" }, "sandbox_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sandbox Id" }, "session_id": { "title": "Session Id", "type": "string" } }, "required": [ "session_id", "sandbox_id", "lock_locked", "owner_loop_running" ], "title": "AdminRuntimeRow", "type": "object" }, "AdminRuntimes": { "additionalProperties": true, "properties": { "count": { "title": "Count", "type": "integer" }, "items": { "items": { "$ref": "#/components/schemas/AdminRuntimeRow" }, "title": "Items", "type": "array" }, "locked_count": { "title": "Locked Count", "type": "integer" } }, "required": [ "count", "locked_count", "items" ], "title": "AdminRuntimes", "type": "object" }, "AdminSandboxDiagnostics": { "additionalProperties": true, "description": "One plain-text diagnostic report about one sandbox.\n\n``text`` carries no schema — it is the backend's prose, transported inside\nJSON. ``known_scopes`` is the accepted scope vocabulary, not a list of the\nreports this sandbox can produce.", "properties": { "backend": { "title": "Backend", "type": "string" }, "content_type": { "title": "Content Type", "type": "string" }, "known_scopes": { "items": { "type": "string" }, "title": "Known Scopes", "type": "array" }, "sandbox_id": { "title": "Sandbox Id", "type": "string" }, "scope": { "title": "Scope", "type": "string" }, "text": { "title": "Text", "type": "string" }, "truncated": { "title": "Truncated", "type": "boolean" } }, "required": [ "sandbox_id", "backend", "scope", "content_type", "text", "truncated", "known_scopes" ], "title": "AdminSandboxDiagnostics", "type": "object" }, "AdminSandboxEgressRule": { "additionalProperties": true, "description": "One egress rule as the box's sidecar reports it.", "properties": { "action": { "title": "Action", "type": "string" }, "target": { "title": "Target", "type": "string" } }, "required": [ "action", "target" ], "title": "AdminSandboxEgressRule", "type": "object" }, "AdminSandboxIdleAction": { "additionalProperties": true, "description": "Which idle actions a backend can carry out, and the installation default.", "properties": { "actions": { "items": { "type": "string" }, "title": "Actions", "type": "array" }, "backend": { "title": "Backend", "type": "string" }, "default_action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Default Action" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Detail" }, "supported_actions": { "items": { "type": "string" }, "title": "Supported Actions", "type": "array" } }, "required": [ "backend", "actions", "supported_actions", "default_action", "detail" ], "title": "AdminSandboxIdleAction", "type": "object" }, "AdminSandboxIdleSweep": { "additionalProperties": true, "description": "What one forced run of the idle/expiry sweep did.\n\n``summary`` holds the tick's own counters\n(:meth:`~astrabox.core.service.orchestrator.expiration_watcher.ExpirationWatcher.scan_once`);\nan empty object means neither sweep found a candidate.", "properties": { "summary": { "additionalProperties": { "type": "integer" }, "title": "Summary", "type": "object" } }, "required": [ "summary" ], "title": "AdminSandboxIdleSweep", "type": "object" }, "AdminSandboxPage": { "additionalProperties": true, "description": "One page of a backend's inventory.", "properties": { "backend": { "title": "Backend", "type": "string" }, "items": { "items": { "$ref": "#/components/schemas/AdminSandboxSummary" }, "title": "Items", "type": "array" }, "pagination": { "$ref": "#/components/schemas/AdminSandboxPagination" } }, "required": [ "backend", "items", "pagination" ], "title": "AdminSandboxPage", "type": "object" }, "AdminSandboxPagination": { "additionalProperties": true, "description": "The backend's own paging counters, passed through.", "properties": { "has_next_page": { "title": "Has Next Page", "type": "boolean" }, "page": { "title": "Page", "type": "integer" }, "page_size": { "title": "Page Size", "type": "integer" }, "total_items": { "title": "Total Items", "type": "integer" }, "total_pages": { "title": "Total Pages", "type": "integer" } }, "required": [ "page", "page_size", "total_items", "total_pages", "has_next_page" ], "title": "AdminSandboxPagination", "type": "object" }, "AdminSandboxQuota": { "additionalProperties": true, "description": "The sandbox quota of every enabled backend.", "properties": { "backends": { "items": { "$ref": "#/components/schemas/AdminSandboxQuotaBackend" }, "title": "Backends", "type": "array" } }, "required": [ "backends" ], "title": "AdminSandboxQuota", "type": "object" }, "AdminSandboxQuotaBackend": { "additionalProperties": true, "description": "One enabled backend's quota, usage and boxes.", "properties": { "backend": { "title": "Backend", "type": "string" }, "boxes": { "items": { "$ref": "#/components/schemas/AdminSandboxQuotaBox" }, "title": "Boxes", "type": "array" }, "inventory_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Inventory At" }, "quota": { "$ref": "#/components/schemas/AdminSandboxQuotaCeilings" }, "reservations": { "items": { "$ref": "#/components/schemas/AdminSandboxQuotaReservation" }, "title": "Reservations", "type": "array" }, "usage": { "$ref": "#/components/schemas/AdminSandboxQuotaUsage" } }, "required": [ "backend", "quota", "usage", "inventory_at", "boxes", "reservations" ], "title": "AdminSandboxQuotaBackend", "type": "object" }, "AdminSandboxQuotaBox": { "additionalProperties": true, "description": "One box of the backend's last inventory, with what it is charged.", "properties": { "cpu": { "title": "Cpu", "type": "number" }, "memory": { "title": "Memory", "type": "integer" }, "sandbox_id": { "title": "Sandbox Id", "type": "string" }, "session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Session Id" }, "state": { "title": "State", "type": "string" } }, "required": [ "sandbox_id", "cpu", "memory", "state", "session_id" ], "title": "AdminSandboxQuotaBox", "type": "object" }, "AdminSandboxQuotaCeilings": { "additionalProperties": true, "description": "A backend's quota ceilings; ``null`` is no ceiling.", "properties": { "boxes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Boxes" }, "concurrent_creates": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Concurrent Creates" }, "cpu": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cpu" }, "memory_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Memory Bytes" }, "sources": { "additionalProperties": { "type": "string" }, "title": "Sources", "type": "object" } }, "required": [ "boxes", "memory_bytes", "cpu", "concurrent_creates", "sources" ], "title": "AdminSandboxQuotaCeilings", "type": "object" }, "AdminSandboxQuotaReservation": { "additionalProperties": true, "description": "Room taken for a box the inventory does not show yet.", "properties": { "cpu": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cpu" }, "memory": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Memory" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "reserved_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reserved At" }, "sandbox_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sandbox Id" }, "session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Session Id" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State" } }, "required": [ "state", "reason", "session_id", "sandbox_id", "cpu", "memory", "reserved_at" ], "title": "AdminSandboxQuotaReservation", "type": "object" }, "AdminSandboxQuotaUsage": { "additionalProperties": true, "description": "What the backend's boxes and pending creates hold against the quota.", "properties": { "boxes": { "title": "Boxes", "type": "integer" }, "cpu": { "title": "Cpu", "type": "number" }, "creating": { "title": "Creating", "type": "integer" }, "memory_bytes": { "title": "Memory Bytes", "type": "integer" } }, "required": [ "boxes", "memory_bytes", "cpu", "creating" ], "title": "AdminSandboxQuotaUsage", "type": "object" }, "AdminSandboxSecurity": { "additionalProperties": true, "description": "What one sandbox reports about its own containment.", "properties": { "available": { "title": "Available", "type": "boolean" }, "binding_names": { "items": { "type": "string" }, "title": "Binding Names", "type": "array" }, "credential_names": { "items": { "type": "string" }, "title": "Credential Names", "type": "array" }, "default_action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Default Action" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Detail" }, "egress_rules": { "items": { "$ref": "#/components/schemas/AdminSandboxEgressRule" }, "title": "Egress Rules", "type": "array" }, "sandbox_id": { "title": "Sandbox Id", "type": "string" } }, "required": [ "sandbox_id", "available", "default_action", "egress_rules", "credential_names", "binding_names", "detail" ], "title": "AdminSandboxSecurity", "type": "object" }, "AdminSandboxSummary": { "additionalProperties": true, "description": "One sandbox, as :func:`_descriptor_payload` renders it.", "properties": { "backend": { "title": "Backend", "type": "string" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "endpoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Endpoint" }, "entrypoint": { "items": { "type": "string" }, "title": "Entrypoint", "type": "array" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image" }, "metadata": { "additionalProperties": { "type": "string" }, "title": "Metadata", "type": "object" }, "sandbox_id": { "title": "Sandbox Id", "type": "string" }, "session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Session Id" }, "state": { "title": "State", "type": "string" } }, "required": [ "sandbox_id", "backend", "state", "created_at", "expires_at", "image", "entrypoint", "metadata", "session_id", "endpoint" ], "title": "AdminSandboxSummary", "type": "object" }, "AdminSessionDetail": { "additionalProperties": true, "description": "A sanitized stored session plus the operator's runtime projection.", "properties": { "agent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agent Id" }, "agent_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agent State" }, "assistant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assistant Id" }, "conversation_state": { "title": "Conversation State", "type": "string" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "current_responses": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseView" }, "type": "array" }, { "type": "null" } ], "title": "Current Responses" }, "deployment_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deployment Name" }, "engine_available": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Engine Available" }, "engine_capabilities": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Engine Capabilities" }, "engine_kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Engine Kind" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "has_local_runtime": { "title": "Has Local Runtime", "type": "boolean" }, "held_inputs": { "anyOf": [ { "items": { "$ref": "#/components/schemas/HeldInputView" }, "type": "array" }, { "type": "null" } ], "title": "Held Inputs" }, "last_error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Error" }, "last_output_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Output At" }, "last_response": { "anyOf": [ { "$ref": "#/components/schemas/ResponseView" }, { "type": "null" } ] }, "mcp_connections": { "items": {}, "title": "Mcp Connections", "type": "array" }, "model_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Name" }, "output_seq": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Output Seq" }, "pending_interaction": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Pending Interaction" }, "permission_mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Permission Mode" }, "read_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Read At" }, "recovery_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Recovery Reason" }, "runtime_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Runtime Status" }, "runtime_unavailable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Runtime Unavailable" }, "runtime_versions": { "additionalProperties": true, "title": "Runtime Versions", "type": "object" }, "sandbox_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sandbox Id" }, "session_id": { "title": "Session Id", "type": "string" }, "session_kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Session Kind" }, "slash_command_details": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Slash Command Details" }, "slash_commands": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Slash Commands" }, "source_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Type" }, "startup_progress": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Startup Progress" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State" }, "template_mcp_config": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Template Mcp Config" }, "template_mcp_servers": { "items": { "type": "string" }, "title": "Template Mcp Servers", "type": "array" }, "template_skills": { "items": {}, "title": "Template Skills", "type": "array" }, "terminal_cwd": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Terminal Cwd" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id" }, "workspace_panels": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" } ], "title": "Workspace Panels" } }, "required": [ "session_id", "conversation_state", "has_local_runtime", "runtime_versions", "template_skills", "template_mcp_servers", "template_mcp_config", "mcp_connections" ], "title": "AdminSessionDetail", "type": "object" }, "AdminSessionFeedHealth": { "description": "The core notification task's lifecycle, with exception values excluded.", "properties": { "last_error": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Last Error" }, "last_notice_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Notice At" }, "last_notice_seq": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Last Notice Seq" }, "ready": { "title": "Ready", "type": "boolean" }, "started": { "title": "Started", "type": "boolean" }, "task_state": { "title": "Task State", "type": "string" } }, "required": [ "started", "ready", "task_state", "last_error", "last_notice_at", "last_notice_seq" ], "title": "AdminSessionFeedHealth", "type": "object" }, "AdminSessionPage": { "additionalProperties": true, "description": "One page of the sessions the caller administers.", "properties": { "items": { "items": { "additionalProperties": true, "type": "object" }, "title": "Items", "type": "array" }, "pagination": { "$ref": "#/components/schemas/AdminSessionPagination" } }, "required": [ "items", "pagination" ], "title": "AdminSessionPage", "type": "object" }, "AdminSessionPagination": { "additionalProperties": true, "description": "Paging counters for a session listing, counted at the source.", "properties": { "page": { "title": "Page", "type": "integer" }, "page_size": { "title": "Page Size", "type": "integer" }, "total_items": { "title": "Total Items", "type": "integer" }, "total_pages": { "title": "Total Pages", "type": "integer" } }, "required": [ "page", "page_size", "total_items", "total_pages" ], "title": "AdminSessionPagination", "type": "object" }, "AdminSessionTrace": { "additionalProperties": true, "description": "A session's latest messages beside one response's browser parts.\n\n``current_response_ids`` are the responses still running.\n``message_limit`` and ``part_limit`` are the clamped limits that produced\nthis answer; ``truncated_part_count`` is how many earlier parts of the\nselected response the limit left out.", "properties": { "current_response_ids": { "items": { "type": "string" }, "title": "Current Response Ids", "type": "array" }, "message_limit": { "title": "Message Limit", "type": "integer" }, "messages": { "items": { "additionalProperties": true, "type": "object" }, "title": "Messages", "type": "array" }, "part_limit": { "title": "Part Limit", "type": "integer" }, "parts": { "items": { "additionalProperties": true, "type": "object" }, "title": "Parts", "type": "array" }, "responses": { "items": { "additionalProperties": true, "type": "object" }, "title": "Responses", "type": "array" }, "selected_response_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Selected Response Id" }, "session_id": { "title": "Session Id", "type": "string" }, "state": { "title": "State", "type": "string" }, "truncated_part_count": { "title": "Truncated Part Count", "type": "integer" } }, "required": [ "session_id", "state", "current_response_ids", "selected_response_id", "message_limit", "part_limit", "messages", "responses", "parts", "truncated_part_count" ], "title": "AdminSessionTrace", "type": "object" }, "AdminSystemOverview": { "additionalProperties": true, "description": "Process facts plus the session distribution, counted at the source.\n\n``session_state_counts`` and ``total_sessions`` are scoped to the sessions\nthe caller administers, so they move with who is asking.", "properties": { "active_runtimes": { "title": "Active Runtimes", "type": "integer" }, "machine_id": { "title": "Machine Id", "type": "string" }, "mcp_proxy_base_url": { "title": "Mcp Proxy Base Url", "type": "string" }, "persistence_backend": { "title": "Persistence Backend", "type": "string" }, "process_health": { "$ref": "#/components/schemas/AdminOverviewProcessHealth" }, "runtime_session_ids": { "items": { "type": "string" }, "title": "Runtime Session Ids", "type": "array" }, "server_env": { "title": "Server Env", "type": "string" }, "session_state_counts": { "additionalProperties": { "type": "integer" }, "title": "Session State Counts", "type": "object" }, "total_sessions": { "title": "Total Sessions", "type": "integer" } }, "required": [ "machine_id", "server_env", "persistence_backend", "active_runtimes", "mcp_proxy_base_url", "runtime_session_ids", "process_health", "session_state_counts", "total_sessions" ], "title": "AdminSystemOverview", "type": "object" }, "AdminThread": { "additionalProperties": true, "properties": { "alive": { "title": "Alive", "type": "boolean" }, "daemon": { "title": "Daemon", "type": "boolean" }, "ident": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ident" }, "name": { "title": "Name", "type": "string" }, "native_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Native Id" } }, "required": [ "name", "daemon", "alive", "ident", "native_id" ], "title": "AdminThread", "type": "object" }, "AdminThreads": { "additionalProperties": true, "description": "Thread totals, and the first 200 threads themselves.", "properties": { "count": { "title": "Count", "type": "integer" }, "items": { "items": { "$ref": "#/components/schemas/AdminThread" }, "title": "Items", "type": "array" }, "non_daemon_count": { "title": "Non Daemon Count", "type": "integer" } }, "required": [ "count", "non_daemon_count", "items" ], "title": "AdminThreads", "type": "object" }, "AdoptedConnector": { "description": "An app just connected, and the caller's Assistants it was turned on in.", "properties": { "assistant_ids": { "items": { "type": "string" }, "title": "Assistant Ids", "type": "array" }, "connector_id": { "title": "Connector Id", "type": "string" } }, "required": [ "connector_id", "assistant_ids" ], "title": "AdoptedConnector", "type": "object" }, "AgentAccess": { "additionalProperties": true, "description": "The Agent authorization settings returned by ``_agent_access_view``.\n\n``created_by`` is stamped on insert and is absent from documents seeded\nwithout an owner, so it is the one optional member of the response.", "properties": { "admins": { "items": { "type": "string" }, "title": "Admins", "type": "array" }, "allowed_user_ids": { "items": { "type": "string" }, "title": "Allowed User Ids", "type": "array" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "visibility": { "enum": [ "public", "private", "allowlist" ], "title": "Visibility", "type": "string" } }, "required": [ "visibility", "admins", "allowed_user_ids" ], "title": "AgentAccess", "type": "object" }, "AgentCategory": { "description": "One Agent category, in the administrator's order (``position``, from 0).", "properties": { "category_id": { "title": "Category Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "position": { "title": "Position", "type": "integer" } }, "required": [ "category_id", "name", "position" ], "title": "AgentCategory", "type": "object" }, "AgentCategoryName": { "additionalProperties": false, "properties": { "name": { "minLength": 1, "title": "Name", "type": "string" } }, "required": [ "name" ], "title": "AgentCategoryName", "type": "object" }, "AgentCategoryOrder": { "additionalProperties": false, "properties": { "category_ids": { "items": { "type": "string" }, "title": "Category Ids", "type": "array" } }, "required": [ "category_ids" ], "title": "AgentCategoryOrder", "type": "object" }, "AgentConnectorState": { "properties": { "agent_id": { "title": "Agent Id", "type": "string" }, "enabled": { "items": { "type": "string" }, "title": "Enabled", "type": "array" } }, "required": [ "agent_id", "enabled" ], "title": "AgentConnectorState", "type": "object" }, "AgentExtensionCatalog": { "additionalProperties": true, "description": "The provider's catalog with this Agent's selection marked.\n\nThe selected ids are read back from the stored assignments rather than from\nthe request, so what the form shows ticked is what Session start resolves.", "properties": { "agent_id": { "title": "Agent Id", "type": "string" }, "mcp_servers": { "items": { "$ref": "#/components/schemas/AgentExtensionItem" }, "title": "Mcp Servers", "type": "array" }, "selected_mcp_server_ids": { "items": { "type": "string" }, "title": "Selected Mcp Server Ids", "type": "array" }, "selected_skill_ids": { "items": { "type": "string" }, "title": "Selected Skill Ids", "type": "array" }, "skills": { "items": { "$ref": "#/components/schemas/AgentExtensionItem" }, "title": "Skills", "type": "array" } }, "required": [ "agent_id", "mcp_servers", "skills", "selected_mcp_server_ids", "selected_skill_ids" ], "title": "AgentExtensionCatalog", "type": "object" }, "AgentExtensionItem": { "additionalProperties": true, "description": "One selectable catalog entry, as ``ExtensionCatalogItem.public_view``\nexposes it. MCP servers and Skills share this shape; ``transport`` is set\non the entries whose provider declares one.", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "transport": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Transport" } }, "required": [ "id", "name" ], "title": "AgentExtensionItem", "type": "object" }, "AgentFavorite": { "properties": { "agent_id": { "title": "Agent Id", "type": "string" }, "favorited": { "title": "Favorited", "type": "boolean" } }, "required": [ "agent_id", "favorited" ], "title": "AgentFavorite", "type": "object" }, "AgentFormField": { "additionalProperties": true, "description": "One field of the Agent authoring form, as ``agent_schema`` declares it.\n\n``key`` and ``type`` are the two members every entry carries; the optional\npresentation and validation members (``group``, ``required``, ``enum``,\n``path``, ``complex``, ``advanced``) appear per field. ``item_schema``\ndescribes the sub-fields of a nested object with this same grammar.\n``default`` is the value an Agent created without the field has. Two\nfields carry one: ``prepared_capacity``, whose value follows the\ndeployment, and ``artifacts_enabled``, which is on.", "properties": { "advanced": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Advanced" }, "complex": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Complex" }, "default": { "title": "Default" }, "enum": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Enum" }, "group": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Group" }, "item_schema": { "anyOf": [ { "items": { "$ref": "#/components/schemas/AgentFormField" }, "type": "array" }, { "type": "null" } ], "title": "Item Schema" }, "key": { "title": "Key", "type": "string" }, "path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Path" }, "required": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Required" }, "type": { "title": "Type", "type": "string" } }, "required": [ "key", "type" ], "title": "AgentFormField", "type": "object" }, "AgentFormGroup": { "additionalProperties": true, "description": "One form section. ``id`` is the contract; the label is frontend i18n.", "properties": { "id": { "title": "Id", "type": "string" } }, "required": [ "id" ], "title": "AgentFormGroup", "type": "object" }, "AgentFormSchema": { "additionalProperties": true, "description": "The editable shape of an Agent, as the console's form editor reads it.", "properties": { "fields": { "items": { "$ref": "#/components/schemas/AgentFormField" }, "title": "Fields", "type": "array" }, "groups": { "items": { "$ref": "#/components/schemas/AgentFormGroup" }, "title": "Groups", "type": "array" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "version", "groups", "fields" ], "title": "AgentFormSchema", "type": "object" }, "AgentListPage": { "additionalProperties": false, "description": "One page of the Agents the caller may see, by name regardless of case.\n\n``next_cursor`` is the value to pass back as ``cursor``; it is ``null`` on\nthe last page, which ``has_more`` reports independently. ``total`` and\n``enabled`` count every Agent the caller may see, whatever ``q`` and\n``status`` narrowed, and come with the first page only.", "properties": { "agents": { "items": { "$ref": "#/components/schemas/AgentRecord" }, "title": "Agents", "type": "array" }, "enabled": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Enabled" }, "has_more": { "title": "Has More", "type": "boolean" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total" } }, "required": [ "agents", "has_more" ], "title": "AgentListPage", "type": "object" }, "AgentMCPServerAssignment": { "additionalProperties": true, "description": "The built-in-catalog MCP servers selected for one Agent.\n\n``missing_mcp_server_ids`` names assignments whose server is gone, so the\nconsole can show the gap rather than a silently shorter list.", "properties": { "agent_id": { "title": "Agent Id", "type": "string" }, "mcp_server_ids": { "items": { "type": "string" }, "title": "Mcp Server Ids", "type": "array" }, "mcp_servers": { "items": { "$ref": "#/components/schemas/MCPServer" }, "title": "Mcp Servers", "type": "array" }, "missing_mcp_server_ids": { "items": { "type": "string" }, "title": "Missing Mcp Server Ids", "type": "array" } }, "required": [ "agent_id", "mcp_server_ids", "mcp_servers", "missing_mcp_server_ids" ], "title": "AgentMCPServerAssignment", "type": "object" }, "AgentPreparedRuntimeStatus": { "additionalProperties": false, "description": "Platform-owned capacity waiting for this Agent's next conversation.", "properties": { "client_pool_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Pool Name" }, "configured_target": { "title": "Configured Target", "type": "integer" }, "enabled": { "title": "Enabled", "type": "boolean" }, "environment_name": { "title": "Environment Name", "type": "string" }, "last_error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Error" }, "last_miss_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Miss At" }, "placement": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Placement" }, "prepared_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prepared At" }, "prepared_count": { "title": "Prepared Count", "type": "integer" }, "prewarm_enabled": { "title": "Prewarm Enabled", "type": "boolean" }, "ready": { "title": "Ready", "type": "boolean" }, "runtime_generation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Runtime Generation" }, "sandbox_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sandbox Id" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State" }, "target": { "title": "Target", "type": "integer" } }, "required": [ "enabled", "environment_name", "prewarm_enabled", "configured_target", "target", "ready", "prepared_count" ], "title": "AgentPreparedRuntimeStatus", "type": "object" }, "AgentRecord": { "additionalProperties": true, "description": "One stored Agent as these routes project it.\n\nThe Agent document is open — ``AgentService._sanitize`` passes through\nevery key that is not internal — so the fields named here are the ones the\nconsole addresses by name, and ``extra=\"allow\"`` carries the rest. Their\ntypes are the ones ``agent_schema.AGENT_FIELD_SCHEMA`` enforces on write,\nplus the identity and ownership fields ``AgentConfigService`` stamps.\n``artifacts_enabled`` is always present because a read reports the switch\nas it takes effect, including for an Agent stored without it.\n\n``can_manage`` is computed per viewer and therefore present only on the\nreads that compute it (list and get), not on a write's echo of the record;\n``favorited`` and ``can_start_conversation`` are present on the full list.\nThe latter reports configured admission eligibility, not runtime health.", "properties": { "admins": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Admins" }, "agent_id": { "title": "Agent Id", "type": "string" }, "allowed_user_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Allowed User Ids" }, "artifacts_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Artifacts Enabled" }, "can_manage": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Can Manage" }, "can_start_conversation": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Can Start Conversation" }, "categories": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Categories" }, "claude_options": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Claude Options" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "default_repo": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Default Repo" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "display_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Display Meta" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" }, "exposure_mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exposure Mode" }, "extension_catalog": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Extension Catalog" }, "favorited": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Favorited" }, "idle_hibernate_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Idle Hibernate Seconds" }, "mcp_assignments": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Mcp Assignments" }, "mcp_servers": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Mcp Servers" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "packages": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Packages" }, "prepared_capacity": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Prepared Capacity" }, "runtime_profile_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Runtime Profile Name" }, "skills": { "anyOf": [ { "items": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ] }, "type": "array" }, { "type": "null" } ], "title": "Skills" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State" }, "system": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "System" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "use_cases": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Use Cases" }, "version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Version" }, "visibility": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Visibility" } }, "required": [ "agent_id" ], "title": "AgentRecord", "type": "object" }, "AgentRuntimeProfileModels": { "additionalProperties": true, "description": "The model ids a RuntimeProfile's gateway offers. Empty when it offers none.", "properties": { "models": { "items": { "type": "string" }, "title": "Models", "type": "array" } }, "required": [ "models" ], "title": "AgentRuntimeProfileModels", "type": "object" }, "AgentRuntimeProfileOption": { "additionalProperties": true, "description": "One RuntimeProfile an Agent author may choose, without its secrets.", "properties": { "display_name": { "title": "Display Name", "type": "string" }, "enabled": { "title": "Enabled", "type": "boolean" }, "engine_kind": { "title": "Engine Kind", "type": "string" }, "engine_options_schema": { "default": [], "items": { "additionalProperties": true, "type": "object" }, "title": "Engine Options Schema", "type": "array" }, "extensions": { "additionalProperties": true, "default": {}, "title": "Extensions", "type": "object" }, "name": { "title": "Name", "type": "string" } }, "required": [ "name", "display_name", "engine_kind", "enabled" ], "title": "AgentRuntimeProfileOption", "type": "object" }, "AgentTag": { "properties": { "agents": { "title": "Agents", "type": "integer" }, "tag": { "title": "Tag", "type": "string" } }, "required": [ "tag", "agents" ], "title": "AgentTag", "type": "object" }, "ApiEnvelope_AdminApiWorkspaceResult_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AdminApiWorkspaceResult" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AdminApiWorkspaceResult]", "type": "object" }, "ApiEnvelope_AdminDeletedRuntimeProfile_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AdminDeletedRuntimeProfile" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AdminDeletedRuntimeProfile]", "type": "object" }, "ApiEnvelope_AdminEnvironment_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AdminEnvironment" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AdminEnvironment]", "type": "object" }, "ApiEnvelope_AdminErrorsPage_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AdminErrorsPage" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AdminErrorsPage]", "type": "object" }, "ApiEnvelope_AdminEvictResult_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AdminEvictResult" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AdminEvictResult]", "type": "object" }, "ApiEnvelope_AdminFormSchema_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AdminFormSchema" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AdminFormSchema]", "type": "object" }, "ApiEnvelope_AdminHistoryImportResult_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AdminHistoryImportResult" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AdminHistoryImportResult]", "type": "object" }, "ApiEnvelope_AdminKillResult_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AdminKillResult" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AdminKillResult]", "type": "object" }, "ApiEnvelope_AdminLogsPage_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AdminLogsPage" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AdminLogsPage]", "type": "object" }, "ApiEnvelope_AdminNavigationSummary_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AdminNavigationSummary" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AdminNavigationSummary]", "type": "object" }, "ApiEnvelope_AdminProcessHealth_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AdminProcessHealth" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AdminProcessHealth]", "type": "object" }, "ApiEnvelope_AdminRuntimeProfileModels_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AdminRuntimeProfileModels" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AdminRuntimeProfileModels]", "type": "object" }, "ApiEnvelope_AdminSandboxDiagnostics_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AdminSandboxDiagnostics" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AdminSandboxDiagnostics]", "type": "object" }, "ApiEnvelope_AdminSandboxIdleAction_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AdminSandboxIdleAction" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AdminSandboxIdleAction]", "type": "object" }, "ApiEnvelope_AdminSandboxIdleSweep_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AdminSandboxIdleSweep" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AdminSandboxIdleSweep]", "type": "object" }, "ApiEnvelope_AdminSandboxPage_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AdminSandboxPage" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AdminSandboxPage]", "type": "object" }, "ApiEnvelope_AdminSandboxQuota_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AdminSandboxQuota" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AdminSandboxQuota]", "type": "object" }, "ApiEnvelope_AdminSandboxSecurity_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AdminSandboxSecurity" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AdminSandboxSecurity]", "type": "object" }, "ApiEnvelope_AdminSandboxSummary_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AdminSandboxSummary" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AdminSandboxSummary]", "type": "object" }, "ApiEnvelope_AdminSessionDetail_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AdminSessionDetail" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AdminSessionDetail]", "type": "object" }, "ApiEnvelope_AdminSessionPage_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AdminSessionPage" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AdminSessionPage]", "type": "object" }, "ApiEnvelope_AdminSessionTrace_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AdminSessionTrace" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AdminSessionTrace]", "type": "object" }, "ApiEnvelope_AdminSystemOverview_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AdminSystemOverview" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AdminSystemOverview]", "type": "object" }, "ApiEnvelope_AdoptedConnector_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AdoptedConnector" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AdoptedConnector]", "type": "object" }, "ApiEnvelope_AgentAccess_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AgentAccess" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AgentAccess]", "type": "object" }, "ApiEnvelope_AgentCategory_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AgentCategory" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AgentCategory]", "type": "object" }, "ApiEnvelope_AgentConnectorState_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AgentConnectorState" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AgentConnectorState]", "type": "object" }, "ApiEnvelope_AgentExtensionCatalog_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AgentExtensionCatalog" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AgentExtensionCatalog]", "type": "object" }, "ApiEnvelope_AgentFavorite_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AgentFavorite" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AgentFavorite]", "type": "object" }, "ApiEnvelope_AgentFormSchema_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AgentFormSchema" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AgentFormSchema]", "type": "object" }, "ApiEnvelope_AgentListPage_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AgentListPage" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AgentListPage]", "type": "object" }, "ApiEnvelope_AgentMCPServerAssignment_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AgentMCPServerAssignment" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AgentMCPServerAssignment]", "type": "object" }, "ApiEnvelope_AgentPreparedRuntimeStatus_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AgentPreparedRuntimeStatus" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AgentPreparedRuntimeStatus]", "type": "object" }, "ApiEnvelope_AgentRecord_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AgentRecord" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AgentRecord]", "type": "object" }, "ApiEnvelope_AgentRuntimeProfileModels_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AgentRuntimeProfileModels" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AgentRuntimeProfileModels]", "type": "object" }, "ApiEnvelope_ArtifactAgentRun_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/ArtifactAgentRun" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[ArtifactAgentRun]", "type": "object" }, "ApiEnvelope_ArtifactAgentStatus_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/ArtifactAgentStatus" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[ArtifactAgentStatus]", "type": "object" }, "ApiEnvelope_ArtifactDetail_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/ArtifactDetail" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[ArtifactDetail]", "type": "object" }, "ApiEnvelope_ArtifactPage_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/ArtifactPage" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[ArtifactPage]", "type": "object" }, "ApiEnvelope_ArtifactRecord_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/ArtifactRecord" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[ArtifactRecord]", "type": "object" }, "ApiEnvelope_ArtifactRuntime_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/ArtifactRuntime" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[ArtifactRuntime]", "type": "object" }, "ApiEnvelope_ArtifactShare_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/ArtifactShare" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[ArtifactShare]", "type": "object" }, "ApiEnvelope_AssistantConnectorState_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AssistantConnectorState" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AssistantConnectorState]", "type": "object" }, "ApiEnvelope_AssistantDefaultsExtensionCatalog_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AssistantDefaultsExtensionCatalog" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AssistantDefaultsExtensionCatalog]", "type": "object" }, "ApiEnvelope_AssistantDefaults_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AssistantDefaults" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AssistantDefaults]", "type": "object" }, "ApiEnvelope_AssistantDeletion_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AssistantDeletion" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AssistantDeletion]", "type": "object" }, "ApiEnvelope_AssistantExtensionCatalog_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AssistantExtensionCatalog" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AssistantExtensionCatalog]", "type": "object" }, "ApiEnvelope_AssistantListPage_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AssistantListPage" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AssistantListPage]", "type": "object" }, "ApiEnvelope_AssistantWorkspaceDestruction_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AssistantWorkspaceDestruction" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AssistantWorkspaceDestruction]", "type": "object" }, "ApiEnvelope_AssistantWorkspaceHibernation_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AssistantWorkspaceHibernation" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AssistantWorkspaceHibernation]", "type": "object" }, "ApiEnvelope_AssistantWorkspace_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AssistantWorkspace" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AssistantWorkspace]", "type": "object" }, "ApiEnvelope_Assistant_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/Assistant" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[Assistant]", "type": "object" }, "ApiEnvelope_AuthorizeResponse_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/AuthorizeResponse" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[AuthorizeResponse]", "type": "object" }, "ApiEnvelope_ChannelAccountLinkRecord_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/ChannelAccountLinkRecord" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[ChannelAccountLinkRecord]", "type": "object" }, "ApiEnvelope_ChildRunMessagePage_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/ChildRunMessagePage" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[ChildRunMessagePage]", "type": "object" }, "ApiEnvelope_ChildRunStopResult_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/ChildRunStopResult" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[ChildRunStopResult]", "type": "object" }, "ApiEnvelope_Connector_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/Connector" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[Connector]", "type": "object" }, "ApiEnvelope_ConversationEndResult_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/ConversationEndResult" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[ConversationEndResult]", "type": "object" }, "ApiEnvelope_CredentialBinding_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/CredentialBinding" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[CredentialBinding]", "type": "object" }, "ApiEnvelope_CurrentEnvironment_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/CurrentEnvironment" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[CurrentEnvironment]", "type": "object" }, "ApiEnvelope_CurrentUser_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/CurrentUser" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[CurrentUser]", "type": "object" }, "ApiEnvelope_DeletedAgentCategory_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/DeletedAgentCategory" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[DeletedAgentCategory]", "type": "object" }, "ApiEnvelope_DeletedChannelAccountLink_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/DeletedChannelAccountLink" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[DeletedChannelAccountLink]", "type": "object" }, "ApiEnvelope_DeletedDeployment_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/DeletedDeployment" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[DeletedDeployment]", "type": "object" }, "ApiEnvelope_DeploymentExtensionProvider_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/DeploymentExtensionProvider" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[DeploymentExtensionProvider]", "type": "object" }, "ApiEnvelope_DeploymentRecord_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/DeploymentRecord" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[DeploymentRecord]", "type": "object" }, "ApiEnvelope_DeploymentRun_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/DeploymentRun" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[DeploymentRun]", "type": "object" }, "ApiEnvelope_DeploymentTriggerAck_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/DeploymentTriggerAck" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[DeploymentTriggerAck]", "type": "object" }, "ApiEnvelope_ExposedPortUrl_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/ExposedPortUrl" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[ExposedPortUrl]", "type": "object" }, "ApiEnvelope_ExtensionConsoleSession_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/ExtensionConsoleSession" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[ExtensionConsoleSession]", "type": "object" }, "ApiEnvelope_InputReceipt_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/InputReceipt" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[InputReceipt]", "type": "object" }, "ApiEnvelope_InteractionAnswerReceipt_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/InteractionAnswerReceipt" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[InteractionAnswerReceipt]", "type": "object" }, "ApiEnvelope_InterruptReceipt_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/InterruptReceipt" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[InterruptReceipt]", "type": "object" }, "ApiEnvelope_IssuedMCPClientToken_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/IssuedMCPClientToken" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[IssuedMCPClientToken]", "type": "object" }, "ApiEnvelope_MCPClientTokenList_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/MCPClientTokenList" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[MCPClientTokenList]", "type": "object" }, "ApiEnvelope_MCPServerList_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/MCPServerList" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[MCPServerList]", "type": "object" }, "ApiEnvelope_MCPServer_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/MCPServer" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[MCPServer]", "type": "object" }, "ApiEnvelope_PermissionModeUpdate_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/PermissionModeUpdate" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[PermissionModeUpdate]", "type": "object" }, "ApiEnvelope_ProcessSummaryState_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/ProcessSummaryState" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[ProcessSummaryState]", "type": "object" }, "ApiEnvelope_RuntimeStateLoadResult_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/RuntimeStateLoadResult" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[RuntimeStateLoadResult]", "type": "object" }, "ApiEnvelope_RuntimeStateSaveResult_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/RuntimeStateSaveResult" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[RuntimeStateSaveResult]", "type": "object" }, "ApiEnvelope_SandboxCallbackResult_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/SandboxCallbackResult" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[SandboxCallbackResult]", "type": "object" }, "ApiEnvelope_SandboxTerminatingResult_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/SandboxTerminatingResult" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[SandboxTerminatingResult]", "type": "object" }, "ApiEnvelope_SandboxTermination_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/SandboxTermination" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[SandboxTermination]", "type": "object" }, "ApiEnvelope_SessionArchival_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/SessionArchival" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[SessionArchival]", "type": "object" }, "ApiEnvelope_SessionBrowserAccess_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/SessionBrowserAccess" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[SessionBrowserAccess]", "type": "object" }, "ApiEnvelope_SessionChildRunPage_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/SessionChildRunPage" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[SessionChildRunPage]", "type": "object" }, "ApiEnvelope_SessionDeletion_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/SessionDeletion" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[SessionDeletion]", "type": "object" }, "ApiEnvelope_SessionDirectoryCreated_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/SessionDirectoryCreated" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[SessionDirectoryCreated]", "type": "object" }, "ApiEnvelope_SessionFileChanges_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/SessionFileChanges" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[SessionFileChanges]", "type": "object" }, "ApiEnvelope_SessionFileListing_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/SessionFileListing" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[SessionFileListing]", "type": "object" }, "ApiEnvelope_SessionFileMoved_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/SessionFileMoved" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[SessionFileMoved]", "type": "object" }, "ApiEnvelope_SessionFilePreview_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/SessionFilePreview" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[SessionFilePreview]", "type": "object" }, "ApiEnvelope_SessionFileUploadResult_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/SessionFileUploadResult" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[SessionFileUploadResult]", "type": "object" }, "ApiEnvelope_SessionFilesDeleted_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/SessionFilesDeleted" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[SessionFilesDeleted]", "type": "object" }, "ApiEnvelope_SessionHistoryBlockDetails_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/SessionHistoryBlockDetails" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[SessionHistoryBlockDetails]", "type": "object" }, "ApiEnvelope_SessionHistoryBlockPage_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/SessionHistoryBlockPage" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[SessionHistoryBlockPage]", "type": "object" }, "ApiEnvelope_SessionListPage_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/SessionListPage" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[SessionListPage]", "type": "object" }, "ApiEnvelope_SessionMessagePage_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/SessionMessagePage" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[SessionMessagePage]", "type": "object" }, "ApiEnvelope_SessionRead_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/SessionRead" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[SessionRead]", "type": "object" }, "ApiEnvelope_SessionRecord_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/SessionRecord" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[SessionRecord]", "type": "object" }, "ApiEnvelope_SessionTitle_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/SessionTitle" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[SessionTitle]", "type": "object" }, "ApiEnvelope_SessionUserActionView_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/SessionUserActionView" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[SessionUserActionView]", "type": "object" }, "ApiEnvelope_ShareLink_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/ShareLink" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[ShareLink]", "type": "object" }, "ApiEnvelope_ShareRevoked_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/ShareRevoked" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[ShareRevoked]", "type": "object" }, "ApiEnvelope_SharedMessagePage_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/SharedMessagePage" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[SharedMessagePage]", "type": "object" }, "ApiEnvelope_SharedSession_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/SharedSession" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[SharedSession]", "type": "object" }, "ApiEnvelope_SpeechInputOptions_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/SpeechInputOptions" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[SpeechInputOptions]", "type": "object" }, "ApiEnvelope_SpeechInputTranscript_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/SpeechInputTranscript" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[SpeechInputTranscript]", "type": "object" }, "ApiEnvelope_StartedAgentConversation_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/StartedAgentConversation" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[StartedAgentConversation]", "type": "object" }, "ApiEnvelope_StartedAssistantConversation_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/StartedAssistantConversation" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[StartedAssistantConversation]", "type": "object" }, "ApiEnvelope_TerminalInterruptResult_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/TerminalInterruptResult" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[TerminalInterruptResult]", "type": "object" }, "ApiEnvelope_TranscriptAppendResult_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/TranscriptAppendResult" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[TranscriptAppendResult]", "type": "object" }, "ApiEnvelope_TranscriptLoadResult_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/TranscriptLoadResult" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[TranscriptLoadResult]", "type": "object" }, "ApiEnvelope_TranscriptSessionList_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/TranscriptSessionList" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[TranscriptSessionList]", "type": "object" }, "ApiEnvelope_TranscriptSubkeyList_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/TranscriptSubkeyList" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[TranscriptSubkeyList]", "type": "object" }, "ApiEnvelope_VaultCatalog_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/VaultCatalog" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[VaultCatalog]", "type": "object" }, "ApiEnvelope_VaultCredentialList_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/VaultCredentialList" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[VaultCredentialList]", "type": "object" }, "ApiEnvelope_VaultCredential_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/VaultCredential" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[VaultCredential]", "type": "object" }, "ApiEnvelope_Vault_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/Vault" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[Vault]", "type": "object" }, "ApiEnvelope_WebshellAccess_": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "$ref": "#/components/schemas/WebshellAccess" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[WebshellAccess]", "type": "object" }, "ApiEnvelope_dict_str__Any__": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "additionalProperties": true, "title": "Data", "type": "object" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[dict[str, Any]]", "type": "object" }, "ApiEnvelope_dict_str__bool__": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "additionalProperties": { "type": "boolean" }, "title": "Data", "type": "object" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[dict[str, bool]]", "type": "object" }, "ApiEnvelope_list_AdminAgentCategory__": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "items": { "$ref": "#/components/schemas/AdminAgentCategory" }, "title": "Data", "type": "array" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[list[AdminAgentCategory]]", "type": "object" }, "ApiEnvelope_list_AdminEnvironment__": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "items": { "$ref": "#/components/schemas/AdminEnvironment" }, "title": "Data", "type": "array" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[list[AdminEnvironment]]", "type": "object" }, "ApiEnvelope_list_AgentCategory__": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "items": { "$ref": "#/components/schemas/AgentCategory" }, "title": "Data", "type": "array" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[list[AgentCategory]]", "type": "object" }, "ApiEnvelope_list_AgentRecord__": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "items": { "$ref": "#/components/schemas/AgentRecord" }, "title": "Data", "type": "array" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[list[AgentRecord]]", "type": "object" }, "ApiEnvelope_list_AgentRuntimeProfileOption__": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "items": { "$ref": "#/components/schemas/AgentRuntimeProfileOption" }, "title": "Data", "type": "array" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[list[AgentRuntimeProfileOption]]", "type": "object" }, "ApiEnvelope_list_AgentTag__": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "items": { "$ref": "#/components/schemas/AgentTag" }, "title": "Data", "type": "array" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[list[AgentTag]]", "type": "object" }, "ApiEnvelope_list_ArtifactVersionRecord__": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "items": { "$ref": "#/components/schemas/ArtifactVersionRecord" }, "title": "Data", "type": "array" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[list[ArtifactVersionRecord]]", "type": "object" }, "ApiEnvelope_list_Assistant__": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "items": { "$ref": "#/components/schemas/Assistant" }, "title": "Data", "type": "array" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[list[Assistant]]", "type": "object" }, "ApiEnvelope_list_ChannelAccountLinkRecord__": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "items": { "$ref": "#/components/schemas/ChannelAccountLinkRecord" }, "title": "Data", "type": "array" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[list[ChannelAccountLinkRecord]]", "type": "object" }, "ApiEnvelope_list_ChannelProviderRecord__": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "items": { "$ref": "#/components/schemas/ChannelProviderRecord" }, "title": "Data", "type": "array" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[list[ChannelProviderRecord]]", "type": "object" }, "ApiEnvelope_list_Connector__": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "items": { "$ref": "#/components/schemas/Connector" }, "title": "Data", "type": "array" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[list[Connector]]", "type": "object" }, "ApiEnvelope_list_DeploymentRecord__": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "items": { "$ref": "#/components/schemas/DeploymentRecord" }, "title": "Data", "type": "array" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[list[DeploymentRecord]]", "type": "object" }, "ApiEnvelope_list_DeploymentRun__": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "items": { "$ref": "#/components/schemas/DeploymentRun" }, "title": "Data", "type": "array" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[list[DeploymentRun]]", "type": "object" }, "ApiEnvelope_list_EnvironmentView__": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "items": { "$ref": "#/components/schemas/EnvironmentView" }, "title": "Data", "type": "array" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[list[EnvironmentView]]", "type": "object" }, "ApiEnvelope_list_SessionRecord__": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "items": { "$ref": "#/components/schemas/SessionRecord" }, "title": "Data", "type": "array" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[list[SessionRecord]]", "type": "object" }, "ApiEnvelope_list_VaultBindingHolder__": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "items": { "$ref": "#/components/schemas/VaultBindingHolder" }, "title": "Data", "type": "array" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[list[VaultBindingHolder]]", "type": "object" }, "ApiEnvelope_list_dict_str__Any___": { "properties": { "code": { "title": "Code", "type": "string" }, "data": { "items": { "additionalProperties": true, "type": "object" }, "title": "Data", "type": "array" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data" ], "title": "ApiEnvelope[list[dict[str, Any]]]", "type": "object" }, "ArtifactAddRequest": { "additionalProperties": false, "properties": { "collection": { "title": "Collection", "type": "string" }, "data": { "additionalProperties": true, "title": "Data", "type": "object" } }, "required": [ "data", "collection" ], "title": "ArtifactAddRequest", "type": "object" }, "ArtifactAgentRun": { "properties": { "run_id": { "title": "Run Id", "type": "string" }, "session_id": { "title": "Session Id", "type": "string" }, "url": { "title": "Url", "type": "string" } }, "required": [ "run_id", "session_id", "url" ], "title": "ArtifactAgentRun", "type": "object" }, "ArtifactAgentRunRequest": { "additionalProperties": false, "properties": { "prompt": { "minLength": 1, "title": "Prompt", "type": "string" } }, "required": [ "prompt" ], "title": "ArtifactAgentRunRequest", "type": "object" }, "ArtifactAgentStatus": { "properties": { "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "session_id": { "title": "Session Id", "type": "string" }, "state": { "enum": [ "running", "waiting_input", "completed", "failed" ], "title": "State", "type": "string" } }, "required": [ "state", "session_id" ], "title": "ArtifactAgentStatus", "type": "object" }, "ArtifactDataRequest": { "additionalProperties": false, "properties": { "data": { "additionalProperties": true, "title": "Data", "type": "object" } }, "required": [ "data" ], "title": "ArtifactDataRequest", "type": "object" }, "ArtifactDetail": { "additionalProperties": true, "properties": { "artifact_id": { "title": "Artifact Id", "type": "string" }, "astrabox_artifact": { "additionalProperties": true, "title": "Astrabox Artifact", "type": "object" }, "content": { "title": "Content", "type": "string" }, "created_at": { "title": "Created At", "type": "string" }, "current_version": { "title": "Current Version", "type": "integer" }, "description": { "title": "Description", "type": "string" }, "kind": { "enum": [ "html", "react", "svg", "markdown", "mermaid", "code" ], "title": "Kind", "type": "string" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" }, "manifest": { "additionalProperties": true, "title": "Manifest", "type": "object" }, "origin": { "additionalProperties": true, "title": "Origin", "type": "object" }, "share": { "$ref": "#/components/schemas/ArtifactShare" }, "title": { "title": "Title", "type": "string" }, "updated_at": { "title": "Updated At", "type": "string" }, "url": { "title": "Url", "type": "string" }, "version": { "$ref": "#/components/schemas/ArtifactVersionRecord" } }, "required": [ "artifact_id", "title", "description", "kind", "current_version", "manifest", "origin", "share", "created_at", "updated_at", "version", "content", "astrabox_artifact", "url" ], "title": "ArtifactDetail", "type": "object" }, "ArtifactMetadataPatch": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" } }, "title": "ArtifactMetadataPatch", "type": "object" }, "ArtifactOrder": { "additionalProperties": false, "properties": { "direction": { "default": "asc", "enum": [ "asc", "desc" ], "title": "Direction", "type": "string" }, "field": { "minLength": 1, "title": "Field", "type": "string" } }, "required": [ "field" ], "title": "ArtifactOrder", "type": "object" }, "ArtifactPage": { "properties": { "has_more": { "title": "Has More", "type": "boolean" }, "items": { "items": { "$ref": "#/components/schemas/ArtifactRecord" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "has_more", "next_cursor" ], "title": "ArtifactPage", "type": "object" }, "ArtifactPresenceRequest": { "additionalProperties": false, "properties": { "state": { "title": "State" } }, "required": [ "state" ], "title": "ArtifactPresenceRequest", "type": "object" }, "ArtifactPublishRequest": { "additionalProperties": false, "properties": { "base_version": { "minimum": 1.0, "title": "Base Version", "type": "integer" }, "content": { "title": "Content", "type": "string" } }, "required": [ "content", "base_version" ], "title": "ArtifactPublishRequest", "type": "object" }, "ArtifactQueryRequest": { "additionalProperties": false, "properties": { "collection": { "title": "Collection", "type": "string" }, "limit": { "default": 100, "maximum": 10000.0, "minimum": 1.0, "title": "Limit", "type": "integer" }, "order_by": { "items": { "$ref": "#/components/schemas/ArtifactOrder" }, "title": "Order By", "type": "array" }, "where": { "items": { "$ref": "#/components/schemas/ArtifactWhere" }, "title": "Where", "type": "array" } }, "required": [ "collection" ], "title": "ArtifactQueryRequest", "type": "object" }, "ArtifactRecord": { "additionalProperties": true, "properties": { "artifact_id": { "title": "Artifact Id", "type": "string" }, "created_at": { "title": "Created At", "type": "string" }, "current_version": { "title": "Current Version", "type": "integer" }, "description": { "title": "Description", "type": "string" }, "kind": { "enum": [ "html", "react", "svg", "markdown", "mermaid", "code" ], "title": "Kind", "type": "string" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" }, "manifest": { "additionalProperties": true, "title": "Manifest", "type": "object" }, "origin": { "additionalProperties": true, "title": "Origin", "type": "object" }, "share": { "$ref": "#/components/schemas/ArtifactShare" }, "title": { "title": "Title", "type": "string" }, "updated_at": { "title": "Updated At", "type": "string" } }, "required": [ "artifact_id", "title", "description", "kind", "current_version", "manifest", "origin", "share", "created_at", "updated_at" ], "title": "ArtifactRecord", "type": "object" }, "ArtifactRoomRequest": { "additionalProperties": false, "properties": { "data": { "title": "Data" }, "topic": { "title": "Topic", "type": "string" } }, "required": [ "topic", "data" ], "title": "ArtifactRoomRequest", "type": "object" }, "ArtifactRuntime": { "properties": { "after_seq": { "title": "After Seq", "type": "integer" }, "artifact": { "$ref": "#/components/schemas/ArtifactRuntimeRecord" }, "content": { "title": "Content", "type": "string" }, "manifest": { "additionalProperties": true, "title": "Manifest", "type": "object" }, "pinned": { "title": "Pinned", "type": "boolean" }, "version": { "title": "Version", "type": "integer" }, "viewer": { "additionalProperties": true, "title": "Viewer", "type": "object" } }, "required": [ "artifact", "version", "content", "manifest", "viewer", "pinned", "after_seq" ], "title": "ArtifactRuntime", "type": "object" }, "ArtifactRuntimeRecord": { "properties": { "artifact_id": { "title": "Artifact Id", "type": "string" }, "created_at": { "title": "Created At", "type": "string" }, "current_version": { "title": "Current Version", "type": "integer" }, "description": { "title": "Description", "type": "string" }, "kind": { "enum": [ "html", "react", "svg", "markdown", "mermaid", "code" ], "title": "Kind", "type": "string" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" }, "manifest": { "additionalProperties": true, "title": "Manifest", "type": "object" }, "origin": { "additionalProperties": true, "title": "Origin", "type": "object" }, "share": { "anyOf": [ { "$ref": "#/components/schemas/ArtifactShareView" }, { "type": "null" } ] }, "title": { "title": "Title", "type": "string" }, "updated_at": { "title": "Updated At", "type": "string" } }, "required": [ "artifact_id", "title", "description", "kind", "current_version", "manifest", "origin", "created_at", "updated_at" ], "title": "ArtifactRuntimeRecord", "type": "object" }, "ArtifactSampleMessage": { "additionalProperties": false, "properties": { "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content" }, "role": { "enum": [ "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", "content" ], "title": "ArtifactSampleMessage", "type": "object" }, "ArtifactSampleRequest": { "additionalProperties": false, "properties": { "input": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ArtifactSampleMessage" }, "type": "array" }, { "type": "null" } ], "title": "Input" }, "max_tokens": { "default": 4096, "minimum": 1.0, "title": "Max Tokens", "type": "integer" }, "messages": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ArtifactSampleMessage" }, "type": "array" }, { "type": "null" } ], "title": "Messages" }, "modelTier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Modeltier" }, "tools": { "items": { "$ref": "#/components/schemas/ArtifactSampleTool" }, "title": "Tools", "type": "array" } }, "title": "ArtifactSampleRequest", "type": "object" }, "ArtifactSampleTool": { "additionalProperties": false, "properties": { "description": { "title": "Description", "type": "string" }, "input_schema": { "additionalProperties": true, "title": "Input Schema", "type": "object" }, "name": { "title": "Name", "type": "string" } }, "required": [ "name", "description", "input_schema" ], "title": "ArtifactSampleTool", "type": "object" }, "ArtifactShare": { "properties": { "access": { "enum": [ "view", "interact" ], "title": "Access", "type": "string" }, "audience": { "enum": [ "anyone", "signed_in" ], "title": "Audience", "type": "string" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "enabled": { "title": "Enabled", "type": "boolean" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "token": { "title": "Token", "type": "string" }, "version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Version" } }, "required": [ "enabled", "token", "access", "audience", "version", "created_at", "expires_at" ], "title": "ArtifactShare", "type": "object" }, "ArtifactShareRequest": { "additionalProperties": false, "properties": { "access": { "default": "view", "enum": [ "view", "interact" ], "title": "Access", "type": "string" }, "audience": { "default": "anyone", "enum": [ "anyone", "signed_in" ], "title": "Audience", "type": "string" }, "expires_in_seconds": { "anyOf": [ { "exclusiveMinimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Expires In Seconds" }, "version": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Version" } }, "title": "ArtifactShareRequest", "type": "object" }, "ArtifactShareView": { "properties": { "access": { "enum": [ "view", "interact" ], "title": "Access", "type": "string" }, "audience": { "enum": [ "anyone", "signed_in" ], "title": "Audience", "type": "string" }, "version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Version" } }, "required": [ "version", "access", "audience" ], "title": "ArtifactShareView", "type": "object" }, "ArtifactVersionRecord": { "additionalProperties": true, "description": "One stored version; content is returned only by a detail read.", "properties": { "artifact_id": { "title": "Artifact Id", "type": "string" }, "author_kind": { "title": "Author Kind", "type": "string" }, "author_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author User Id" }, "byte_size": { "title": "Byte Size", "type": "integer" }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content" }, "created_at": { "title": "Created At", "type": "string" }, "kind": { "title": "Kind", "type": "string" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" }, "manifest": { "additionalProperties": true, "title": "Manifest", "type": "object" }, "sha256": { "title": "Sha256", "type": "string" }, "title": { "title": "Title", "type": "string" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "artifact_id", "version", "sha256", "byte_size", "kind", "title", "language", "manifest", "author_user_id", "author_kind", "created_at" ], "title": "ArtifactVersionRecord", "type": "object" }, "ArtifactWhere": { "additionalProperties": false, "properties": { "field": { "minLength": 1, "title": "Field", "type": "string" }, "op": { "enum": [ "==", "!=", "<", "<=", ">", ">=", "in", "array-contains" ], "title": "Op", "type": "string" }, "value": { "title": "Value" } }, "required": [ "field", "op", "value" ], "title": "ArtifactWhere", "type": "object" }, "Assistant": { "additionalProperties": true, "description": "One Assistant's catalog row, as ``AssistantService._sanitize_assistant``\nrenders it.\n\nThe row is open — sanitizing removes the storage id and the credential\nbindings and passes the rest through — so the members named here are the\nones the console addresses by name and ``extra=\"allow\"`` carries the rest.\n\n``workspace_state`` and ``current_sandbox_id`` are not stored on the row:\nlist and detail reads join them from the workspace. An Assistant whose\nworkspace was never built reports ``workspace_state=\"NOT_MATERIALIZED\"``.", "properties": { "assistant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assistant Id" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "current_sandbox_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Current Sandbox Id" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "engine_kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Engine Kind" }, "engine_options": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Engine Options" }, "extension_catalog": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Extension Catalog" }, "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Icon" }, "inherited": { "anyOf": [ { "$ref": "#/components/schemas/InheritedExtensions" }, { "type": "null" } ] }, "main_session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Main Session Id" }, "mcp_assignments": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Mcp Assignments" }, "mcp_servers": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Mcp Servers" }, "model_config_override": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Model Config Override" }, "owner_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner Id" }, "packages": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Packages" }, "permission_mode_default": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Permission Mode Default" }, "primary": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Primary" }, "runtime_profile_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Runtime Profile Name" }, "skills": { "anyOf": [ { "items": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ] }, "type": "array" }, { "type": "null" } ], "title": "Skills" }, "system": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "System" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Timezone" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "workspace_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace State" } }, "title": "Assistant", "type": "object" }, "AssistantConnectorState": { "properties": { "assistant_id": { "title": "Assistant Id", "type": "string" }, "enabled": { "items": { "type": "string" }, "title": "Enabled", "type": "array" } }, "required": [ "assistant_id", "enabled" ], "title": "AssistantConnectorState", "type": "object" }, "AssistantDefaults": { "additionalProperties": false, "description": "The layer as stored, with the RuntimeProfile new Assistants would use now.", "properties": { "assistant_runtime_profile_names": { "items": { "type": "string" }, "title": "Assistant Runtime Profile Names", "type": "array" }, "credential_vault_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Credential Vault Ids" }, "effective_runtime_profile_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Effective Runtime Profile Name" }, "engine_options": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Engine Options" }, "extension_catalog": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Extension Catalog" }, "instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instructions" }, "mcp_assignments": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Mcp Assignments" }, "mcp_servers": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Mcp Servers" }, "model_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Name" }, "packages": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Packages" }, "runtime_profile_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Runtime Profile Name" }, "skills": { "anyOf": [ { "items": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ] }, "type": "array" }, { "type": "null" } ], "title": "Skills" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "required": [ "assistant_runtime_profile_names" ], "title": "AssistantDefaults", "type": "object" }, "AssistantDefaultsExtensionCatalog": { "additionalProperties": true, "description": "The extension catalog with the deployment layer's selection marked.", "properties": { "mcp_servers": { "items": { "$ref": "#/components/schemas/AgentExtensionItem" }, "title": "Mcp Servers", "type": "array" }, "selected_mcp_server_ids": { "items": { "type": "string" }, "title": "Selected Mcp Server Ids", "type": "array" }, "selected_skill_ids": { "items": { "type": "string" }, "title": "Selected Skill Ids", "type": "array" }, "skills": { "items": { "$ref": "#/components/schemas/AgentExtensionItem" }, "title": "Skills", "type": "array" } }, "required": [ "mcp_servers", "skills", "selected_mcp_server_ids", "selected_skill_ids" ], "title": "AssistantDefaultsExtensionCatalog", "type": "object" }, "AssistantDefaultsFields": { "additionalProperties": false, "description": "The layer's authored fields, named as an Assistant's own are.", "properties": { "credential_vault_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Credential Vault Ids" }, "engine_options": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Engine Options" }, "instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instructions" }, "mcp_servers": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Mcp Servers" }, "model_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Name" }, "packages": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Packages" }, "runtime_profile_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Runtime Profile Name" }, "skills": { "anyOf": [ { "items": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ] }, "type": "array" }, { "type": "null" } ], "title": "Skills" } }, "title": "AssistantDefaultsFields", "type": "object" }, "AssistantDeletion": { "additionalProperties": true, "description": "Confirmation that an Assistant's catalog row was soft-deleted.\n\nThe row is severed only after its sandbox is proven destroyed, so a caller\nthat receives this knows no box outlived the name. A destruction that\ncannot be confirmed refuses with ``ASSISTANT_SANDBOX_UNDESTROYED`` instead,\nkeeping the Assistant resolvable so the delete stays retryable.", "properties": { "assistant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assistant Id" }, "deleted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Deleted" } }, "title": "AssistantDeletion", "type": "object" }, "AssistantExtensionCatalog": { "additionalProperties": true, "description": "The provider's catalog with this Assistant's selection marked, as for an Agent.", "properties": { "assistant_id": { "title": "Assistant Id", "type": "string" }, "mcp_servers": { "items": { "$ref": "#/components/schemas/AgentExtensionItem" }, "title": "Mcp Servers", "type": "array" }, "selected_mcp_server_ids": { "items": { "type": "string" }, "title": "Selected Mcp Server Ids", "type": "array" }, "selected_skill_ids": { "items": { "type": "string" }, "title": "Selected Skill Ids", "type": "array" }, "skills": { "items": { "$ref": "#/components/schemas/AgentExtensionItem" }, "title": "Skills", "type": "array" } }, "required": [ "assistant_id", "mcp_servers", "skills", "selected_mcp_server_ids", "selected_skill_ids" ], "title": "AssistantExtensionCatalog", "type": "object" }, "AssistantListPage": { "additionalProperties": false, "description": "One page of the caller's Assistants, the most recently edited first.\n\n``next_cursor`` is the value to pass back as ``cursor``; it is ``null`` on\nthe last page, which ``has_more`` reports independently. ``total`` and\n``ready`` count every Assistant the caller owns, whatever ``q`` and\n``status`` narrowed, and come with the first page only.", "properties": { "assistants": { "items": { "$ref": "#/components/schemas/Assistant" }, "title": "Assistants", "type": "array" }, "has_more": { "title": "Has More", "type": "boolean" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "ready": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ready" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total" } }, "required": [ "assistants", "has_more" ], "title": "AssistantListPage", "type": "object" }, "AssistantWorkspace": { "additionalProperties": true, "description": "An Assistant workspace's posture after a wake.\n\nWaking is a request to reach ``READY``, not a wait for it. ``state`` says\nwhere the workspace is: ``READY`` names ``current_sandbox_id``;\n``MATERIALIZING`` names the ``provisioning_session_id`` that is building it,\nwhich the caller polls; ``RECOVERY_REQUIRED`` names the sandbox whose\ndestruction is unconfirmed, and blocks a rebuild until it is released.\nA completed hibernate has no sandbox to resume: wake materializes a fresh\none from the configured workspace medium.", "properties": { "assistant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assistant Id" }, "current_sandbox_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Current Sandbox Id" }, "engine_kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Engine Kind" }, "provisioning_session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provisioning Session Id" }, "recovery_pending_sandbox_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Recovery Pending Sandbox Id" }, "retryable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Retryable" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State" } }, "title": "AssistantWorkspace", "type": "object" }, "AssistantWorkspaceDestruction": { "additionalProperties": true, "description": "Confirmation that an Assistant's workspace was destroyed.\n\nThe Assistant's catalog row survives; a later wake builds a fresh\nworkspace for it.", "properties": { "assistant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assistant Id" }, "destroyed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Destroyed" } }, "title": "AssistantWorkspaceDestruction", "type": "object" }, "AssistantWorkspaceHibernation": { "additionalProperties": true, "description": "The outcome of taking an Assistant workspace offline.\n\nThe storage provider carries the files; ``released`` means the old sandbox\nwas proven gone and a later wake may prepare a fresh one from that medium.\n``recovery_required`` retains ``sandbox_id`` when destruction was not\nconfirmed, so the operation remains retryable without losing the box's\nlast name.", "properties": { "assistant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assistant Id" }, "hibernated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Hibernated" }, "hibernated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hibernated At" }, "previous_sandbox_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous Sandbox Id" }, "recovery_required": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Recovery Required" }, "released": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Released" }, "sandbox_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sandbox Id" } }, "title": "AssistantWorkspaceHibernation", "type": "object" }, "AuthorizeResponse": { "properties": { "authorize_url": { "title": "Authorize Url", "type": "string" } }, "required": [ "authorize_url" ], "title": "AuthorizeResponse", "type": "object" }, "Body_transcribe_session_speech_api_v1_sessions__session_id__speech_input_post": { "properties": { "file": { "contentMediaType": "application/octet-stream", "title": "File", "type": "string" }, "model": { "title": "Model", "type": "string" } }, "required": [ "model", "file" ], "title": "Body_transcribe_session_speech_api_v1_sessions__session_id__speech_input_post", "type": "object" }, "Body_upload_session_files_api_v1_sessions__session_id__files_upload_post": { "properties": { "files": { "items": { "contentMediaType": "application/octet-stream", "type": "string" }, "title": "Files", "type": "array" }, "path": { "default": "", "title": "Path", "type": "string" } }, "required": [ "files" ], "title": "Body_upload_session_files_api_v1_sessions__session_id__files_upload_post", "type": "object" }, "ChannelAccountLinkRecord": { "description": "One participant of a trigger and the AstraBox account its messages run as.", "properties": { "linked_at": { "title": "Linked At", "type": "string" }, "linked_by": { "title": "Linked By", "type": "string" }, "participant": { "title": "Participant", "type": "string" }, "user_id": { "title": "User Id", "type": "string" } }, "required": [ "participant", "user_id", "linked_by", "linked_at" ], "title": "ChannelAccountLinkRecord", "type": "object" }, "ChannelField": { "description": "One provider-owned field in the channel binding form.\n\nProvider fields cannot be hard-coded in the console: an installed native\nprovider must be able to replace a bundled adapter without teaching the\nfrontend another schema. ``secret`` controls storage as well as rendering;\nsecret fields are write-only and never enter the deployment repository.", "properties": { "default": { "title": "Default" }, "help": { "default": "", "title": "Help", "type": "string" }, "key": { "title": "Key", "type": "string" }, "kind": { "default": "string", "title": "Kind", "type": "string" }, "label": { "title": "Label", "type": "string" }, "options": { "default": [], "items": { "type": "string" }, "title": "Options", "type": "array" }, "placeholder": { "default": "", "title": "Placeholder", "type": "string" }, "required": { "default": true, "title": "Required", "type": "boolean" }, "secret": { "default": false, "title": "Secret", "type": "boolean" } }, "required": [ "key", "label" ], "title": "ChannelField", "type": "object" }, "ChannelProviderRecord": { "description": "The native provider descriptor plus platform configuration permissions.", "properties": { "callback_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Callback Path" }, "can_configure_execution_user": { "default": false, "title": "Can Configure Execution User", "type": "boolean" }, "config_fields": { "default": [], "items": { "$ref": "#/components/schemas/ChannelField" }, "title": "Config Fields", "type": "array" }, "credential_fields": { "default": [], "items": { "$ref": "#/components/schemas/ChannelField" }, "title": "Credential Fields", "type": "array" }, "documentation_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Documentation Url" }, "execution_modes": { "default": [ "owner", "account", "linked" ], "items": { "type": "string" }, "title": "Execution Modes", "type": "array" }, "label": { "title": "Label", "type": "string" }, "name": { "title": "Name", "type": "string" }, "participant_example": { "default": "", "title": "Participant Example", "type": "string" }, "participant_format": { "default": "", "title": "Participant Format", "type": "string" }, "scene": { "default": "", "title": "Scene", "type": "string" }, "setup_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Setup Url" }, "supports_source": { "default": false, "title": "Supports Source", "type": "boolean" }, "uses_trigger_secret": { "default": false, "title": "Uses Trigger Secret", "type": "boolean" } }, "required": [ "name", "label" ], "title": "ChannelProviderRecord", "type": "object" }, "ChildRunMessagePage": { "additionalProperties": false, "description": "The engine-owned transcript of one Session child run.", "properties": { "child_run_id": { "title": "Child Run Id", "type": "string" }, "messages": { "items": { "additionalProperties": true, "type": "object" }, "title": "Messages", "type": "array" }, "session_id": { "title": "Session Id", "type": "string" } }, "required": [ "session_id", "child_run_id", "messages" ], "title": "ChildRunMessagePage", "type": "object" }, "ChildRunRecord": { "additionalProperties": false, "description": "One engine-owned child run projected at Session scope.", "properties": { "active": { "description": "The engine reports active work, independently of resource closure.", "title": "Active", "type": "boolean" }, "child_run_id": { "title": "Child Run Id", "type": "string" }, "closed": { "title": "Closed", "type": "boolean" }, "depth": { "title": "Depth", "type": "integer" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "engine_event": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Engine Event" }, "engine_kind": { "title": "Engine Kind", "type": "string" }, "engine_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Engine Reason" }, "engine_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Engine Status" }, "last_tool_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Tool Name" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" }, "operations": { "items": { "type": "string" }, "title": "Operations", "type": "array" }, "parent_child_run_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Child Run Id" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Summary" }, "task_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Task Type" }, "tool_call_ids": { "description": "Tool invocations associated with this child by its engine.", "items": { "type": "string" }, "title": "Tool Call Ids", "type": "array" }, "usage": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Usage" } }, "required": [ "child_run_id", "engine_kind", "depth", "closed", "active", "operations" ], "title": "ChildRunRecord", "type": "object" }, "ChildRunStopResult": { "additionalProperties": false, "description": "Acknowledgement that an engine-owned child run was asked to stop.", "properties": { "child_run_id": { "title": "Child Run Id", "type": "string" }, "session_id": { "title": "Session Id", "type": "string" }, "status": { "title": "Status", "type": "string" } }, "required": [ "session_id", "child_run_id", "status" ], "title": "ChildRunStopResult", "type": "object" }, "ConfigureRequest": { "additionalProperties": false, "properties": { "client_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Id" }, "client_secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Secret" } }, "title": "ConfigureRequest", "type": "object" }, "Connector": { "additionalProperties": false, "description": "One work app: whether it is set up, and the caller's connection to it.", "properties": { "available": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Available" }, "configured": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Configured" }, "connector_id": { "title": "Connector Id", "type": "string" }, "deployed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Deployed" }, "docs_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Docs Url" }, "name": { "title": "Name", "type": "string" }, "published": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Published" }, "redirect_uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Redirect Uri" }, "registration": { "title": "Registration", "type": "string" }, "server_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Server Id" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, "required": [ "connector_id", "name", "registration" ], "title": "Connector", "type": "object" }, "ConversationEndResult": { "additionalProperties": true, "description": "The outcome of ending an Assistant conversation.\n\nSupported for Assistant conversations only; an Agent conversation is\nrefused. The conversation's runtime is disposed, and its history survives.", "properties": { "killed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Killed" }, "sandbox_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sandbox Id" }, "session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Session Id" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, "title": "ConversationEndResult", "type": "object" }, "CreateCredentialRequest": { "additionalProperties": false, "description": "Body for ``POST /api/v1/admin/vaults/{vault_id}/credentials``.\n\n``auth`` is the (open) credential document — the vault service validates its\n``type`` and shape and splits out the write-only secret fields.", "properties": { "auth": { "additionalProperties": true, "title": "Auth", "type": "object" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" } }, "required": [ "auth" ], "title": "CreateCredentialRequest", "type": "object" }, "CreateMCPServerRequest": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "enabled": { "default": true, "title": "Enabled", "type": "boolean" }, "name": { "title": "Name", "type": "string" }, "transport": { "default": "streamable_http", "title": "Transport", "type": "string" }, "url": { "title": "Url", "type": "string" } }, "required": [ "name", "url" ], "title": "CreateMCPServerRequest", "type": "object" }, "CreateVaultRequest": { "additionalProperties": false, "description": "Body for ``POST /api/v1/admin/vaults``.", "properties": { "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" } }, "title": "CreateVaultRequest", "type": "object" }, "CredentialAllowedRequests": { "additionalProperties": true, "description": "Method / path limits on the requests a credential may authenticate.", "properties": { "methods": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Methods" }, "paths": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Paths" } }, "title": "CredentialAllowedRequests", "type": "object" }, "CredentialAuthSummary": { "additionalProperties": true, "description": "Key fields and rules of one credential — never a secret payload.", "properties": { "allow_insecure_http": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Allow Insecure Http" }, "allowed_requests": { "anyOf": [ { "$ref": "#/components/schemas/CredentialAllowedRequests" }, { "type": "null" } ] }, "delivery": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Delivery" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "header_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Header Name" }, "injection_location": { "anyOf": [ { "$ref": "#/components/schemas/CredentialInjectionLocation" }, { "type": "null" } ] }, "mcp_server_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mcp Server Url" }, "networking": { "anyOf": [ { "$ref": "#/components/schemas/CredentialNetworking" }, { "type": "null" } ] }, "refresh": { "anyOf": [ { "$ref": "#/components/schemas/CredentialRefresh" }, { "type": "null" } ] }, "secret_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Secret Name" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Username" } }, "required": [ "type" ], "title": "CredentialAuthSummary", "type": "object" }, "CredentialBinding": { "additionalProperties": true, "description": "The Vaults an administrator bound to one Agent or Assistant.", "properties": { "target_id": { "title": "Target Id", "type": "string" }, "target_type": { "title": "Target Type", "type": "string" }, "vault_ids": { "items": { "type": "string" }, "title": "Vault Ids", "type": "array" }, "vaults": { "items": { "$ref": "#/components/schemas/Vault" }, "title": "Vaults", "type": "array" } }, "required": [ "target_type", "target_id", "vault_ids", "vaults" ], "title": "CredentialBinding", "type": "object" }, "CredentialDelivery": { "additionalProperties": true, "description": "How saved values reach a sandbox — mechanisms, never the values.", "properties": { "deployment_mode": { "title": "Deployment Mode", "type": "string" }, "environment_credentials": { "title": "Environment Credentials", "type": "string" }, "header_credentials": { "title": "Header Credentials", "type": "string" }, "mcp_credentials": { "title": "Mcp Credentials", "type": "string" }, "model_credentials": { "title": "Model Credentials", "type": "string" } }, "required": [ "deployment_mode", "model_credentials", "mcp_credentials", "environment_credentials", "header_credentials" ], "title": "CredentialDelivery", "type": "object" }, "CredentialInjectionLocation": { "additionalProperties": true, "description": "Where egress placeholder substitution is allowed; at least one is true.", "properties": { "body": { "title": "Body", "type": "boolean" }, "header": { "title": "Header", "type": "boolean" } }, "required": [ "header", "body" ], "title": "CredentialInjectionLocation", "type": "object" }, "CredentialNetworking": { "additionalProperties": true, "description": "Egress policy for one credential; ``allowed_hosts`` only when limited.", "properties": { "allowed_hosts": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Allowed Hosts" }, "type": { "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "CredentialNetworking", "type": "object" }, "CredentialRefresh": { "additionalProperties": true, "description": "Non-secret half of an OAuth refresh configuration.", "properties": { "auth_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth Method" }, "client_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Id" }, "scope": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scope" }, "token_endpoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Token Endpoint" } }, "title": "CredentialRefresh", "type": "object" }, "CurrentEnvironment": { "additionalProperties": true, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "display_name": { "title": "Display Name", "type": "string" }, "name": { "title": "Name", "type": "string" }, "runtime_policy": { "$ref": "#/components/schemas/EnvironmentRuntimePolicy" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "name", "display_name", "description", "version", "runtime_policy" ], "title": "CurrentEnvironment", "type": "object" }, "CurrentUser": { "additionalProperties": true, "description": "The identity the request resolved to, as the console reads it.\n\nThe three optional fields are what an identity provider filled in; the\nno-auth resolver asserts a user id and roles alone, so they arrive as null\nrather than being absent. The obligations that come with declaring a\nresponse model are in :mod:`astrabox.api.routes.response_envelope`.", "properties": { "avatar_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avatar Url" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "is_admin": { "title": "Is Admin", "type": "boolean" }, "roles": { "items": { "type": "string" }, "title": "Roles", "type": "array" }, "user_id": { "title": "User Id", "type": "string" } }, "required": [ "user_id", "display_name", "email", "avatar_url", "roles", "is_admin" ], "title": "CurrentUser", "type": "object" }, "DeleteSessionFilesRequest": { "description": "Body for ``POST /sessions/{id}/files/delete``.", "properties": { "paths": { "items": { "type": "string" }, "title": "Paths", "type": "array" } }, "required": [ "paths" ], "title": "DeleteSessionFilesRequest", "type": "object" }, "DeletedAgentCategory": { "properties": { "category_id": { "title": "Category Id", "type": "string" }, "unbound_agents": { "title": "Unbound Agents", "type": "integer" } }, "required": [ "category_id", "unbound_agents" ], "title": "DeletedAgentCategory", "type": "object" }, "DeletedChannelAccountLink": { "description": "The participant whose link is gone; ``deleted`` is false if it had none.", "properties": { "deleted": { "title": "Deleted", "type": "boolean" }, "participant": { "title": "Participant", "type": "string" } }, "required": [ "participant", "deleted" ], "title": "DeletedChannelAccountLink", "type": "object" }, "DeletedDeployment": { "additionalProperties": true, "description": "The binding that is gone. ``deleted`` confirms it and its channel records were deleted.", "properties": { "deleted": { "title": "Deleted", "type": "boolean" }, "deployment_id": { "title": "Deployment Id", "type": "string" } }, "required": [ "deployment_id", "deleted" ], "title": "DeletedDeployment", "type": "object" }, "DeploymentExtensionProvider": { "additionalProperties": false, "description": "The deployment's extension provider; ``provider`` is null when it runs no catalog.", "properties": { "provider": { "anyOf": [ { "$ref": "#/components/schemas/ExtensionProviderView" }, { "type": "null" } ] } }, "required": [ "provider" ], "title": "DeploymentExtensionProvider", "type": "object" }, "DeploymentRecord": { "additionalProperties": true, "description": "One trigger binding on an Agent or Assistant, as ``DeploymentService`` stores it.\n\n``secret`` is the credential the calling system signs with, returned so the\nconfigurer can register it there. A record reports the settings its binding\nhas; ``extra=\"allow\"`` carries the ones a scene adds (``channel_config``,\n``schedule``, ``callback_base_url``, ...).", "properties": { "agent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agent Id" }, "agent_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agent Name" }, "allowed_participants": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Allowed Participants" }, "assistant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assistant Id" }, "assistant_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assistant Name" }, "attention_policy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Attention Policy" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "deployment_id": { "title": "Deployment Id", "type": "string" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" }, "environment_name": { "title": "Environment Name", "type": "string" }, "execution_mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Execution Mode" }, "execution_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Execution User Id" }, "owner_org_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner Org Id" }, "owner_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner User Id" }, "prompt_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prompt Prefix" }, "response_instruction": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Response Instruction" }, "scene": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scene" }, "scope": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scope" }, "secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Secret" }, "source_assistant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Assistant Id" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "required": [ "deployment_id", "environment_name" ], "title": "DeploymentRecord", "type": "object" }, "DeploymentRun": { "description": "The public Run projection produced by DeploymentService._render_run.", "properties": { "agent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agent Id" }, "assistant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assistant Id" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "deployment_id": { "title": "Deployment Id", "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "input_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Input Id" }, "replayed_from_run_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Replayed From Run Id" }, "run_id": { "title": "Run Id", "type": "string" }, "scheduled_for": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheduled For" }, "session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Session Id" }, "status": { "title": "Status", "type": "string" }, "trigger": { "title": "Trigger", "type": "string" } }, "required": [ "run_id", "deployment_id", "agent_id", "assistant_id", "trigger", "status", "scheduled_for", "replayed_from_run_id", "session_id", "input_id", "error", "created_at" ], "title": "DeploymentRun", "type": "object" }, "DeploymentTriggerAck": { "additionalProperties": true, "description": "What an inbound trigger is told once the work is durable.\n\nA channel provider may merge its own acknowledgement fields into this\nanswer — a platform echoing back a verification challenge, for instance —\nso unlisted members are part of the contract, not an accident.", "properties": { "deployment_id": { "title": "Deployment Id", "type": "string" }, "session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Session Id" }, "status": { "title": "Status", "type": "string" } }, "required": [ "deployment_id", "status" ], "title": "DeploymentTriggerAck", "type": "object" }, "EnsurePrimaryAssistantRequest": { "additionalProperties": false, "description": "What a first-created primary Assistant starts with; ignored when it exists.", "properties": { "display_name": { "title": "Display Name", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Timezone" } }, "required": [ "display_name" ], "title": "EnsurePrimaryAssistantRequest", "type": "object" }, "EnvironmentRuntimePolicy": { "additionalProperties": false, "properties": { "agent_prewarm_enabled": { "title": "Agent Prewarm Enabled", "type": "boolean" }, "background_execution_enabled": { "title": "Background Execution Enabled", "type": "boolean" }, "custody_scope": { "const": "environment", "title": "Custody Scope", "type": "string" }, "scheduler_provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheduler Provider" }, "scheduler_worker_enabled": { "title": "Scheduler Worker Enabled", "type": "boolean" } }, "required": [ "agent_prewarm_enabled", "background_execution_enabled", "custody_scope", "scheduler_provider", "scheduler_worker_enabled" ], "title": "EnvironmentRuntimePolicy", "type": "object" }, "EnvironmentView": { "additionalProperties": true, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "display_name": { "title": "Display Name", "type": "string" }, "name": { "title": "Name", "type": "string" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "name", "display_name", "description", "version" ], "title": "EnvironmentView", "type": "object" }, "EnvironmentWrite": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "display_name": { "maxLength": 256, "minLength": 1, "title": "Display Name", "type": "string" }, "member_user_ids": { "items": { "type": "string" }, "title": "Member User Ids", "type": "array" }, "version": { "minimum": 1.0, "title": "Version", "type": "integer" } }, "required": [ "display_name", "version" ], "title": "EnvironmentWrite", "type": "object" }, "ErrorDetails": { "additionalProperties": true, "description": "The structured diagnostics emitted by ``APIError.to_error_envelope``.", "properties": { "category": { "title": "Category", "type": "string" }, "cause_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cause Code" }, "code": { "title": "Code", "type": "string" }, "debug_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Debug Message" }, "evidence": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Evidence" }, "owner": { "title": "Owner", "type": "string" }, "retryable": { "title": "Retryable", "type": "boolean" }, "status_code": { "title": "Status Code", "type": "integer" }, "user_message": { "title": "User Message", "type": "string" } }, "required": [ "code", "status_code", "category", "retryable", "owner", "user_message" ], "title": "ErrorDetails", "type": "object" }, "ErrorResponse": { "description": "The JSON body emitted by the shared API exception handlers.", "properties": { "code": { "title": "Code", "type": "string" }, "data": { "title": "Data" }, "error": { "$ref": "#/components/schemas/ErrorDetails" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message", "data", "error" ], "title": "ErrorResponse", "type": "object" }, "ExposedPortUrl": { "additionalProperties": true, "description": "A freshly minted browser-reachable URL for one sandbox port.\n\nThe URL is short-lived and carries its own bearer, so a caller re-requests\nit rather than caching it.", "properties": { "port": { "title": "Port", "type": "integer" }, "url": { "title": "Url", "type": "string" } }, "required": [ "url", "port" ], "title": "ExposedPortUrl", "type": "object" }, "ExtensionConsoleSession": { "additionalProperties": true, "description": "Where to send the browser, and how long the grant lasts.\n\nThe session itself lives in the cookies the route sets; the body carries no\ntoken, so a client that logs or forwards it discloses nothing. The\nobligations that come with declaring a response model are in\n:mod:`astrabox.api.routes.response_envelope`.", "properties": { "expires_in": { "title": "Expires In", "type": "integer" }, "open_url": { "title": "Open Url", "type": "string" } }, "required": [ "open_url", "expires_in" ], "title": "ExtensionConsoleSession", "type": "object" }, "ExtensionConsoleSessionRequest": { "additionalProperties": false, "description": "Which kind of catalog entry the management console is opened for.", "properties": { "section": { "default": "mcp", "enum": [ "mcp", "skills" ], "title": "Section", "type": "string" } }, "title": "ExtensionConsoleSessionRequest", "type": "object" }, "ExtensionProviderView": { "additionalProperties": false, "description": "The extension provider whose catalog this deployment offers.\n\n``name`` is the ``ASTRABOX_EXTENSION_PROVIDER`` value that selects it;\n``display_name`` and ``management_console`` are what the provider declares\n(``ExtensionProviderFeatures``).", "properties": { "display_name": { "title": "Display Name", "type": "string" }, "management_console": { "title": "Management Console", "type": "boolean" }, "name": { "title": "Name", "type": "string" } }, "required": [ "name", "display_name", "management_console" ], "title": "ExtensionProviderView", "type": "object" }, "HeldInputView": { "additionalProperties": false, "description": "An input the platform still holds: accepted, not yet durably taken by the runtime.", "properties": { "client_message_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Message Id" }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "input_id": { "title": "Input Id", "type": "string" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State" } }, "required": [ "input_id" ], "title": "HeldInputView", "type": "object" }, "InheritedExtensions": { "additionalProperties": false, "description": "What an Assistant inherits from the layers above it, by name and source.\n\nCredential Vaults are counted, not named; nothing here can be edited\nthrough the Assistant.", "properties": { "catalog_mcp_servers": { "title": "Catalog Mcp Servers", "type": "integer" }, "catalog_skills": { "items": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ] }, "title": "Catalog Skills", "type": "array" }, "credential_vaults": { "title": "Credential Vaults", "type": "integer" }, "instructions": { "title": "Instructions", "type": "boolean" }, "mcp_servers": { "items": { "type": "string" }, "title": "Mcp Servers", "type": "array" }, "packages": { "items": { "additionalProperties": true, "type": "object" }, "title": "Packages", "type": "array" }, "skills": { "items": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ] }, "title": "Skills", "type": "array" } }, "required": [ "instructions", "skills", "catalog_skills", "mcp_servers", "catalog_mcp_servers", "packages", "credential_vaults" ], "title": "InheritedExtensions", "type": "object" }, "InputReceipt": { "additionalProperties": false, "description": "An accepted input. Its response arrives on the session's stream.\n\n``duplicate`` is true when the same ``client_message_id`` was accepted\nbefore; the receipt then describes that earlier input, including its\nrecorded refusal in ``failure`` when it failed.", "properties": { "accepted_at": { "title": "Accepted At", "type": "string" }, "client_message_id": { "title": "Client Message Id", "type": "string" }, "duplicate": { "title": "Duplicate", "type": "boolean" }, "failure": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Failure" }, "input_id": { "title": "Input Id", "type": "string" }, "session_id": { "title": "Session Id", "type": "string" }, "state": { "title": "State", "type": "string" } }, "required": [ "session_id", "input_id", "client_message_id", "accepted_at", "state", "duplicate" ], "title": "InputReceipt", "type": "object" }, "InteractionAnswerReceipt": { "additionalProperties": false, "description": "An answer stored for the runtime; the response continues on the stream.", "properties": { "answered": { "title": "Answered", "type": "boolean" }, "interaction_id": { "title": "Interaction Id", "type": "string" }, "session_id": { "title": "Session Id", "type": "string" } }, "required": [ "session_id", "interaction_id", "answered" ], "title": "InteractionAnswerReceipt", "type": "object" }, "InterruptReceipt": { "additionalProperties": false, "description": "``accepted`` when a reader will pass the interrupt on; ``idle`` when nothing runs.", "properties": { "session_id": { "title": "Session Id", "type": "string" }, "status": { "title": "Status", "type": "string" } }, "required": [ "session_id", "status" ], "title": "InterruptReceipt", "type": "object" }, "IssuedMCPClientToken": { "additionalProperties": true, "description": "The mint's answer — the only place the secret is ever returned.", "properties": { "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Used At" }, "name": { "title": "Name", "type": "string" }, "scope": { "title": "Scope", "type": "string" }, "secret": { "title": "Secret", "type": "string" }, "token_id": { "title": "Token Id", "type": "string" } }, "required": [ "token_id", "name", "scope", "expires_at", "created_at", "last_used_at", "secret" ], "title": "IssuedMCPClientToken", "type": "object" }, "ListSessionFilesRequest": { "description": "Body for ``POST /sessions/{id}/files/list`` — optional path filter.", "properties": { "path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Path" } }, "title": "ListSessionFilesRequest", "type": "object" }, "MCPAnnotations": { "description": "Optional annotations the client can use to inform how objects are used or displayed.", "properties": { "audience": { "anyOf": [ { "items": { "enum": [ "user", "assistant" ], "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Audience" }, "lastModified": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Lastmodified" }, "priority": { "anyOf": [ { "maximum": 1.0, "minimum": 0.0, "type": "number" }, { "type": "null" } ], "default": null, "title": "Priority" } }, "title": "Annotations", "type": "object" }, "MCPAudioContent": { "description": "Audio provided to or from an LLM.", "properties": { "_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" }, "annotations": { "anyOf": [ { "$ref": "#/components/schemas/MCPAnnotations" }, { "type": "null" } ], "default": null }, "data": { "title": "Data", "type": "string" }, "mimeType": { "title": "Mimetype", "type": "string" }, "type": { "const": "audio", "default": "audio", "title": "Type", "type": "string" } }, "required": [ "data", "mimeType" ], "title": "AudioContent", "type": "object" }, "MCPBlobResourceContents": { "description": "Binary contents of a resource.", "properties": { "_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" }, "blob": { "title": "Blob", "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Mimetype" }, "uri": { "title": "Uri", "type": "string" } }, "required": [ "uri", "blob" ], "title": "BlobResourceContents", "type": "object" }, "MCPCallToolRequest": { "description": "Used by the client to invoke a tool provided by the server.", "properties": { "method": { "const": "tools/call", "default": "tools/call", "title": "Method", "type": "string" }, "params": { "$ref": "#/components/schemas/MCPCallToolRequestParams" } }, "required": [ "params" ], "title": "CallToolRequest", "type": "object" }, "MCPCallToolRequestParams": { "properties": { "_meta": { "anyOf": [ { "$ref": "#/components/schemas/MCPRequestParamsMeta" }, { "type": "null" } ], "default": null }, "arguments": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Arguments" }, "inputResponses": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "$ref": "#/components/schemas/MCPCreateMessageResult" }, { "$ref": "#/components/schemas/MCPCreateMessageResultWithTools" }, { "$ref": "#/components/schemas/MCPListRootsResult" }, { "$ref": "#/components/schemas/MCPElicitResult" } ] }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Inputresponses" }, "name": { "title": "Name", "type": "string" }, "requestState": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Requeststate" }, "task": { "anyOf": [ { "$ref": "#/components/schemas/MCPTaskMetadata" }, { "type": "null" } ], "default": null } }, "required": [ "name" ], "title": "CallToolRequestParams", "type": "object" }, "MCPCallToolResult": { "description": "The server's response to a tool call.\n\nErrors that originate from the tool SHOULD be reported inside the result\nwith `is_error` set to true, not as an MCP protocol-level error, so the LLM\ncan see and self-correct. Errors in finding the tool, or any other\nexceptional condition, should be reported as an MCP error response.", "properties": { "_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" }, "content": { "items": { "anyOf": [ { "$ref": "#/components/schemas/MCPTextContent" }, { "$ref": "#/components/schemas/MCPImageContent" }, { "$ref": "#/components/schemas/MCPAudioContent" }, { "$ref": "#/components/schemas/MCPResourceLink" }, { "$ref": "#/components/schemas/MCPEmbeddedResource" } ] }, "title": "Content", "type": "array" }, "isError": { "default": false, "title": "Iserror", "type": "boolean" }, "resultType": { "anyOf": [ { "enum": [ "complete", "input_required" ], "type": "string" }, { "type": "string" } ], "default": "complete", "title": "Resulttype" }, "structuredContent": { "default": null, "title": "Structuredcontent" } }, "required": [ "content" ], "title": "CallToolResult", "type": "object" }, "MCPCancelledNotification": { "description": "This notification can be sent by either side to indicate that it is canceling a\npreviously-issued request.\n\nThe request SHOULD still be in-flight, but due to communication latency, it\nis always possible that this notification MAY arrive after the request has\nalready finished. A client MUST NOT attempt to cancel its `initialize` request.", "properties": { "method": { "const": "notifications/cancelled", "default": "notifications/cancelled", "title": "Method", "type": "string" }, "params": { "$ref": "#/components/schemas/MCPCancelledNotificationParams" } }, "required": [ "params" ], "title": "CancelledNotification", "type": "object" }, "MCPCancelledNotificationParams": { "properties": { "_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Reason" }, "requestId": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Requestid" } }, "title": "CancelledNotificationParams", "type": "object" }, "MCPClientCall": { "anyOf": [ { "$ref": "#/components/schemas/MCPInitializeRequest" }, { "$ref": "#/components/schemas/MCPPingRequest" }, { "$ref": "#/components/schemas/MCPListToolsRequest" }, { "$ref": "#/components/schemas/MCPCallToolRequest" }, { "$ref": "#/components/schemas/MCPCancelledNotification" }, { "$ref": "#/components/schemas/MCPProgressNotification" }, { "$ref": "#/components/schemas/MCPInitializedNotification" }, { "$ref": "#/components/schemas/MCPRootsListChangedNotification" } ] }, "MCPClientCapabilities": { "description": "Capabilities a client may support.\n\nNot a closed set: any client can define additional capabilities. Sent once in\n`initialize` through 2025-11-25; per-request in `_meta` on 2026-07-28.", "properties": { "elicitation": { "anyOf": [ { "$ref": "#/components/schemas/MCPElicitationCapability" }, { "type": "null" } ], "default": null }, "experimental": { "anyOf": [ { "additionalProperties": { "additionalProperties": true, "type": "object" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Experimental" }, "extensions": { "anyOf": [ { "additionalProperties": { "additionalProperties": true, "type": "object" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Extensions" }, "roots": { "anyOf": [ { "$ref": "#/components/schemas/MCPRootsCapability" }, { "type": "null" } ], "default": null }, "sampling": { "anyOf": [ { "$ref": "#/components/schemas/MCPSamplingCapability" }, { "type": "null" } ], "default": null }, "tasks": { "anyOf": [ { "$ref": "#/components/schemas/MCPClientTasksCapability" }, { "type": "null" } ], "default": null } }, "title": "ClientCapabilities", "type": "object" }, "MCPClientTasksCapability": { "description": "Capability for client tasks operations (2025-11-25 only).", "properties": { "cancel": { "anyOf": [ { "$ref": "#/components/schemas/MCPTasksCancelCapability" }, { "type": "null" } ], "default": null }, "list": { "anyOf": [ { "$ref": "#/components/schemas/MCPTasksListCapability" }, { "type": "null" } ], "default": null }, "requests": { "anyOf": [ { "$ref": "#/components/schemas/MCPClientTasksRequestsCapability" }, { "type": "null" } ], "default": null } }, "title": "ClientTasksCapability", "type": "object" }, "MCPClientTasksRequestsCapability": { "description": "Specifies which request types the client can augment with tasks (2025-11-25 only).", "properties": { "elicitation": { "anyOf": [ { "$ref": "#/components/schemas/MCPTasksElicitationCapability" }, { "type": "null" } ], "default": null }, "sampling": { "anyOf": [ { "$ref": "#/components/schemas/MCPTasksSamplingCapability" }, { "type": "null" } ], "default": null } }, "title": "ClientTasksRequestsCapability", "type": "object" }, "MCPClientToken": { "additionalProperties": true, "description": "One key, as ``mcp_client_token_service.public_view`` renders it.\n\nThere is no ``secret`` field: it exists only in the issuing answer below, so\na reader cannot mistake an absent secret for an empty one.", "properties": { "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Used At" }, "name": { "title": "Name", "type": "string" }, "scope": { "title": "Scope", "type": "string" }, "token_id": { "title": "Token Id", "type": "string" } }, "required": [ "token_id", "name", "scope", "expires_at", "created_at", "last_used_at" ], "title": "MCPClientToken", "type": "object" }, "MCPClientTokenList": { "additionalProperties": true, "description": "Every key the calling user holds.", "properties": { "tokens": { "items": { "$ref": "#/components/schemas/MCPClientToken" }, "title": "Tokens", "type": "array" } }, "required": [ "tokens" ], "title": "MCPClientTokenList", "type": "object" }, "MCPCompleteResult": { "description": "The server's response to a completion/complete request.", "properties": { "_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" }, "completion": { "$ref": "#/components/schemas/MCPCompletion" }, "resultType": { "anyOf": [ { "enum": [ "complete", "input_required" ], "type": "string" }, { "type": "string" } ], "default": "complete", "title": "Resulttype" } }, "required": [ "completion" ], "title": "CompleteResult", "type": "object" }, "MCPCompletion": { "description": "Completion information.", "properties": { "hasMore": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Hasmore" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Total" }, "values": { "items": { "type": "string" }, "title": "Values", "type": "array" } }, "required": [ "values" ], "title": "Completion", "type": "object" }, "MCPCompletionsCapability": { "description": "Capability for completions operations.", "properties": {}, "title": "CompletionsCapability", "type": "object" }, "MCPCreateMessageRequest": { "description": "A request from the server to sample an LLM via the client.\n\nThe client has full discretion over which model to select and should inform\nthe user before sampling (human in the loop). A standalone JSON-RPC request\nthrough 2025-11-25; on 2026-07-28 it is embedded in\n`InputRequiredResult.input_requests` instead. Deprecated in 2026-07-28 (SEP-2577).", "properties": { "method": { "const": "sampling/createMessage", "default": "sampling/createMessage", "title": "Method", "type": "string" }, "params": { "$ref": "#/components/schemas/MCPCreateMessageRequestParams" } }, "required": [ "params" ], "title": "CreateMessageRequest", "type": "object" }, "MCPCreateMessageRequestParams": { "properties": { "_meta": { "anyOf": [ { "$ref": "#/components/schemas/MCPRequestParamsMeta" }, { "type": "null" } ], "default": null }, "includeContext": { "anyOf": [ { "enum": [ "none", "thisServer", "allServers" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Includecontext" }, "maxTokens": { "title": "Maxtokens", "type": "integer" }, "messages": { "items": { "$ref": "#/components/schemas/MCPSamplingMessage" }, "title": "Messages", "type": "array" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Metadata" }, "modelPreferences": { "anyOf": [ { "$ref": "#/components/schemas/MCPModelPreferences" }, { "type": "null" } ], "default": null }, "stopSequences": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Stopsequences" }, "systemPrompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemprompt" }, "task": { "anyOf": [ { "$ref": "#/components/schemas/MCPTaskMetadata" }, { "type": "null" } ], "default": null }, "temperature": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Temperature" }, "toolChoice": { "anyOf": [ { "$ref": "#/components/schemas/MCPToolChoice" }, { "type": "null" } ], "default": null }, "tools": { "anyOf": [ { "items": { "$ref": "#/components/schemas/MCPTool" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Tools" } }, "required": [ "messages", "maxTokens" ], "title": "CreateMessageRequestParams", "type": "object" }, "MCPCreateMessageResult": { "description": "The client's response to a sampling/createMessage request from the server.\n\nThis is the backwards-compatible version that returns single content (no arrays).\nUsed when the request does not include tools.\n\nOn 2026-07-28 this travels embedded in an `InputResponses` map rather than\nas a top-level JSON-RPC result. Deprecated in 2026-07-28 (SEP-2577).", "properties": { "_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" }, "content": { "anyOf": [ { "$ref": "#/components/schemas/MCPTextContent" }, { "$ref": "#/components/schemas/MCPImageContent" }, { "$ref": "#/components/schemas/MCPAudioContent" } ], "title": "Content" }, "model": { "title": "Model", "type": "string" }, "role": { "enum": [ "user", "assistant" ], "title": "Role", "type": "string" }, "stopReason": { "anyOf": [ { "enum": [ "endTurn", "stopSequence", "maxTokens", "toolUse" ], "type": "string" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Stopreason" } }, "required": [ "role", "content", "model" ], "title": "CreateMessageResult", "type": "object" }, "MCPCreateMessageResultWithTools": { "description": "The client's response to a sampling/createMessage request when tools were provided.\n\nThis version supports array content for tool use flows (2025-11-25 and later).", "properties": { "_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" }, "content": { "anyOf": [ { "$ref": "#/components/schemas/MCPTextContent" }, { "$ref": "#/components/schemas/MCPImageContent" }, { "$ref": "#/components/schemas/MCPAudioContent" }, { "$ref": "#/components/schemas/MCPToolUseContent" }, { "$ref": "#/components/schemas/MCPToolResultContent" }, { "items": { "anyOf": [ { "$ref": "#/components/schemas/MCPTextContent" }, { "$ref": "#/components/schemas/MCPImageContent" }, { "$ref": "#/components/schemas/MCPAudioContent" }, { "$ref": "#/components/schemas/MCPToolUseContent" }, { "$ref": "#/components/schemas/MCPToolResultContent" } ] }, "type": "array" } ], "title": "Content" }, "model": { "title": "Model", "type": "string" }, "role": { "enum": [ "user", "assistant" ], "title": "Role", "type": "string" }, "stopReason": { "anyOf": [ { "enum": [ "endTurn", "stopSequence", "maxTokens", "toolUse" ], "type": "string" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Stopreason" } }, "required": [ "role", "content", "model" ], "title": "CreateMessageResultWithTools", "type": "object" }, "MCPDiscoverResult": { "description": "The result returned by the server for a `server/discover` request (2026-07-28).", "properties": { "_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" }, "cacheScope": { "default": "private", "enum": [ "public", "private" ], "title": "Cachescope", "type": "string" }, "capabilities": { "$ref": "#/components/schemas/MCPServerCapabilities" }, "instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Instructions" }, "resultType": { "anyOf": [ { "enum": [ "complete", "input_required" ], "type": "string" }, { "type": "string" } ], "default": "complete", "title": "Resulttype" }, "supportedVersions": { "items": { "type": "string" }, "title": "Supportedversions", "type": "array" }, "ttlMs": { "default": 0, "minimum": 0, "title": "Ttlms", "type": "integer" } }, "required": [ "supportedVersions", "capabilities" ], "title": "DiscoverResult", "type": "object" }, "MCPElicitRequest": { "description": "A request from the server to elicit additional information from the user via the client.", "properties": { "method": { "const": "elicitation/create", "default": "elicitation/create", "title": "Method", "type": "string" }, "params": { "anyOf": [ { "$ref": "#/components/schemas/MCPElicitRequestURLParams" }, { "$ref": "#/components/schemas/MCPElicitRequestFormParams" } ], "title": "Params" } }, "required": [ "params" ], "title": "ElicitRequest", "type": "object" }, "MCPElicitRequestFormParams": { "description": "Parameters for form mode elicitation requests.\n\nForm mode collects non-sensitive information from the user via an in-band form\nrendered by the client.", "properties": { "_meta": { "anyOf": [ { "$ref": "#/components/schemas/MCPRequestParamsMeta" }, { "type": "null" } ], "default": null }, "message": { "title": "Message", "type": "string" }, "mode": { "const": "form", "default": "form", "title": "Mode", "type": "string" }, "requestedSchema": { "additionalProperties": true, "title": "Requestedschema", "type": "object" }, "task": { "anyOf": [ { "$ref": "#/components/schemas/MCPTaskMetadata" }, { "type": "null" } ], "default": null } }, "required": [ "message", "requestedSchema" ], "title": "ElicitRequestFormParams", "type": "object" }, "MCPElicitRequestURLParams": { "description": "Parameters for URL mode elicitation requests.\n\nURL mode directs users to external URLs for sensitive out-of-band interactions\nlike OAuth flows, credential collection, or payment processing. New in 2025-11-25.", "properties": { "_meta": { "anyOf": [ { "$ref": "#/components/schemas/MCPRequestParamsMeta" }, { "type": "null" } ], "default": null }, "elicitationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Elicitationid" }, "message": { "title": "Message", "type": "string" }, "mode": { "const": "url", "default": "url", "title": "Mode", "type": "string" }, "task": { "anyOf": [ { "$ref": "#/components/schemas/MCPTaskMetadata" }, { "type": "null" } ], "default": null }, "url": { "title": "Url", "type": "string" } }, "required": [ "message", "url" ], "title": "ElicitRequestURLParams", "type": "object" }, "MCPElicitResult": { "description": "The client's response to an elicitation request.", "properties": { "_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" }, "action": { "enum": [ "accept", "decline", "cancel" ], "title": "Action", "type": "string" }, "content": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Content" } }, "required": [ "action" ], "title": "ElicitResult", "type": "object" }, "MCPElicitationCapability": { "description": "Capability for elicitation operations.\n\nClients must support at least one mode (form or url).", "properties": { "form": { "anyOf": [ { "$ref": "#/components/schemas/MCPFormElicitationCapability" }, { "type": "null" } ], "default": null }, "url": { "anyOf": [ { "$ref": "#/components/schemas/MCPUrlElicitationCapability" }, { "type": "null" } ], "default": null } }, "title": "ElicitationCapability", "type": "object" }, "MCPEmbeddedResource": { "description": "The contents of a resource, embedded into a prompt or tool call result.\n\nIt is up to the client how best to render embedded resources for the benefit\nof the LLM and/or the user.", "properties": { "_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" }, "annotations": { "anyOf": [ { "$ref": "#/components/schemas/MCPAnnotations" }, { "type": "null" } ], "default": null }, "resource": { "anyOf": [ { "$ref": "#/components/schemas/MCPTextResourceContents" }, { "$ref": "#/components/schemas/MCPBlobResourceContents" } ], "title": "Resource" }, "type": { "const": "resource", "default": "resource", "title": "Type", "type": "string" } }, "required": [ "resource" ], "title": "EmbeddedResource", "type": "object" }, "MCPEmptyResult": { "description": "A result that indicates success but carries no data.\n\n`result_type` defaults to None so this dumps as `{}`: deployed TypeScript\nand Rust SDK peers (clients and servers) validate empty results strictly\nand reject extra keys. The 2026-07-28 schema requires `resultType`, so code\nanswering an empty result on a 2026-07-28+ session must pass\n`result_type=\"complete\"`.", "properties": { "_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" }, "resultType": { "anyOf": [ { "enum": [ "complete", "input_required" ], "type": "string" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resulttype" } }, "title": "EmptyResult", "type": "object" }, "MCPFormElicitationCapability": { "description": "Capability for form mode elicitation.", "properties": {}, "title": "FormElicitationCapability", "type": "object" }, "MCPGetPromptResult": { "description": "The server's response to a prompts/get request from the client.", "properties": { "_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "messages": { "items": { "$ref": "#/components/schemas/MCPPromptMessage" }, "title": "Messages", "type": "array" }, "resultType": { "anyOf": [ { "enum": [ "complete", "input_required" ], "type": "string" }, { "type": "string" } ], "default": "complete", "title": "Resulttype" } }, "required": [ "messages" ], "title": "GetPromptResult", "type": "object" }, "MCPIcon": { "description": "An optionally-sized icon for display in a user interface (2025-11-25+).", "properties": { "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Mimetype" }, "sizes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Sizes" }, "src": { "title": "Src", "type": "string" }, "theme": { "anyOf": [ { "enum": [ "light", "dark" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Theme" } }, "required": [ "src" ], "title": "Icon", "type": "object" }, "MCPImageContent": { "description": "An image provided to or from an LLM.", "properties": { "_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" }, "annotations": { "anyOf": [ { "$ref": "#/components/schemas/MCPAnnotations" }, { "type": "null" } ], "default": null }, "data": { "title": "Data", "type": "string" }, "mimeType": { "title": "Mimetype", "type": "string" }, "type": { "const": "image", "default": "image", "title": "Type", "type": "string" } }, "required": [ "data", "mimeType" ], "title": "ImageContent", "type": "object" }, "MCPImplementation": { "description": "Describes the name and version of an MCP implementation (`clientInfo` / `serverInfo`).", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "icons": { "anyOf": [ { "items": { "$ref": "#/components/schemas/MCPIcon" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Icons" }, "name": { "title": "Name", "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Title" }, "version": { "title": "Version", "type": "string" }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Websiteurl" } }, "required": [ "name", "version" ], "title": "Implementation", "type": "object" }, "MCPInitializeRequest": { "description": "This request is sent from the client to the server when it first connects, asking it\nto begin initialization.\n\nRemoved in protocol 2026-07-28; sent/received on sessions negotiating <= 2025-11-25.\nOn 2026-07-28 the handshake is `server/discover` plus per-request `_meta`.", "properties": { "method": { "const": "initialize", "default": "initialize", "title": "Method", "type": "string" }, "params": { "$ref": "#/components/schemas/MCPInitializeRequestParams" } }, "required": [ "params" ], "title": "InitializeRequest", "type": "object" }, "MCPInitializeRequestParams": { "description": "Parameters for the `initialize` request.\n\nRemoved in protocol 2026-07-28; sent/received on sessions negotiating <= 2025-11-25.", "properties": { "_meta": { "anyOf": [ { "$ref": "#/components/schemas/MCPRequestParamsMeta" }, { "type": "null" } ], "default": null }, "capabilities": { "$ref": "#/components/schemas/MCPClientCapabilities" }, "clientInfo": { "$ref": "#/components/schemas/MCPImplementation" }, "protocolVersion": { "title": "Protocolversion", "type": "string" } }, "required": [ "protocolVersion", "capabilities", "clientInfo" ], "title": "InitializeRequestParams", "type": "object" }, "MCPInitializeResult": { "description": "After receiving an initialize request from the client, the server sends this response.\n\nRemoved in protocol 2026-07-28; sent/received on sessions negotiating <= 2025-11-25.", "properties": { "_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" }, "capabilities": { "$ref": "#/components/schemas/MCPServerCapabilities" }, "instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Instructions" }, "protocolVersion": { "title": "Protocolversion", "type": "string" }, "serverInfo": { "$ref": "#/components/schemas/MCPImplementation" } }, "required": [ "protocolVersion", "capabilities", "serverInfo" ], "title": "InitializeResult", "type": "object" }, "MCPInitializedNotification": { "description": "This notification is sent from the client to the server after initialization has\nfinished.\n\nRemoved in protocol 2026-07-28; sent/received on sessions negotiating <= 2025-11-25.", "properties": { "method": { "const": "notifications/initialized", "default": "notifications/initialized", "title": "Method", "type": "string" }, "params": { "anyOf": [ { "$ref": "#/components/schemas/MCPNotificationParams" }, { "type": "null" } ], "default": null } }, "title": "InitializedNotification", "type": "object" }, "MCPInputRequiredResult": { "description": "The server needs additional input before the original request can complete (2026-07-28).\n\nReturned in place of the normal result of an interactive client request\n(`tools/call`, `prompts/get`, `resources/read`). The client fulfills\n`input_requests` and retries the original request, carrying the responses\nand the echoed `request_state`. At least one of those two fields is\npresent on the wire (spec MUST).", "properties": { "_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" }, "inputRequests": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "$ref": "#/components/schemas/MCPCreateMessageRequest" }, { "$ref": "#/components/schemas/MCPListRootsRequest" }, { "$ref": "#/components/schemas/MCPElicitRequest" } ] }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Inputrequests" }, "requestState": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Requeststate" }, "resultType": { "const": "input_required", "default": "input_required", "title": "Resulttype", "type": "string" } }, "title": "InputRequiredResult", "type": "object" }, "MCPListPromptsResult": { "description": "The server's response to a prompts/list request from the client.", "properties": { "_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" }, "cacheScope": { "default": "private", "enum": [ "public", "private" ], "title": "Cachescope", "type": "string" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Nextcursor" }, "prompts": { "items": { "$ref": "#/components/schemas/MCPPrompt" }, "title": "Prompts", "type": "array" }, "resultType": { "anyOf": [ { "enum": [ "complete", "input_required" ], "type": "string" }, { "type": "string" } ], "default": "complete", "title": "Resulttype" }, "ttlMs": { "default": 0, "minimum": 0, "title": "Ttlms", "type": "integer" } }, "required": [ "prompts" ], "title": "ListPromptsResult", "type": "object" }, "MCPListResourceTemplatesResult": { "description": "The server's response to a resources/templates/list request from the client.", "properties": { "_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" }, "cacheScope": { "default": "private", "enum": [ "public", "private" ], "title": "Cachescope", "type": "string" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Nextcursor" }, "resourceTemplates": { "items": { "$ref": "#/components/schemas/MCPResourceTemplate" }, "title": "Resourcetemplates", "type": "array" }, "resultType": { "anyOf": [ { "enum": [ "complete", "input_required" ], "type": "string" }, { "type": "string" } ], "default": "complete", "title": "Resulttype" }, "ttlMs": { "default": 0, "minimum": 0, "title": "Ttlms", "type": "integer" } }, "required": [ "resourceTemplates" ], "title": "ListResourceTemplatesResult", "type": "object" }, "MCPListResourcesResult": { "description": "The server's response to a resources/list request from the client.", "properties": { "_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" }, "cacheScope": { "default": "private", "enum": [ "public", "private" ], "title": "Cachescope", "type": "string" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Nextcursor" }, "resources": { "items": { "$ref": "#/components/schemas/MCPResource" }, "title": "Resources", "type": "array" }, "resultType": { "anyOf": [ { "enum": [ "complete", "input_required" ], "type": "string" }, { "type": "string" } ], "default": "complete", "title": "Resulttype" }, "ttlMs": { "default": 0, "minimum": 0, "title": "Ttlms", "type": "integer" } }, "required": [ "resources" ], "title": "ListResourcesResult", "type": "object" }, "MCPListRootsRequest": { "description": "Sent from the server to request a list of root URIs from the client. Roots allow\nservers to ask for specific directories or files to operate on. A common example\nfor roots is providing a set of repositories or directories a server should operate\non.\n\nThis request is typically used when the server needs to understand the file system\nstructure or access specific locations that the client has permission to read from.\n\nA standalone JSON-RPC request through 2025-11-25; on 2026-07-28 it is\nembedded in `InputRequiredResult.input_requests`. Deprecated in 2026-07-28 (SEP-2577).", "properties": { "method": { "const": "roots/list", "default": "roots/list", "title": "Method", "type": "string" }, "params": { "anyOf": [ { "$ref": "#/components/schemas/MCPRequestParams" }, { "type": "null" } ], "default": null } }, "title": "ListRootsRequest", "type": "object" }, "MCPListRootsResult": { "description": "The client's response to a roots/list request from the server.\n\nThis result contains an array of Root objects, each representing a root\ndirectory or file that the server can operate on.\n\nOn 2026-07-28 this is carried as an `InputResponses` entry, not a JSON-RPC\nresult. Deprecated in 2026-07-28 (SEP-2577).", "properties": { "_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" }, "roots": { "items": { "$ref": "#/components/schemas/MCPRoot" }, "title": "Roots", "type": "array" } }, "required": [ "roots" ], "title": "ListRootsResult", "type": "object" }, "MCPListToolsRequest": { "description": "Sent from the client to request a list of tools the server has.", "properties": { "method": { "const": "tools/list", "default": "tools/list", "title": "Method", "type": "string" }, "params": { "anyOf": [ { "$ref": "#/components/schemas/MCPPaginatedRequestParams" }, { "type": "null" } ], "default": null } }, "title": "ListToolsRequest", "type": "object" }, "MCPListToolsResult": { "description": "The server's response to a tools/list request from the client.", "properties": { "_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" }, "cacheScope": { "default": "private", "enum": [ "public", "private" ], "title": "Cachescope", "type": "string" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Nextcursor" }, "resultType": { "anyOf": [ { "enum": [ "complete", "input_required" ], "type": "string" }, { "type": "string" } ], "default": "complete", "title": "Resulttype" }, "tools": { "items": { "$ref": "#/components/schemas/MCPTool" }, "title": "Tools", "type": "array" }, "ttlMs": { "default": 0, "minimum": 0, "title": "Ttlms", "type": "integer" } }, "required": [ "tools" ], "title": "ListToolsResult", "type": "object" }, "MCPLoggingCapability": { "description": "Capability for logging operations.", "properties": {}, "title": "LoggingCapability", "type": "object" }, "MCPModelHint": { "description": "Hints to use for model selection.\n\nKeys not declared here are up to the client to interpret. Deprecated in\n2026-07-28 (SEP-2577) with the rest of sampling.", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" } }, "title": "ModelHint", "type": "object" }, "MCPModelPreferences": { "description": "The server's preferences for model selection, requested of the client during\nsampling.\n\nBecause LLMs can vary along multiple dimensions, choosing the \"best\" model is\nrarely straightforward. Different models excel in different areas—some are\nfaster but less capable, others are more capable but more expensive, and so\non. This interface allows servers to express their priorities across multiple\ndimensions to help clients make an appropriate selection for their use case.\n\nThese preferences are always advisory. The client MAY ignore them. It is also\nup to the client to decide how to interpret these preferences and how to\nbalance them against other considerations.\n\nDeprecated in 2026-07-28 (SEP-2577) with the rest of sampling.", "properties": { "costPriority": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Costpriority" }, "hints": { "anyOf": [ { "items": { "$ref": "#/components/schemas/MCPModelHint" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Hints" }, "intelligencePriority": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Intelligencepriority" }, "speedPriority": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Speedpriority" } }, "title": "ModelPreferences", "type": "object" }, "MCPNotificationParams": { "properties": { "_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" } }, "title": "NotificationParams", "type": "object" }, "MCPPaginatedRequestParams": { "properties": { "_meta": { "anyOf": [ { "$ref": "#/components/schemas/MCPRequestParamsMeta" }, { "type": "null" } ], "default": null }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" } }, "title": "PaginatedRequestParams", "type": "object" }, "MCPPingRequest": { "description": "A ping, issued by either the server or the client, to check that the other party is\nstill alive. The receiver must promptly respond, or else may be disconnected.\n\nRemoved in protocol 2026-07-28; sent/received on sessions negotiating <= 2025-11-25.", "properties": { "method": { "const": "ping", "default": "ping", "title": "Method", "type": "string" }, "params": { "anyOf": [ { "$ref": "#/components/schemas/MCPRequestParams" }, { "type": "null" } ], "default": null } }, "title": "PingRequest", "type": "object" }, "MCPProgressNotification": { "description": "An out-of-band notification used to inform the receiver of a progress update for a long-running request.", "properties": { "method": { "const": "notifications/progress", "default": "notifications/progress", "title": "Method", "type": "string" }, "params": { "$ref": "#/components/schemas/MCPProgressNotificationParams" } }, "required": [ "params" ], "title": "ProgressNotification", "type": "object" }, "MCPProgressNotificationParams": { "description": "Parameters for progress notifications.", "properties": { "_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Message" }, "progress": { "title": "Progress", "type": "number" }, "progressToken": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "title": "Progresstoken" }, "total": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Total" } }, "required": [ "progressToken", "progress" ], "title": "ProgressNotificationParams", "type": "object" }, "MCPPrompt": { "description": "A prompt or prompt template that the server offers.", "properties": { "_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" }, "arguments": { "anyOf": [ { "items": { "$ref": "#/components/schemas/MCPPromptArgument" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Arguments" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "icons": { "anyOf": [ { "items": { "$ref": "#/components/schemas/MCPIcon" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Icons" }, "name": { "title": "Name", "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Title" } }, "required": [ "name" ], "title": "Prompt", "type": "object" }, "MCPPromptArgument": { "description": "Describes an argument that a prompt can accept.", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "name": { "title": "Name", "type": "string" }, "required": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Required" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Title" } }, "required": [ "name" ], "title": "PromptArgument", "type": "object" }, "MCPPromptMessage": { "description": "Describes a message returned as part of a prompt.\n\nSimilar to `SamplingMessage`, but also supports embedded resources.", "properties": { "content": { "anyOf": [ { "$ref": "#/components/schemas/MCPTextContent" }, { "$ref": "#/components/schemas/MCPImageContent" }, { "$ref": "#/components/schemas/MCPAudioContent" }, { "$ref": "#/components/schemas/MCPResourceLink" }, { "$ref": "#/components/schemas/MCPEmbeddedResource" } ], "title": "Content" }, "role": { "enum": [ "user", "assistant" ], "title": "Role", "type": "string" } }, "required": [ "role", "content" ], "title": "PromptMessage", "type": "object" }, "MCPPromptsCapability": { "description": "Capability for prompts operations.", "properties": { "listChanged": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Listchanged" } }, "title": "PromptsCapability", "type": "object" }, "MCPReadResourceResult": { "description": "The server's response to a resources/read request from the client.", "properties": { "_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" }, "cacheScope": { "default": "private", "enum": [ "public", "private" ], "title": "Cachescope", "type": "string" }, "contents": { "items": { "anyOf": [ { "$ref": "#/components/schemas/MCPTextResourceContents" }, { "$ref": "#/components/schemas/MCPBlobResourceContents" } ] }, "title": "Contents", "type": "array" }, "resultType": { "anyOf": [ { "enum": [ "complete", "input_required" ], "type": "string" }, { "type": "string" } ], "default": "complete", "title": "Resulttype" }, "ttlMs": { "default": 0, "minimum": 0, "title": "Ttlms", "type": "integer" } }, "required": [ "contents" ], "title": "ReadResourceResult", "type": "object" }, "MCPRequestParams": { "properties": { "_meta": { "anyOf": [ { "$ref": "#/components/schemas/MCPRequestParamsMeta" }, { "type": "null" } ], "default": null } }, "title": "RequestParams", "type": "object" }, "MCPRequestParamsMeta": { "additionalProperties": true, "description": "The `_meta` object on request params (schema name: `RequestMetaObject`).\n\nAn open map: arbitrary keys round-trip via `extra_items=Any`. Read or set\nthe reserved `io.modelcontextprotocol/*` keys via the `*_META_KEY` constants.", "properties": { "progressToken": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "title": "Progresstoken" } }, "title": "RequestParamsMeta", "type": "object" }, "MCPResource": { "description": "A known resource that the server is capable of reading.", "properties": { "_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" }, "annotations": { "anyOf": [ { "$ref": "#/components/schemas/MCPAnnotations" }, { "type": "null" } ], "default": null }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "icons": { "anyOf": [ { "items": { "$ref": "#/components/schemas/MCPIcon" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Icons" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Mimetype" }, "name": { "title": "Name", "type": "string" }, "size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Size" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Title" }, "uri": { "title": "Uri", "type": "string" } }, "required": [ "name", "uri" ], "title": "Resource", "type": "object" }, "MCPResourceLink": { "description": "A resource that the server is capable of reading, included in a prompt or tool call result.\n\nNote: resource links returned by tools are not guaranteed to appear in the results of `resources/list` requests.", "properties": { "_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" }, "annotations": { "anyOf": [ { "$ref": "#/components/schemas/MCPAnnotations" }, { "type": "null" } ], "default": null }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "icons": { "anyOf": [ { "items": { "$ref": "#/components/schemas/MCPIcon" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Icons" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Mimetype" }, "name": { "title": "Name", "type": "string" }, "size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Size" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Title" }, "type": { "const": "resource_link", "default": "resource_link", "title": "Type", "type": "string" }, "uri": { "title": "Uri", "type": "string" } }, "required": [ "name", "uri" ], "title": "ResourceLink", "type": "object" }, "MCPResourceTemplate": { "description": "A template description for resources available on the server.", "properties": { "_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" }, "annotations": { "anyOf": [ { "$ref": "#/components/schemas/MCPAnnotations" }, { "type": "null" } ], "default": null }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "icons": { "anyOf": [ { "items": { "$ref": "#/components/schemas/MCPIcon" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Icons" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Mimetype" }, "name": { "title": "Name", "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Title" }, "uriTemplate": { "title": "Uritemplate", "type": "string" } }, "required": [ "name", "uriTemplate" ], "title": "ResourceTemplate", "type": "object" }, "MCPResourcesCapability": { "description": "Capability for resources operations.", "properties": { "listChanged": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Listchanged" }, "subscribe": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Subscribe" } }, "title": "ResourcesCapability", "type": "object" }, "MCPRoot": { "description": "Represents a root directory or file that the server can operate on.\n\nDeprecated in 2026-07-28 (SEP-2577) with the rest of roots.", "properties": { "_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "uri": { "format": "uri", "minLength": 1, "title": "Uri", "type": "string" } }, "required": [ "uri" ], "title": "Root", "type": "object" }, "MCPRootsCapability": { "description": "Capability for root operations.\n\nDeprecated in protocol 2026-07-28 (SEP-2577) but still carried there as an\nempty object (`list_changed` exists only through 2025-11-25).", "properties": { "listChanged": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Listchanged" } }, "title": "RootsCapability", "type": "object" }, "MCPRootsListChangedNotification": { "description": "A notification from the client to the server, informing it that the list of\nroots has changed.\n\nThis notification should be sent whenever the client adds, removes, or\nmodifies any root. The server should then request an updated list of roots\nusing the ListRootsRequest.\n\nRemoved in protocol 2026-07-28; sent/received on sessions negotiating <= 2025-11-25.", "properties": { "method": { "const": "notifications/roots/list_changed", "default": "notifications/roots/list_changed", "title": "Method", "type": "string" }, "params": { "anyOf": [ { "$ref": "#/components/schemas/MCPNotificationParams" }, { "type": "null" } ], "default": null } }, "title": "RootsListChangedNotification", "type": "object" }, "MCPSamplingCapability": { "description": "Sampling capability structure. Deprecated in 2026-07-28 (SEP-2577); shape unchanged.", "properties": { "context": { "anyOf": [ { "$ref": "#/components/schemas/MCPSamplingContextCapability" }, { "type": "null" } ], "default": null }, "tools": { "anyOf": [ { "$ref": "#/components/schemas/MCPSamplingToolsCapability" }, { "type": "null" } ], "default": null } }, "title": "SamplingCapability", "type": "object" }, "MCPSamplingContextCapability": { "description": "Capability for context inclusion during sampling.\n\nIndicates support for non-'none' values in the includeContext parameter.\nSOFT-DEPRECATED: New implementations should use tools parameter instead.", "properties": {}, "title": "SamplingContextCapability", "type": "object" }, "MCPSamplingMessage": { "description": "Describes a message issued to or received from an LLM API.", "properties": { "_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" }, "content": { "anyOf": [ { "$ref": "#/components/schemas/MCPTextContent" }, { "$ref": "#/components/schemas/MCPImageContent" }, { "$ref": "#/components/schemas/MCPAudioContent" }, { "$ref": "#/components/schemas/MCPToolUseContent" }, { "$ref": "#/components/schemas/MCPToolResultContent" }, { "items": { "anyOf": [ { "$ref": "#/components/schemas/MCPTextContent" }, { "$ref": "#/components/schemas/MCPImageContent" }, { "$ref": "#/components/schemas/MCPAudioContent" }, { "$ref": "#/components/schemas/MCPToolUseContent" }, { "$ref": "#/components/schemas/MCPToolResultContent" } ] }, "type": "array" } ], "title": "Content" }, "role": { "enum": [ "user", "assistant" ], "title": "Role", "type": "string" } }, "required": [ "role", "content" ], "title": "SamplingMessage", "type": "object" }, "MCPSamplingToolsCapability": { "description": "Capability indicating support for tool calling during sampling.\n\nWhen present in ClientCapabilities.sampling, indicates that the client\nsupports the tools and toolChoice parameters in sampling requests.", "properties": {}, "title": "SamplingToolsCapability", "type": "object" }, "MCPServer": { "additionalProperties": true, "description": "One registered remote MCP server.\n\n``MCPRegistryService._view`` returns the stored document minus its private\nkeys, so the fields and their order are the document's own.", "properties": { "created_at": { "title": "Created At", "type": "string" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "enabled": { "title": "Enabled", "type": "boolean" }, "mcp_server_id": { "title": "Mcp Server Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "org_id": { "title": "Org Id", "type": "string" }, "transport": { "title": "Transport", "type": "string" }, "updated_at": { "title": "Updated At", "type": "string" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated By" }, "url": { "title": "Url", "type": "string" } }, "required": [ "mcp_server_id", "created_at", "updated_at", "org_id", "name", "description", "url", "transport", "enabled", "created_by", "updated_by" ], "title": "MCPServer", "type": "object" }, "MCPServerCapabilities": { "description": "Capabilities that a server may support. Not a closed set.", "properties": { "completions": { "anyOf": [ { "$ref": "#/components/schemas/MCPCompletionsCapability" }, { "type": "null" } ], "default": null }, "experimental": { "anyOf": [ { "additionalProperties": { "additionalProperties": true, "type": "object" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Experimental" }, "extensions": { "anyOf": [ { "additionalProperties": { "additionalProperties": true, "type": "object" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Extensions" }, "logging": { "anyOf": [ { "$ref": "#/components/schemas/MCPLoggingCapability" }, { "type": "null" } ], "default": null }, "prompts": { "anyOf": [ { "$ref": "#/components/schemas/MCPPromptsCapability" }, { "type": "null" } ], "default": null }, "resources": { "anyOf": [ { "$ref": "#/components/schemas/MCPResourcesCapability" }, { "type": "null" } ], "default": null }, "tasks": { "anyOf": [ { "$ref": "#/components/schemas/MCPServerTasksCapability" }, { "type": "null" } ], "default": null }, "tools": { "anyOf": [ { "$ref": "#/components/schemas/MCPToolsCapability" }, { "type": "null" } ], "default": null } }, "title": "ServerCapabilities", "type": "object" }, "MCPServerList": { "additionalProperties": true, "description": "Every MCP server registered in the organization.", "properties": { "mcp_servers": { "items": { "$ref": "#/components/schemas/MCPServer" }, "title": "Mcp Servers", "type": "array" } }, "required": [ "mcp_servers" ], "title": "MCPServerList", "type": "object" }, "MCPServerResult": { "anyOf": [ { "$ref": "#/components/schemas/MCPEmptyResult" }, { "$ref": "#/components/schemas/MCPInitializeResult" }, { "$ref": "#/components/schemas/MCPDiscoverResult" }, { "$ref": "#/components/schemas/MCPCompleteResult" }, { "$ref": "#/components/schemas/MCPGetPromptResult" }, { "$ref": "#/components/schemas/MCPListPromptsResult" }, { "$ref": "#/components/schemas/MCPListResourcesResult" }, { "$ref": "#/components/schemas/MCPListResourceTemplatesResult" }, { "$ref": "#/components/schemas/MCPReadResourceResult" }, { "$ref": "#/components/schemas/MCPCallToolResult" }, { "$ref": "#/components/schemas/MCPListToolsResult" }, { "$ref": "#/components/schemas/MCPSubscriptionsListenResult" }, { "$ref": "#/components/schemas/MCPInputRequiredResult" } ] }, "MCPServerTasksCapability": { "description": "Capability for server tasks operations (2025-11-25 only).", "properties": { "cancel": { "anyOf": [ { "$ref": "#/components/schemas/MCPTasksCancelCapability" }, { "type": "null" } ], "default": null }, "list": { "anyOf": [ { "$ref": "#/components/schemas/MCPTasksListCapability" }, { "type": "null" } ], "default": null }, "requests": { "anyOf": [ { "$ref": "#/components/schemas/MCPServerTasksRequestsCapability" }, { "type": "null" } ], "default": null } }, "title": "ServerTasksCapability", "type": "object" }, "MCPServerTasksRequestsCapability": { "description": "Specifies which request types the server can augment with tasks (2025-11-25 only).", "properties": { "tools": { "anyOf": [ { "$ref": "#/components/schemas/MCPTasksToolsCapability" }, { "type": "null" } ], "default": null } }, "title": "ServerTasksRequestsCapability", "type": "object" }, "MCPSubscriptionsListenResult": { "description": "Signals that a `subscriptions/listen` stream has ended gracefully (2026-07-28).\n\nBecause the listen stream is long-lived, this result is sent only when the\nserver tears the subscription down (for example during shutdown); an abrupt\ntransport close carries no response. The body is otherwise empty: the\n`_meta[\"io.modelcontextprotocol/subscriptionId\"]` key is required on the\nwire and equals the JSON-RPC id of the originating `subscriptions/listen`\nrequest.", "properties": { "_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" }, "resultType": { "anyOf": [ { "enum": [ "complete", "input_required" ], "type": "string" }, { "type": "string" } ], "default": "complete", "title": "Resulttype" } }, "title": "SubscriptionsListenResult", "type": "object" }, "MCPTaskMetadata": { "description": "Metadata for augmenting a request with task execution (the `task` params field; 2025-11-25 only).", "properties": { "ttl": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Ttl" } }, "title": "TaskMetadata", "type": "object" }, "MCPTasksCallCapability": { "description": "Capability for task-augmented tools/call requests (2025-11-25 only).", "properties": {}, "title": "TasksCallCapability", "type": "object" }, "MCPTasksCancelCapability": { "description": "Capability for tasks cancel operations (2025-11-25 only).", "properties": {}, "title": "TasksCancelCapability", "type": "object" }, "MCPTasksCreateElicitationCapability": { "description": "Capability for task-augmented elicitation/create requests (2025-11-25 only).", "properties": {}, "title": "TasksCreateElicitationCapability", "type": "object" }, "MCPTasksCreateMessageCapability": { "description": "Capability for task-augmented sampling/createMessage requests (2025-11-25 only).", "properties": {}, "title": "TasksCreateMessageCapability", "type": "object" }, "MCPTasksElicitationCapability": { "description": "Capability for task-augmented elicitation operations (2025-11-25 only).", "properties": { "create": { "anyOf": [ { "$ref": "#/components/schemas/MCPTasksCreateElicitationCapability" }, { "type": "null" } ], "default": null } }, "title": "TasksElicitationCapability", "type": "object" }, "MCPTasksListCapability": { "description": "Capability for tasks listing operations (2025-11-25 only).", "properties": {}, "title": "TasksListCapability", "type": "object" }, "MCPTasksSamplingCapability": { "description": "Capability for task-augmented sampling operations (2025-11-25 only).", "properties": { "createMessage": { "anyOf": [ { "$ref": "#/components/schemas/MCPTasksCreateMessageCapability" }, { "type": "null" } ], "default": null } }, "title": "TasksSamplingCapability", "type": "object" }, "MCPTasksToolsCapability": { "description": "Capability for task-augmented tool operations (2025-11-25 only).", "properties": { "call": { "anyOf": [ { "$ref": "#/components/schemas/MCPTasksCallCapability" }, { "type": "null" } ], "default": null } }, "title": "TasksToolsCapability", "type": "object" }, "MCPTextContent": { "description": "Text provided to or from an LLM.", "properties": { "_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" }, "annotations": { "anyOf": [ { "$ref": "#/components/schemas/MCPAnnotations" }, { "type": "null" } ], "default": null }, "text": { "title": "Text", "type": "string" }, "type": { "const": "text", "default": "text", "title": "Type", "type": "string" } }, "required": [ "text" ], "title": "TextContent", "type": "object" }, "MCPTextResourceContents": { "description": "Text contents of a resource.", "properties": { "_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Mimetype" }, "text": { "title": "Text", "type": "string" }, "uri": { "title": "Uri", "type": "string" } }, "required": [ "uri", "text" ], "title": "TextResourceContents", "type": "object" }, "MCPTool": { "description": "Definition for a tool the client can call.", "properties": { "_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" }, "annotations": { "anyOf": [ { "$ref": "#/components/schemas/MCPToolAnnotations" }, { "type": "null" } ], "default": null }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "execution": { "anyOf": [ { "$ref": "#/components/schemas/MCPToolExecution" }, { "type": "null" } ], "default": null }, "icons": { "anyOf": [ { "items": { "$ref": "#/components/schemas/MCPIcon" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Icons" }, "inputSchema": { "additionalProperties": true, "title": "Inputschema", "type": "object" }, "name": { "title": "Name", "type": "string" }, "outputSchema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Outputschema" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Title" } }, "required": [ "name", "inputSchema" ], "title": "Tool", "type": "object" }, "MCPToolAnnotations": { "description": "Additional properties describing a Tool to clients.\n\nNOTE: all properties in ToolAnnotations are **hints**.\nThey are not guaranteed to provide a faithful description of\ntool behavior (including descriptive properties like `title`).\n\nClients should never make tool use decisions based on ToolAnnotations\nreceived from untrusted servers.", "properties": { "destructiveHint": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Destructivehint" }, "idempotentHint": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Idempotenthint" }, "openWorldHint": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Openworldhint" }, "readOnlyHint": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Readonlyhint" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Title" } }, "title": "ToolAnnotations", "type": "object" }, "MCPToolChoice": { "description": "Controls tool selection behavior for sampling requests (2025-11-25+).\n\nThe client MUST return an error if this is received without the\n`sampling.tools` capability. Absent means `{\"mode\": \"auto\"}`.", "properties": { "mode": { "anyOf": [ { "enum": [ "auto", "required", "none" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Mode" } }, "title": "ToolChoice", "type": "object" }, "MCPToolExecution": { "description": "Execution-related properties for a tool (2025-11-25 only).", "properties": { "taskSupport": { "anyOf": [ { "enum": [ "forbidden", "optional", "required" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Tasksupport" } }, "title": "ToolExecution", "type": "object" }, "MCPToolResultContent": { "description": "The result of a tool use, provided by the user back to the assistant (2025-11-25+).\n\nAppears in sampling messages as a response to a `ToolUseContent` block.\nRequires the `sampling.tools` client capability. Deprecated in 2026-07-28 (SEP-2577).", "properties": { "_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" }, "content": { "default": [], "items": { "anyOf": [ { "$ref": "#/components/schemas/MCPTextContent" }, { "$ref": "#/components/schemas/MCPImageContent" }, { "$ref": "#/components/schemas/MCPAudioContent" }, { "$ref": "#/components/schemas/MCPResourceLink" }, { "$ref": "#/components/schemas/MCPEmbeddedResource" } ] }, "title": "Content", "type": "array" }, "isError": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Iserror" }, "structuredContent": { "default": null, "title": "Structuredcontent" }, "toolUseId": { "title": "Tooluseid", "type": "string" }, "type": { "const": "tool_result", "default": "tool_result", "title": "Type", "type": "string" } }, "required": [ "toolUseId" ], "title": "ToolResultContent", "type": "object" }, "MCPToolUseContent": { "description": "An assistant's request to invoke a tool during sampling (2025-11-25+).\n\nAppears in `sampling/createMessage` results and replayed assistant messages.\nThe server should execute the tool and return a `ToolResultContent` in the\nnext user message. Deprecated in 2026-07-28 (SEP-2577).", "properties": { "_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" }, "id": { "title": "Id", "type": "string" }, "input": { "additionalProperties": true, "title": "Input", "type": "object" }, "name": { "title": "Name", "type": "string" }, "type": { "const": "tool_use", "default": "tool_use", "title": "Type", "type": "string" } }, "required": [ "name", "id", "input" ], "title": "ToolUseContent", "type": "object" }, "MCPToolsCapability": { "description": "Capability for tools operations.", "properties": { "listChanged": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Listchanged" } }, "title": "ToolsCapability", "type": "object" }, "MCPUrlElicitationCapability": { "description": "Capability for URL mode elicitation (2025-11-25+).", "properties": {}, "title": "UrlElicitationCapability", "type": "object" }, "MkdirSessionFilesRequest": { "description": "Body for ``POST /sessions/{id}/files/mkdir``.", "properties": { "path": { "title": "Path", "type": "string" } }, "required": [ "path" ], "title": "MkdirSessionFilesRequest", "type": "object" }, "MoveSessionFilesRequest": { "description": "Body for ``POST /sessions/{id}/files/move``.", "properties": { "dest_path": { "title": "Dest Path", "type": "string" }, "src_path": { "title": "Src Path", "type": "string" } }, "required": [ "src_path", "dest_path" ], "title": "MoveSessionFilesRequest", "type": "object" }, "NativeStateInitialization": { "additionalProperties": false, "description": "The allocation whose unpublished profile is being recovered.", "properties": { "recovery_owner": { "minLength": 1, "title": "Recovery Owner", "type": "string" }, "sandbox_generation": { "minLength": 1, "title": "Sandbox Generation", "type": "string" }, "sandbox_id": { "minLength": 1, "title": "Sandbox Id", "type": "string" }, "session_id": { "minLength": 1, "title": "Session Id", "type": "string" } }, "required": [ "session_id", "recovery_owner", "sandbox_generation", "sandbox_id" ], "title": "NativeStateInitialization", "type": "object" }, "PerformUserAction": { "additionalProperties": false, "properties": { "action_id": { "maxLength": 128, "minLength": 1, "title": "Action Id", "type": "string" } }, "required": [ "action_id" ], "title": "PerformUserAction", "type": "object" }, "PermissionModeUpdate": { "additionalProperties": true, "description": "The outcome of setting a session's permission mode.\n\n``applied`` reports whether the running engine took the new mode, not\nwhether the request was accepted: a session with no live runtime records\nthe mode and answers ``false``.", "properties": { "applied": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Applied" }, "changed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Changed" }, "event_seq": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Event Seq" }, "permission_mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Permission Mode" }, "previous_permission_mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous Permission Mode" }, "runtime_applied": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Runtime Applied" }, "session_id": { "title": "Session Id", "type": "string" } }, "required": [ "session_id" ], "title": "PermissionModeUpdate", "type": "object" }, "PersonalScheduleCreate": { "additionalProperties": false, "description": "The owner and execution identity come only from the authenticated request.", "properties": { "agent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agent Id" }, "name": { "title": "Name", "type": "string" }, "prompt_prefix": { "title": "Prompt Prefix", "type": "string" }, "schedule": { "additionalProperties": true, "title": "Schedule", "type": "object" }, "source_assistant_id": { "title": "Source Assistant Id", "type": "string" } }, "required": [ "source_assistant_id", "name", "prompt_prefix", "schedule" ], "title": "PersonalScheduleCreate", "type": "object" }, "PreviewSessionFileRequest": { "properties": { "path": { "title": "Path", "type": "string" } }, "required": [ "path" ], "title": "PreviewSessionFileRequest", "type": "object" }, "ProcessSummaryState": { "additionalProperties": false, "description": "The generated label for one response's folded work.\n\n``status`` is ``generating`` while a writer holds the claim, ``completed``\nonce the label exists, and ``failed`` when the model call did not produce\none — a failed label can be asked for again with ``retry=true``.\n``disabled`` means label generation is switched off, not a failed request.\n``response_completed`` distinguishes work that ran to an answer from work\nthat stopped short.", "properties": { "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "response_completed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Response Completed" }, "status": { "title": "Status", "type": "string" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Summary" } }, "required": [ "status" ], "title": "ProcessSummaryState", "type": "object" }, "ResponseView": { "additionalProperties": false, "description": "A response the runtime produced, as its reader recorded it.\n\n``status`` is ``running``, ``waiting`` or ``ended``; ``outcome`` is\n``completed``, ``failed`` or ``cancelled`` once ended, and\n``native_reason`` is the engine's own word for the ending, carried\nverbatim.", "properties": { "ended_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ended At" }, "error": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Error" }, "native_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Native Reason" }, "origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Origin" }, "outcome": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Outcome" }, "response_id": { "title": "Response Id", "type": "string" }, "started_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Started At" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, "required": [ "response_id" ], "title": "ResponseView", "type": "object" }, "RuntimeStateLoadRequest": { "additionalProperties": false, "properties": { "owner": { "$ref": "#/components/schemas/RuntimeStateOwnerPayload" } }, "required": [ "owner" ], "title": "RuntimeStateLoadRequest", "type": "object" }, "RuntimeStateLoadResult": { "additionalProperties": true, "properties": { "payload_b64": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Payload B64" }, "sha256": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sha256" }, "size": { "title": "Size", "type": "integer" }, "snapshot_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Snapshot Id" } }, "required": [ "snapshot_id", "payload_b64", "sha256", "size" ], "title": "RuntimeStateLoadResult", "type": "object" }, "RuntimeStateOwnerPayload": { "additionalProperties": false, "description": "The platform-issued owner of a native runtime profile.", "properties": { "engine_kind": { "minLength": 1, "title": "Engine Kind", "type": "string" }, "subject_id": { "minLength": 1, "title": "Subject Id", "type": "string" }, "subject_kind": { "enum": [ "assistant", "agent", "session" ], "title": "Subject Kind", "type": "string" }, "user_id": { "minLength": 1, "title": "User Id", "type": "string" } }, "required": [ "user_id", "subject_kind", "subject_id", "engine_kind" ], "title": "RuntimeStateOwnerPayload", "type": "object" }, "RuntimeStateSaveRequest": { "additionalProperties": false, "properties": { "expected_snapshot_id": { "anyOf": [ { "pattern": "^[0-9a-f]{64}$", "type": "string" }, { "type": "null" } ], "title": "Expected Snapshot Id" }, "initialization": { "anyOf": [ { "$ref": "#/components/schemas/NativeStateInitialization" }, { "type": "null" } ] }, "owner": { "$ref": "#/components/schemas/RuntimeStateOwnerPayload" }, "payload_b64": { "title": "Payload B64", "type": "string" }, "sha256": { "maxLength": 64, "minLength": 64, "title": "Sha256", "type": "string" } }, "required": [ "owner", "payload_b64", "sha256", "expected_snapshot_id" ], "title": "RuntimeStateSaveRequest", "type": "object" }, "RuntimeStateSaveResult": { "additionalProperties": true, "properties": { "snapshot_id": { "title": "Snapshot Id", "type": "string" } }, "required": [ "snapshot_id" ], "title": "RuntimeStateSaveResult", "type": "object" }, "SandboxCallbackResult": { "additionalProperties": true, "description": "The disposition of one control-plane callback.\n\n``handled`` false carries ``ignored`` naming why — a callback for an unknown\nsession, or one fenced out by a newer sandbox generation. ``handled`` true\ncarries the subject it applied to and the status it applied. The fields of\nthe arm that did not run are absent rather than null, so a caller reads the\noutcome from which keys are present.", "properties": { "handled": { "title": "Handled", "type": "boolean" }, "ignored": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ignored" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "subject_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subject Id" }, "subject_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subject Type" } }, "required": [ "handled" ], "title": "SandboxCallbackResult", "type": "object" }, "SandboxTerminatingResult": { "additionalProperties": true, "description": "Which Session projections converged, and which were expected to pause.\n\nAgent and Assistant-workspace owners are converged by the same operation but\nare not exposed in this in-box compatibility response. A notice is always\n``handled``: a box with no owner is normal for unclaimed prepared capacity.\n``ignored`` maps a Session id to the planned pause that preserved its box.", "properties": { "converged": { "items": { "type": "string" }, "title": "Converged", "type": "array" }, "handled": { "title": "Handled", "type": "boolean" }, "ignored": { "additionalProperties": { "type": "string" }, "title": "Ignored", "type": "object" } }, "required": [ "handled", "converged", "ignored" ], "title": "SandboxTerminatingResult", "type": "object" }, "SandboxTermination": { "additionalProperties": true, "description": "The outcome of reclaiming a session's sandbox.\n\nThe conversation survives — history is durable and the next turn rebuilds a\nsandbox. ``killed`` distinguishes a sandbox this call destroyed from one\nthat was already gone.", "properties": { "killed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Killed" }, "sandbox_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sandbox Id" }, "session_id": { "title": "Session Id", "type": "string" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, "required": [ "session_id" ], "title": "SandboxTermination", "type": "object" }, "SessionArchival": { "additionalProperties": true, "description": "Confirmation that a session was archived.\n\nArchiving terminates the sandbox as well, so the fields of\n:class:`SandboxTermination` accompany the archive flag.", "properties": { "archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Archived" }, "killed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Killed" }, "sandbox_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sandbox Id" }, "session_id": { "title": "Session Id", "type": "string" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, "required": [ "session_id" ], "title": "SessionArchival", "type": "object" }, "SessionBrowserAccess": { "additionalProperties": true, "properties": { "expires_at": { "title": "Expires At", "type": "string" }, "url": { "title": "Url", "type": "string" } }, "required": [ "url", "expires_at" ], "title": "SessionBrowserAccess", "type": "object" }, "SessionChildRunPage": { "additionalProperties": false, "description": "All child runs visible in one Session, in tree order.", "properties": { "child_runs": { "items": { "$ref": "#/components/schemas/ChildRunRecord" }, "title": "Child Runs", "type": "array" }, "session_id": { "title": "Session Id", "type": "string" } }, "required": [ "session_id", "child_runs" ], "title": "SessionChildRunPage", "type": "object" }, "SessionDeletion": { "additionalProperties": true, "description": "Confirmation that a session was soft-deleted. Deletion is final.", "properties": { "deleted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Deleted" }, "killed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Killed" }, "sandbox_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sandbox Id" }, "session_id": { "title": "Session Id", "type": "string" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, "required": [ "session_id" ], "title": "SessionDeletion", "type": "object" }, "SessionDirectoryCreated": { "additionalProperties": true, "description": "The created directory, addressed both as a location and as a target.", "properties": { "current_path": { "title": "Current Path", "type": "string" }, "parent_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Path" }, "path": { "title": "Path", "type": "string" }, "root_path": { "title": "Root Path", "type": "string" } }, "required": [ "root_path", "current_path", "parent_path", "path" ], "title": "SessionDirectoryCreated", "type": "object" }, "SessionFileChangeResponse": { "additionalProperties": false, "description": "One ended response and every file change it made; empty when it changed none.", "properties": { "parts": { "items": { "additionalProperties": true, "type": "object" }, "title": "Parts", "type": "array" }, "response_id": { "title": "Response Id", "type": "string" } }, "required": [ "response_id", "parts" ], "title": "SessionFileChangeResponse", "type": "object" }, "SessionFileChanges": { "additionalProperties": false, "description": "The responses that ended after ``after_seq``, through ``through_seq``.\n\n``through_seq`` is the next ``after_seq``. Each response replaces what a\nreader held for it.", "properties": { "responses": { "items": { "$ref": "#/components/schemas/SessionFileChangeResponse" }, "title": "Responses", "type": "array" }, "through_seq": { "title": "Through Seq", "type": "integer" } }, "required": [ "through_seq", "responses" ], "title": "SessionFileChanges", "type": "object" }, "SessionFileEntry": { "additionalProperties": true, "description": "One directory member.\n\n``size`` and ``modified_at`` come from the sandbox's directory listing, so\nonly a listing carries them; the entries an upload echoes back name what was\nwritten and nothing else. Both stay optional here so the upload answer keeps\nthe same entry shape without inventing a size it never measured.", "properties": { "kind": { "enum": [ "file", "directory" ], "title": "Kind", "type": "string" }, "modified_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Modified At" }, "name": { "title": "Name", "type": "string" }, "path": { "title": "Path", "type": "string" }, "size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Size" } }, "required": [ "path", "name", "kind" ], "title": "SessionFileEntry", "type": "object" }, "SessionFileListing": { "additionalProperties": true, "description": "A directory read: where the panel is, and what is in it.\n\n``parent_path`` is null at the session root — the panel's \"up\" control is\nthat value's presence, not a comparison it re-derives.", "properties": { "current_path": { "title": "Current Path", "type": "string" }, "entries": { "items": { "$ref": "#/components/schemas/SessionFileEntry" }, "title": "Entries", "type": "array" }, "parent_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Path" }, "root_path": { "title": "Root Path", "type": "string" }, "session_kind": { "title": "Session Kind", "type": "string" } }, "required": [ "root_path", "current_path", "parent_path", "entries", "session_kind" ], "title": "SessionFileListing", "type": "object" }, "SessionFileMoved": { "additionalProperties": true, "description": "Source and destination, resolved to absolute paths inside the root.", "properties": { "dest_path": { "title": "Dest Path", "type": "string" }, "root_path": { "title": "Root Path", "type": "string" }, "src_path": { "title": "Src Path", "type": "string" } }, "required": [ "root_path", "src_path", "dest_path" ], "title": "SessionFileMoved", "type": "object" }, "SessionFilePreview": { "additionalProperties": true, "description": "An expiring bearer URL for a file and its workspace-relative resources.", "properties": { "expires_at": { "title": "Expires At", "type": "string" }, "url": { "title": "Url", "type": "string" } }, "required": [ "url", "expires_at" ], "title": "SessionFilePreview", "type": "object" }, "SessionFileUploadResult": { "additionalProperties": true, "description": "What an upload wrote, in the directory it wrote to.", "properties": { "current_path": { "title": "Current Path", "type": "string" }, "entries": { "items": { "$ref": "#/components/schemas/SessionFileEntry" }, "title": "Entries", "type": "array" }, "parent_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Path" }, "root_path": { "title": "Root Path", "type": "string" }, "uploaded_count": { "title": "Uploaded Count", "type": "integer" } }, "required": [ "root_path", "current_path", "parent_path", "entries", "uploaded_count" ], "title": "SessionFileUploadResult", "type": "object" }, "SessionFilesDeleted": { "additionalProperties": true, "description": "The requested paths, and how many of them existed to be removed.\n\n``deleted_count`` is below ``len(paths)`` when a path was already absent:\ndeletion converges, so a retry after a lost response still answers 200.", "properties": { "deleted_count": { "title": "Deleted Count", "type": "integer" }, "paths": { "items": { "type": "string" }, "title": "Paths", "type": "array" }, "root_path": { "title": "Root Path", "type": "string" } }, "required": [ "root_path", "paths", "deleted_count" ], "title": "SessionFilesDeleted", "type": "object" }, "SessionHistoryBlockDetails": { "additionalProperties": false, "description": "The parts one folded ``data-process-block`` header stands for.\n\nOne message carrying the folded parts in their original order.\n``has_more`` is always ``false``: a header's contents are whole, and there\nis nothing further to page through.", "properties": { "has_more": { "title": "Has More", "type": "boolean" }, "messages": { "items": { "additionalProperties": true, "type": "object" }, "title": "Messages", "type": "array" } }, "required": [ "messages", "has_more" ], "title": "SessionHistoryBlockDetails", "type": "object" }, "SessionHistoryBlockPage": { "additionalProperties": false, "description": "One page of the conversation with each ended response's work folded.\n\nThe messages of :class:`SessionMessagePage`, where the work of a response\nthat had ended is replaced by ``data-process-block`` parts that\n:class:`SessionHistoryBlockDetails` reopens. ``next_cursor`` is what to send\nback as ``before``; it pins every older page to the output position the\nfirst page was read at (``output_seq``).", "properties": { "block_count": { "title": "Block Count", "type": "integer" }, "has_more": { "title": "Has More", "type": "boolean" }, "messages": { "items": { "additionalProperties": true, "type": "object" }, "title": "Messages", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "output_seq": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Output Seq" }, "paging_mode": { "const": "blocks", "title": "Paging Mode", "type": "string" }, "pending_interaction": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Pending Interaction" } }, "required": [ "messages", "has_more", "paging_mode", "block_count" ], "title": "SessionHistoryBlockPage", "type": "object" }, "SessionListPage": { "additionalProperties": false, "description": "One page of summarized sessions, newest first.\n\n``next_cursor`` is the value to pass back as ``cursor``; it is ``null`` on\nthe last page, which ``has_more`` reports independently.", "properties": { "has_more": { "title": "Has More", "type": "boolean" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "sessions": { "items": { "$ref": "#/components/schemas/SessionRecord" }, "title": "Sessions", "type": "array" } }, "required": [ "sessions", "has_more" ], "title": "SessionListPage", "type": "object" }, "SessionMessagePage": { "additionalProperties": false, "description": "One page of a session's conversation as AI SDK UI messages, oldest first.\n\nA user message is an input the session accepted; an assistant message is\none response, its stored parts folded the way the AI SDK folds them live.\n``before`` is the cursor for the next older page. The first page also\ncarries ``output_seq``, the output position its parts were read through,\nto follow the stream from, and the interaction waiting on the owner. A\nshare link's page carries neither ``output_seq`` nor the tool input of an\ninteraction.", "properties": { "before": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Before" }, "has_more": { "title": "Has More", "type": "boolean" }, "messages": { "items": { "additionalProperties": true, "type": "object" }, "title": "Messages", "type": "array" }, "output_seq": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Output Seq" }, "pending_interaction": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Pending Interaction" } }, "required": [ "messages", "has_more" ], "title": "SessionMessagePage", "type": "object" }, "SessionRead": { "description": "When the owner last read a conversation.", "properties": { "read_at": { "title": "Read At", "type": "string" }, "session_id": { "title": "Session Id", "type": "string" } }, "required": [ "session_id", "read_at" ], "title": "SessionRead", "type": "object" }, "SessionRecord": { "additionalProperties": false, "description": "One session, as the read paths project it.\n\nThe list summarizes each row (``session_runtime/views.py``\n``session_summary``): its state there comes from the row's lifecycle and\nthe runtime status the reader last cached. The detail adds what the\nruntime is doing from its recorded facts: the responses in progress, the\nlast one that ended, the interaction waiting on the owner, the inputs the\nplatform still holds, and ``output_seq``, the output position to follow the\nsession's stream from.", "properties": { "agent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agent Id" }, "agent_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agent State" }, "assistant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assistant Id" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "current_responses": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResponseView" }, "type": "array" }, { "type": "null" } ], "title": "Current Responses" }, "deployment_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deployment Name" }, "engine_available": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Engine Available" }, "engine_capabilities": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Engine Capabilities" }, "engine_kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Engine Kind" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "held_inputs": { "anyOf": [ { "items": { "$ref": "#/components/schemas/HeldInputView" }, "type": "array" }, { "type": "null" } ], "title": "Held Inputs" }, "last_error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Error" }, "last_output_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Output At" }, "last_response": { "anyOf": [ { "$ref": "#/components/schemas/ResponseView" }, { "type": "null" } ] }, "model_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Name" }, "output_seq": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Output Seq" }, "pending_interaction": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Pending Interaction" }, "permission_mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Permission Mode" }, "read_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Read At" }, "recovery_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Recovery Reason" }, "runtime_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Runtime Status" }, "runtime_unavailable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Runtime Unavailable" }, "sandbox_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sandbox Id" }, "session_id": { "title": "Session Id", "type": "string" }, "session_kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Session Kind" }, "slash_command_details": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Slash Command Details" }, "slash_commands": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Slash Commands" }, "source_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Type" }, "startup_progress": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Startup Progress" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State" }, "terminal_cwd": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Terminal Cwd" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id" }, "workspace_panels": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" } ], "title": "Workspace Panels" } }, "required": [ "session_id" ], "title": "SessionRecord", "type": "object" }, "SessionTitle": { "additionalProperties": false, "description": "The title the owner gave a conversation, as stored.", "properties": { "session_id": { "title": "Session Id", "type": "string" }, "title": { "title": "Title", "type": "string" } }, "required": [ "session_id", "title" ], "title": "SessionTitle", "type": "object" }, "SessionUpdate": { "additionalProperties": false, "description": "The Session fields its owner may change: the title.", "properties": { "title": { "title": "Title", "type": "string" } }, "required": [ "title" ], "title": "SessionUpdate", "type": "object" }, "SessionUserActionView": { "additionalProperties": false, "properties": { "actions": { "items": { "$ref": "#/components/schemas/UserActionCommandView" }, "title": "Actions", "type": "array" }, "applicable": { "description": "Whether execution prerequisites apply; false for read-only history", "title": "Applicable", "type": "boolean" }, "ready": { "title": "Ready", "type": "boolean" }, "user_action": { "anyOf": [ { "$ref": "#/components/schemas/UserActionView" }, { "type": "null" } ] } }, "required": [ "applicable", "ready" ], "title": "SessionUserActionView", "type": "object" }, "SetAgentAccessRequest": { "additionalProperties": false, "description": "The complete policy accepted by the dedicated Agent access endpoint.", "properties": { "admins": { "items": { "type": "string" }, "title": "Admins", "type": "array" }, "allowed_user_ids": { "items": { "type": "string" }, "title": "Allowed User Ids", "type": "array" }, "visibility": { "enum": [ "public", "private", "allowlist" ], "title": "Visibility", "type": "string" } }, "required": [ "visibility" ], "title": "SetAgentAccessRequest", "type": "object" }, "SetAgentExtensionsRequest": { "additionalProperties": false, "properties": { "mcp_server_ids": { "items": { "type": "string" }, "title": "Mcp Server Ids", "type": "array" }, "skill_ids": { "items": { "type": "string" }, "title": "Skill Ids", "type": "array" } }, "required": [ "mcp_server_ids", "skill_ids" ], "title": "SetAgentExtensionsRequest", "type": "object" }, "SetAgentMCPServersRequest": { "additionalProperties": false, "properties": { "mcp_server_ids": { "items": { "type": "string" }, "title": "Mcp Server Ids", "type": "array" } }, "required": [ "mcp_server_ids" ], "title": "SetAgentMCPServersRequest", "type": "object" }, "SetCredentialBindingRequest": { "additionalProperties": false, "description": "Ordered Vault ids selected by an administrator for one runtime.", "properties": { "vault_ids": { "items": { "type": "string" }, "title": "Vault Ids", "type": "array" } }, "required": [ "vault_ids" ], "title": "SetCredentialBindingRequest", "type": "object" }, "ShareLink": { "additionalProperties": false, "description": "The share configuration its owner may read back.\n\nThe token is the capability, so it appears here and nowhere the viewer side\nanswers. ``expires_at`` is null for a link with no expiry — a distinct state\nfrom an expired one, which the viewer routes refuse with 404.", "properties": { "allow_download": { "title": "Allow Download", "type": "boolean" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "enabled": { "title": "Enabled", "type": "boolean" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "token": { "title": "Token", "type": "string" } }, "required": [ "enabled", "token", "expires_at", "allow_download", "created_at" ], "title": "ShareLink", "type": "object" }, "ShareRevoked": { "additionalProperties": false, "description": "Revocation answers the one fact it changed.\n\nThe token is deliberately absent: revoking disables the link without\ndiscarding the token, so re-sharing keeps links already handed out working,\nand there is nothing here for a client to treat as a live capability.", "properties": { "enabled": { "title": "Enabled", "type": "boolean" } }, "required": [ "enabled" ], "title": "ShareRevoked", "type": "object" }, "SharedMessagePage": { "additionalProperties": false, "description": "One page of a shared conversation as UI messages, newest page first.\n\n``before`` is the cursor for the next older page. A share has no stream to\nfollow, so the page carries no output position.", "properties": { "before": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Before" }, "has_more": { "title": "Has More", "type": "boolean" }, "messages": { "items": { "additionalProperties": true, "type": "object" }, "title": "Messages", "type": "array" }, "pending_interaction": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Pending Interaction" } }, "required": [ "messages", "has_more" ], "title": "SharedMessagePage", "type": "object" }, "SharedSession": { "additionalProperties": false, "description": "A session as a link recipient sees it.\n\nA capability URL grants reading the conversation, not access to the owner's\nsession or its runtime. Only what the read-only page shows crosses this\nboundary: the title, the interaction the conversation waits on (without\nthe tool input it asks about), and whether files may be downloaded.", "properties": { "pending_interaction": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Pending Interaction" }, "share_allow_download": { "title": "Share Allow Download", "type": "boolean" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" } }, "required": [ "share_allow_download" ], "title": "SharedSession", "type": "object" }, "SpeechInputOptions": { "additionalProperties": false, "properties": { "max_audio_bytes": { "title": "Max Audio Bytes", "type": "integer" }, "max_recording_seconds": { "title": "Max Recording Seconds", "type": "integer" }, "models": { "items": { "type": "string" }, "title": "Models", "type": "array" } }, "required": [ "models", "max_audio_bytes", "max_recording_seconds" ], "title": "SpeechInputOptions", "type": "object" }, "SpeechInputTranscript": { "additionalProperties": false, "properties": { "text": { "title": "Text", "type": "string" } }, "required": [ "text" ], "title": "SpeechInputTranscript", "type": "object" }, "StartConversationRequest": { "additionalProperties": false, "description": "Conversation start body.\n\nCredentials are deliberately absent. They are bound to the managed Agent or\nAssistant configuration; accepting a user-supplied Vault id here would let a\nconversation replace that management decision. Keeping an empty, strict\nmodel lets ``POST`` without a body and ``{}`` work while unknown fields fail.", "properties": {}, "title": "StartConversationRequest", "type": "object" }, "StartedAgentConversation": { "additionalProperties": true, "description": "The conversation a caller just created, addressed by ``session_id``.", "properties": { "agent_id": { "title": "Agent Id", "type": "string" }, "deployment_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deployment Name" }, "session_id": { "title": "Session Id", "type": "string" } }, "required": [ "session_id", "agent_id" ], "title": "StartedAgentConversation", "type": "object" }, "StartedAssistantConversation": { "additionalProperties": true, "description": "The conversation a caller just created, addressed by ``session_id``.\n\nConversation creation answers with the session itself, so the members of a\nsession read are carried here too. All turn, stream, interaction and file\ntraffic for it then goes to ``/api/v1/sessions/{session_id}/...``.", "properties": { "session_id": { "title": "Session Id", "type": "string" }, "session_kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Session Kind" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State" } }, "required": [ "session_id" ], "title": "StartedAssistantConversation", "type": "object" }, "TerminalInterruptResult": { "additionalProperties": false, "description": "``completed`` once the terminal's running command has ended; ``idle`` when none ran.", "properties": { "session_id": { "title": "Session Id", "type": "string" }, "status": { "title": "Status", "type": "string" } }, "required": [ "session_id", "status" ], "title": "TerminalInterruptResult", "type": "object" }, "TranscriptAppendResult": { "additionalProperties": true, "description": "What the store holds after a batch.\n\n``count`` is the batch's size as sent; ``store_sequence`` is the scope's\ncommitted entry count, so a re-sent batch answers the sequence the first\ndelivery got and nothing is stored twice.", "properties": { "count": { "title": "Count", "type": "integer" }, "ok": { "title": "Ok", "type": "boolean" }, "store_sequence": { "title": "Store Sequence", "type": "integer" } }, "required": [ "ok", "count", "store_sequence" ], "title": "TranscriptAppendResult", "type": "object" }, "TranscriptLoadResult": { "additionalProperties": true, "description": "A scope's entries, or ``None`` for a key nothing has written.\n\nThe null is the SessionStore contract for \"unknown key\" and is distinct from\nan empty list, so the adapter can tell a never-written transcript from one\nwhose entries were all removed.", "properties": { "entries": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Entries" }, "store_sequence": { "title": "Store Sequence", "type": "integer" } }, "required": [ "entries", "store_sequence" ], "title": "TranscriptLoadResult", "type": "object" }, "TranscriptSessionList": { "additionalProperties": true, "description": "Main transcripts only — subagent subpaths are enumerated by subkey.", "properties": { "sessions": { "items": { "$ref": "#/components/schemas/TranscriptSessionRef" }, "title": "Sessions", "type": "array" } }, "required": [ "sessions" ], "title": "TranscriptSessionList", "type": "object" }, "TranscriptSessionRef": { "additionalProperties": true, "description": "One SDK session under a project key, with its newest write time.", "properties": { "mtime": { "title": "Mtime", "type": "integer" }, "session_id": { "title": "Session Id", "type": "string" } }, "required": [ "session_id", "mtime" ], "title": "TranscriptSessionRef", "type": "object" }, "TranscriptSubkeyList": { "additionalProperties": true, "description": "The subpaths under one SDK session — the subagent transcripts to resume.", "properties": { "subkeys": { "items": { "type": "string" }, "title": "Subkeys", "type": "array" } }, "required": [ "subkeys" ], "title": "TranscriptSubkeyList", "type": "object" }, "UpdateCredentialRequest": { "additionalProperties": false, "description": "Body for ``PATCH /api/v1/admin/vaults/{vault_id}/credentials/{credential_id}``.", "properties": { "auth": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Auth" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" } }, "title": "UpdateCredentialRequest", "type": "object" }, "UpdateMCPServerRequest": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "transport": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Transport" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" } }, "title": "UpdateMCPServerRequest", "type": "object" }, "UserActionCommandView": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "label": { "title": "Label", "type": "string" } }, "required": [ "id", "label" ], "title": "UserActionCommandView", "type": "object" }, "UserActionView": { "additionalProperties": false, "properties": { "message": { "title": "Message", "type": "string" }, "status": { "title": "Status", "type": "string" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" } }, "required": [ "status", "message" ], "title": "UserActionView", "type": "object" }, "Vault": { "additionalProperties": true, "description": "One Vault. ``credentials`` accompanies the catalog and binding reads.", "properties": { "archived_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Archived At" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "credentials": { "anyOf": [ { "items": { "$ref": "#/components/schemas/VaultCredential" }, "type": "array" }, { "type": "null" } ], "title": "Credentials" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "metadata": { "additionalProperties": true, "title": "Metadata", "type": "object" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "vault_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vault Id" } }, "required": [ "vault_id", "display_name", "metadata", "archived_at", "created_at", "updated_at" ], "title": "Vault", "type": "object" }, "VaultBindingHolder": { "description": "One Agent or Assistant currently assigned to a Vault.", "properties": { "target_id": { "title": "Target Id", "type": "string" }, "target_name": { "title": "Target Name", "type": "string" }, "target_type": { "title": "Target Type", "type": "string" }, "vault_ids": { "items": { "type": "string" }, "title": "Vault Ids", "type": "array" } }, "required": [ "target_type", "target_id", "target_name", "vault_ids" ], "title": "VaultBindingHolder", "type": "object" }, "VaultCatalog": { "additionalProperties": true, "description": "Every Vault in the organization, plus how this deployment delivers them.", "properties": { "credential_delivery": { "$ref": "#/components/schemas/CredentialDelivery" }, "vaults": { "items": { "$ref": "#/components/schemas/Vault" }, "title": "Vaults", "type": "array" } }, "required": [ "vaults", "credential_delivery" ], "title": "VaultCatalog", "type": "object" }, "VaultCredential": { "additionalProperties": true, "description": "One saved credential, as ``VaultService._credential_view`` renders it.", "properties": { "archived_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Archived At" }, "auth": { "$ref": "#/components/schemas/CredentialAuthSummary" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "credential_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Credential Id" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "vault_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vault Id" } }, "required": [ "credential_id", "vault_id", "display_name", "auth", "archived_at", "created_at", "updated_at" ], "title": "VaultCredential", "type": "object" }, "VaultCredentialList": { "additionalProperties": true, "description": "One Vault's credentials, archived ones included.", "properties": { "credentials": { "items": { "$ref": "#/components/schemas/VaultCredential" }, "title": "Credentials", "type": "array" } }, "required": [ "credentials" ], "title": "VaultCredentialList", "type": "object" }, "WebshellAccess": { "additionalProperties": true, "description": "The web-shell URL for a session's sandbox.\n\nAnswered only by a backend that offers a web shell; the rest refuse with\n``WEB_SHELL_UNSUPPORTED`` (``astrabox/seams/sandbox.py``).", "properties": { "sandbox_id": { "title": "Sandbox Id", "type": "string" }, "session_id": { "title": "Session Id", "type": "string" }, "url": { "title": "Url", "type": "string" } }, "required": [ "session_id", "sandbox_id", "url" ], "title": "WebshellAccess", "type": "object" } }, "securitySchemes": { "BearerAuth": { "description": "Bearer credential; the operation identifies its issuer, capability binding or configured identity provider. OAuth API token scopes are checked where present.", "scheme": "bearer", "type": "http" }, "BrowserSession": { "description": "Browser session established by the built-in OIDC login flow.", "in": "cookie", "name": "astrabox_session", "type": "apiKey" }, "MCPClientToken": { "description": "AstraBox MCP client key, narrowed to its read/converse scope.", "scheme": "bearer", "type": "http" } } }, "info": { "summary": "Self-hosted agent runtime that runs installed Agent programs in isolated sandboxes and streams responses over the AI SDK Data Stream Protocol (SSE).", "title": "AstraBox", "version": "0.1.13", "x-web-identity": "OidcSessionWebIdentityResolver" }, "openapi": "3.1.0", "paths": { "/api/v1/admin-api/assistants/{assistant_id}/workspace/hibernate": { "post": { "operationId": "admin_api_hibernate_assistant_workspace_api_v1_admin_api_assistants__assistant_id__workspace_hibernate_post", "parameters": [ { "in": "path", "name": "assistant_id", "required": true, "schema": { "title": "Assistant Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "properties": { "user_id": { "description": "Owner whose Assistant workspace the administrator operates.", "type": "string" } }, "required": [ "user_id" ], "title": "Payload", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AdminApiWorkspaceResult_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Admin Api Hibernate Assistant Workspace", "tags": [ "Admin Api" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin-api/assistants/{assistant_id}/workspace/wake": { "post": { "operationId": "admin_api_wake_assistant_workspace_api_v1_admin_api_assistants__assistant_id__workspace_wake_post", "parameters": [ { "in": "path", "name": "assistant_id", "required": true, "schema": { "title": "Assistant Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "properties": { "user_id": { "description": "Owner whose Assistant workspace the administrator operates.", "type": "string" } }, "required": [ "user_id" ], "title": "Payload", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AdminApiWorkspaceResult_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Admin Api Wake Assistant Workspace", "tags": [ "Admin Api" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin-api/errors": { "get": { "operationId": "admin_api_list_errors_api_v1_admin_api_errors_get", "parameters": [ { "description": "Maximum errors, capped at 500.", "in": "query", "name": "limit", "required": false, "schema": { "default": 200, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AdminErrorsPage_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Admin Api List Errors", "tags": [ "Admin Api" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin-api/process/health": { "get": { "operationId": "admin_api_process_health_api_v1_admin_api_process_health_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AdminProcessHealth_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Admin Api Process Health", "tags": [ "Admin Api" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin-api/sessions/all": { "get": { "operationId": "admin_api_list_sessions_api_v1_admin_api_sessions_all_get", "parameters": [ { "description": "Maximum unscoped session records, capped at 500.", "in": "query", "name": "limit", "required": false, "schema": { "default": 200, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_list_SessionRecord__" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Admin Api List Sessions", "tags": [ "Admin Api" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/agent-categories": { "get": { "operationId": "list_admin_agent_categories_api_v1_admin_agent_categories_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_list_AdminAgentCategory__" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "List Admin Agent Categories", "tags": [ "Agent Catalog" ], "x-required-api-scope": "astrabox:admin" }, "post": { "operationId": "create_agent_category_api_v1_admin_agent_categories_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentCategoryName" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AgentCategory_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Create Agent Category", "tags": [ "Agent Catalog" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/agent-categories/order": { "put": { "operationId": "reorder_agent_categories_api_v1_admin_agent_categories_order_put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentCategoryOrder" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_list_AgentCategory__" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Reorder Agent Categories", "tags": [ "Agent Catalog" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/agent-categories/{category_id}": { "delete": { "operationId": "delete_agent_category_api_v1_admin_agent_categories__category_id__delete", "parameters": [ { "in": "path", "name": "category_id", "required": true, "schema": { "title": "Category Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_DeletedAgentCategory_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Delete Agent Category", "tags": [ "Agent Catalog" ], "x-required-api-scope": "astrabox:admin" }, "put": { "operationId": "rename_agent_category_api_v1_admin_agent_categories__category_id__put", "parameters": [ { "in": "path", "name": "category_id", "required": true, "schema": { "title": "Category Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentCategoryName" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AgentCategory_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Rename Agent Category", "tags": [ "Agent Catalog" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/agent-schema": { "get": { "description": "Return the authoritative editable schema for the Agent form.", "operationId": "get_agent_schema_endpoint_api_v1_admin_agent_schema_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AdminFormSchema_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Get Agent Schema Endpoint", "tags": [ "Admin" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/agents/{agent_id}/credential-vaults": { "get": { "operationId": "get_agent_credential_binding_api_v1_admin_agents__agent_id__credential_vaults_get", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_CredentialBinding_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Get Agent Credential Binding", "tags": [ "Vaults" ], "x-required-api-scope": "astrabox:admin" }, "put": { "operationId": "set_agent_credential_binding_api_v1_admin_agents__agent_id__credential_vaults_put", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetCredentialBindingRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_CredentialBinding_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Set Agent Credential Binding", "tags": [ "Vaults" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/agents/{agent_id}/deployments": { "get": { "operationId": "list_agent_deployments_api_v1_admin_agents__agent_id__deployments_get", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_list_DeploymentRecord__" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "List Agent Deployments", "tags": [ "Deployments" ], "x-required-api-scope": "astrabox:admin" }, "post": { "operationId": "create_agent_deployment_api_v1_admin_agents__agent_id__deployments_post", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "properties": { "allowed_participants": { "items": { "type": "string" }, "type": "array" }, "attention_policy": { "description": "Attention policy supported by the installed channel provider.", "type": "string" }, "channel_config": { "additionalProperties": true, "description": "Fields from the selected channel provider's config_fields catalog.", "type": "object" }, "credentials": { "additionalProperties": { "type": "string" }, "description": "Private values from that provider's credential_fields catalog; reads return masks.", "type": "object" }, "enabled": { "type": "boolean" }, "execution_mode": { "description": "One execution_modes value from the selected channel provider.", "type": "string" }, "execution_user_id": { "description": "Account execution subject; configuring it requires platform administration.", "type": "string" }, "name": { "type": "string" }, "prompt_prefix": { "type": "string" }, "response_instruction": { "type": "string" }, "scene": { "description": "Installed trigger scene: a webhook, schedule, or channel provider's advertised scene.", "type": "string" }, "schedule": { "additionalProperties": true, "description": "Recurring schedule: five cron fields and an IANA timezone.", "properties": { "cron": { "type": "string" }, "timezone": { "type": "string" } }, "type": "object" }, "secret": { "description": "Trigger secret where the selected scene uses one.", "type": [ "string", "null" ] } }, "required": [ "scene" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_DeploymentRecord_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Create Agent Deployment", "tags": [ "Deployments" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/agents/{agent_id}/deployments/{deployment_id}": { "delete": { "operationId": "delete_agent_deployment_api_v1_admin_agents__agent_id__deployments__deployment_id__delete", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } }, { "in": "path", "name": "deployment_id", "required": true, "schema": { "title": "Deployment Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_DeletedDeployment_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Delete Agent Deployment", "tags": [ "Deployments" ], "x-required-api-scope": "astrabox:admin" }, "put": { "operationId": "update_agent_deployment_api_v1_admin_agents__agent_id__deployments__deployment_id__put", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } }, { "in": "path", "name": "deployment_id", "required": true, "schema": { "title": "Deployment Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "description": "Partial update of a trigger binding; authorization and scene validation remain server-side.", "properties": { "allowed_participants": { "items": { "type": "string" }, "type": "array" }, "attention_policy": { "description": "Attention policy supported by the installed channel provider.", "type": "string" }, "channel_config": { "additionalProperties": true, "description": "Fields from the selected channel provider's config_fields catalog.", "type": "object" }, "credentials": { "additionalProperties": { "type": "string" }, "description": "Private values from that provider's credential_fields catalog; reads return masks.", "type": "object" }, "enabled": { "type": "boolean" }, "execution_mode": { "description": "One execution_modes value from the selected channel provider.", "type": "string" }, "execution_user_id": { "description": "Account execution subject; configuring it requires platform administration.", "type": "string" }, "name": { "type": "string" }, "prompt_prefix": { "type": "string" }, "response_instruction": { "type": "string" }, "scene": { "description": "Installed trigger scene: a webhook, schedule, or channel provider's advertised scene.", "type": "string" }, "schedule": { "additionalProperties": true, "description": "Recurring schedule: five cron fields and an IANA timezone.", "properties": { "cron": { "type": "string" }, "timezone": { "type": "string" } }, "type": "object" }, "secret": { "description": "Trigger secret where the selected scene uses one.", "type": [ "string", "null" ] } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_DeploymentRecord_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Update Agent Deployment", "tags": [ "Deployments" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/agents/{agent_id}/deployments/{deployment_id}/account-links": { "delete": { "operationId": "delete_agent_deployment_account_link_api_v1_admin_agents__agent_id__deployments__deployment_id__account_links_delete", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } }, { "in": "path", "name": "deployment_id", "required": true, "schema": { "title": "Deployment Id", "type": "string" } }, { "in": "query", "name": "participant", "required": true, "schema": { "title": "Participant", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_DeletedChannelAccountLink_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Delete Agent Deployment Account Link", "tags": [ "Deployments" ], "x-required-api-scope": "astrabox:admin" }, "get": { "operationId": "list_agent_deployment_account_links_api_v1_admin_agents__agent_id__deployments__deployment_id__account_links_get", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } }, { "in": "path", "name": "deployment_id", "required": true, "schema": { "title": "Deployment Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_list_ChannelAccountLinkRecord__" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "List Agent Deployment Account Links", "tags": [ "Deployments" ], "x-required-api-scope": "astrabox:admin" }, "put": { "operationId": "put_agent_deployment_account_link_api_v1_admin_agents__agent_id__deployments__deployment_id__account_links_put", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } }, { "in": "path", "name": "deployment_id", "required": true, "schema": { "title": "Deployment Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "properties": { "participant": { "type": "string" }, "user_id": { "type": "string" } }, "required": [ "participant", "user_id" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_ChannelAccountLinkRecord_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Put Agent Deployment Account Link", "tags": [ "Deployments" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/agents/{agent_id}/deployments/{deployment_id}/runs": { "get": { "operationId": "list_deployment_runs_api_v1_admin_agents__agent_id__deployments__deployment_id__runs_get", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } }, { "in": "path", "name": "deployment_id", "required": true, "schema": { "title": "Deployment Id", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_list_DeploymentRun__" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "List Deployment Runs", "tags": [ "Deployments" ], "x-required-api-scope": "astrabox:admin" }, "post": { "operationId": "trigger_deployment_run_api_v1_admin_agents__agent_id__deployments__deployment_id__runs_post", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } }, { "in": "path", "name": "deployment_id", "required": true, "schema": { "title": "Deployment Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_DeploymentRun_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Trigger Deployment Run", "tags": [ "Deployments" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/agents/{agent_id}/deployments/{deployment_id}/runs/{run_id}/replay": { "post": { "operationId": "replay_deployment_run_api_v1_admin_agents__agent_id__deployments__deployment_id__runs__run_id__replay_post", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } }, { "in": "path", "name": "deployment_id", "required": true, "schema": { "title": "Deployment Id", "type": "string" } }, { "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_DeploymentRun_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Replay Deployment Run", "tags": [ "Deployments" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/agents/{agent_id}/mcp-servers": { "get": { "operationId": "get_agent_mcp_servers_api_v1_admin_agents__agent_id__mcp_servers_get", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AgentMCPServerAssignment_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Get Agent Mcp Servers", "tags": [ "Mcp Servers" ], "x-required-api-scope": "astrabox:admin" }, "put": { "operationId": "set_agent_mcp_servers_api_v1_admin_agents__agent_id__mcp_servers_put", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetAgentMCPServersRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AgentMCPServerAssignment_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Set Agent Mcp Servers", "tags": [ "Mcp Servers" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/assistant-defaults": { "get": { "operationId": "get_assistant_defaults_api_v1_admin_assistant_defaults_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AssistantDefaults_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Get Assistant Defaults", "tags": [ "Assistant Defaults" ], "x-required-api-scope": "astrabox:admin" }, "put": { "operationId": "set_assistant_defaults_api_v1_admin_assistant_defaults_put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssistantDefaultsFields" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AssistantDefaults_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Set Assistant Defaults", "tags": [ "Assistant Defaults" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/assistant-defaults/extensions": { "get": { "operationId": "get_assistant_defaults_extensions_api_v1_admin_assistant_defaults_extensions_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AssistantDefaultsExtensionCatalog_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Get Assistant Defaults Extensions", "tags": [ "Assistant Defaults" ], "x-required-api-scope": "astrabox:admin" }, "put": { "operationId": "set_assistant_defaults_extensions_api_v1_admin_assistant_defaults_extensions_put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetAgentExtensionsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AssistantDefaultsExtensionCatalog_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Set Assistant Defaults Extensions", "tags": [ "Assistant Defaults" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/assistants/{assistant_id}/credential-vaults": { "get": { "operationId": "get_assistant_credential_binding_api_v1_admin_assistants__assistant_id__credential_vaults_get", "parameters": [ { "in": "path", "name": "assistant_id", "required": true, "schema": { "title": "Assistant Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_CredentialBinding_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Get Assistant Credential Binding", "tags": [ "Vaults" ], "x-required-api-scope": "astrabox:admin" }, "put": { "operationId": "set_assistant_credential_binding_api_v1_admin_assistants__assistant_id__credential_vaults_put", "parameters": [ { "in": "path", "name": "assistant_id", "required": true, "schema": { "title": "Assistant Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetCredentialBindingRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_CredentialBinding_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Set Assistant Credential Binding", "tags": [ "Vaults" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/channel-providers": { "get": { "operationId": "list_channel_providers_api_v1_admin_channel_providers_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_list_ChannelProviderRecord__" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "List Channel Providers", "tags": [ "Deployments" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/connectors": { "get": { "operationId": "admin_list_connectors_api_v1_admin_connectors_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_list_Connector__" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Admin List Connectors", "tags": [ "Connectors" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/connectors/{connector_id}": { "delete": { "operationId": "admin_remove_connector_api_v1_admin_connectors__connector_id__delete", "parameters": [ { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "properties": { "code": { "type": "string" }, "data": { "additionalProperties": true, "properties": { "configured": { "const": false }, "connector_id": { "type": "string" } }, "required": [ "connector_id", "configured" ], "type": "object" }, "message": { "type": "string" } }, "required": [ "code", "message", "data" ], "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Admin Remove Connector", "tags": [ "Connectors" ], "x-required-api-scope": "astrabox:admin" }, "put": { "operationId": "admin_configure_connector_api_v1_admin_connectors__connector_id__put", "parameters": [ { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigureRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_Connector_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Admin Configure Connector", "tags": [ "Connectors" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/connectors/{connector_id}/publish": { "post": { "operationId": "admin_publish_connector_api_v1_admin_connectors__connector_id__publish_post", "parameters": [ { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_Connector_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Admin Publish Connector", "tags": [ "Connectors" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/connectors/{connector_id}/verify": { "post": { "operationId": "admin_verify_connector_api_v1_admin_connectors__connector_id__verify_post", "parameters": [ { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AuthorizeResponse_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Admin Verify Connector", "tags": [ "Connectors" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/deployments": { "get": { "operationId": "list_deployments_api_v1_admin_deployments_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_list_DeploymentRecord__" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "List Deployments", "tags": [ "Deployments" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/environments": { "get": { "operationId": "list_admin_environments_api_v1_admin_environments_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_list_AdminEnvironment__" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "List Admin Environments", "tags": [ "Environments" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/environments/{name}": { "get": { "operationId": "get_admin_environment_api_v1_admin_environments__name__get", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AdminEnvironment_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Get Admin Environment", "tags": [ "Environments" ], "x-required-api-scope": "astrabox:admin" }, "put": { "operationId": "save_admin_environment_api_v1_admin_environments__name__put", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentWrite" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AdminEnvironment_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Save Admin Environment", "tags": [ "Environments" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/errors": { "get": { "operationId": "admin_list_errors_api_v1_admin_errors_get", "parameters": [ { "description": "Maximum errors, capped at 500.", "in": "query", "name": "limit", "required": false, "schema": { "default": 200, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AdminErrorsPage_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Admin List Errors", "tags": [ "Admin" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/integrations": { "get": { "description": "List management consoles enabled for this deployment.", "operationId": "admin_integrations_api_v1_admin_integrations_get", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "properties": { "code": { "type": "string" }, "data": { "additionalProperties": true, "properties": { "services": { "items": { "additionalProperties": true, "properties": { "admin_url": { "type": "string" }, "category": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name", "category", "admin_url" ], "type": "object" }, "type": "array" } }, "required": [ "services" ], "type": "object" }, "message": { "type": "string" } }, "required": [ "code", "message", "data" ], "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Admin Integrations", "tags": [ "Admin" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/logs": { "get": { "operationId": "admin_logs_api_v1_admin_logs_get", "parameters": [ { "description": "Maximum log lines, capped at 2000.", "in": "query", "name": "lines", "required": false, "schema": { "default": 200, "type": "integer" } }, { "description": "Log severity filter.", "in": "query", "name": "level", "required": false, "schema": { "type": "string" } }, { "description": "Log text filter.", "in": "query", "name": "keyword", "required": false, "schema": { "type": "string" } }, { "description": "One label from the returned available files.", "in": "query", "name": "file", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AdminLogsPage_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Admin Logs", "tags": [ "Admin" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/mcp-servers": { "get": { "operationId": "list_mcp_servers_api_v1_admin_mcp_servers_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_MCPServerList_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "List Mcp Servers", "tags": [ "Mcp Servers" ], "x-required-api-scope": "astrabox:admin" }, "post": { "operationId": "create_mcp_server_api_v1_admin_mcp_servers_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMCPServerRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_MCPServer_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Create Mcp Server", "tags": [ "Mcp Servers" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/mcp-servers/{mcp_server_id}": { "delete": { "operationId": "delete_mcp_server_api_v1_admin_mcp_servers__mcp_server_id__delete", "parameters": [ { "in": "path", "name": "mcp_server_id", "required": true, "schema": { "title": "Mcp Server Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Delete Mcp Server", "tags": [ "Mcp Servers" ], "x-required-api-scope": "astrabox:admin" }, "get": { "operationId": "get_mcp_server_api_v1_admin_mcp_servers__mcp_server_id__get", "parameters": [ { "in": "path", "name": "mcp_server_id", "required": true, "schema": { "title": "Mcp Server Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_MCPServer_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Get Mcp Server", "tags": [ "Mcp Servers" ], "x-required-api-scope": "astrabox:admin" }, "patch": { "operationId": "update_mcp_server_api_v1_admin_mcp_servers__mcp_server_id__patch", "parameters": [ { "in": "path", "name": "mcp_server_id", "required": true, "schema": { "title": "Mcp Server Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMCPServerRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_MCPServer_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Update Mcp Server", "tags": [ "Mcp Servers" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/navigation-summary": { "get": { "operationId": "admin_navigation_summary_api_v1_admin_navigation_summary_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AdminNavigationSummary_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Admin Navigation Summary", "tags": [ "Admin" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/process/health": { "get": { "operationId": "admin_process_health_api_v1_admin_process_health_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AdminProcessHealth_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Admin Process Health", "tags": [ "Admin" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/runtime-profile-schema": { "get": { "description": "Return the authoritative editable schema for the environment form.", "operationId": "get_runtime_profile_schema_endpoint_api_v1_admin_runtime_profile_schema_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AdminFormSchema_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Get Runtime Profile Schema Endpoint", "tags": [ "Admin" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/runtime-profiles": { "get": { "description": "List all environment presets (including disabled entries).", "operationId": "list_admin_runtime_profiles_api_v1_admin_runtime_profiles_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_list_dict_str__Any___", "additionalProperties": true, "properties": { "code": { "type": "string" }, "data": { "items": { "additionalProperties": true, "description": "Environment document; credentials are masked. Native extension and option schemas come from the installed program.", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "endpoint_provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "engine_available": { "type": "boolean" }, "engine_kind": { "type": "string" }, "engine_options_schema": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "extensions": { "additionalProperties": true, "type": "object" }, "idle_action": { "anyOf": [ { "enum": [ "terminate", "pause" ], "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "networking": { "anyOf": [ { "additionalProperties": false, "properties": { "allow_mcp_servers": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "allowed_hosts": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] }, "type": { "enum": [ "unrestricted", "limited" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, { "type": "null" } ], "default": { "allow_mcp_servers": false, "allowed_hosts": [], "type": "limited" } }, "permission_modes": { "items": { "type": "string" }, "type": "array" }, "provider_access": { "anyOf": [ { "additionalProperties": false, "properties": { "api_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "api_key_secret_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "base_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object" }, { "type": "null" } ] }, "runtime_template_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sandbox_backend": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sandbox_permission_level": { "anyOf": [ { "enum": [ "default", "advanced", "privileged" ], "type": "string" }, { "type": "null" } ], "default": "default" }, "sandbox_tenancy": { "anyOf": [ { "enum": [ "conversation", "agent" ], "type": "string" }, { "type": "null" } ], "default": "conversation" }, "supported_session_kinds": { "items": { "type": "string" }, "type": "array" }, "tracing": { "anyOf": [ { "additionalProperties": false, "properties": { "auth_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "auth_token_secret_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "endpoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "environment": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "headers": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ] }, "log_user_prompt": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "signals": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] } }, "type": "object" }, { "type": "null" } ] } }, "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "code", "message", "data" ], "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "List Admin Runtime Profiles", "tags": [ "Admin" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/runtime-profiles/{name}": { "delete": { "description": "Delete a preset only after checking its Agent and Assistant references.", "operationId": "delete_admin_runtime_profile_api_v1_admin_runtime_profiles__name__delete", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AdminDeletedRuntimeProfile_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Delete Admin Runtime Profile", "tags": [ "Admin" ], "x-required-api-scope": "astrabox:admin" }, "put": { "description": "Upsert a single environment preset by name.", "operationId": "upsert_admin_runtime_profile_api_v1_admin_runtime_profiles__name__put", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "endpoint_provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "engine_kind": { "type": "string" }, "idle_action": { "anyOf": [ { "enum": [ "terminate", "pause" ], "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "networking": { "anyOf": [ { "additionalProperties": false, "properties": { "allow_mcp_servers": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "allowed_hosts": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] }, "type": { "enum": [ "unrestricted", "limited" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, { "type": "null" } ], "default": { "allow_mcp_servers": false, "allowed_hosts": [], "type": "limited" } }, "provider_access": { "anyOf": [ { "additionalProperties": false, "properties": { "api_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "api_key_secret_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "base_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object" }, { "type": "null" } ] }, "runtime_template_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sandbox_backend": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sandbox_permission_level": { "anyOf": [ { "enum": [ "default", "advanced", "privileged" ], "type": "string" }, { "type": "null" } ], "default": "default" }, "sandbox_tenancy": { "anyOf": [ { "enum": [ "conversation", "agent" ], "type": "string" }, { "type": "null" } ], "default": "conversation" }, "tracing": { "anyOf": [ { "additionalProperties": false, "properties": { "auth_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "auth_token_secret_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "endpoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "environment": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "headers": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ] }, "log_user_prompt": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "signals": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] } }, "type": "object" }, { "type": "null" } ] } }, "required": [ "engine_kind" ], "title": "Payload", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_dict_str__Any__", "additionalProperties": true, "properties": { "code": { "type": "string" }, "data": { "additionalProperties": true, "description": "Environment document; credentials are masked. Native extension and option schemas come from the installed program.", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "endpoint_provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "engine_available": { "type": "boolean" }, "engine_kind": { "type": "string" }, "engine_options_schema": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "extensions": { "additionalProperties": true, "type": "object" }, "idle_action": { "anyOf": [ { "enum": [ "terminate", "pause" ], "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "networking": { "anyOf": [ { "additionalProperties": false, "properties": { "allow_mcp_servers": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "allowed_hosts": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] }, "type": { "enum": [ "unrestricted", "limited" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, { "type": "null" } ], "default": { "allow_mcp_servers": false, "allowed_hosts": [], "type": "limited" } }, "permission_modes": { "items": { "type": "string" }, "type": "array" }, "provider_access": { "anyOf": [ { "additionalProperties": false, "properties": { "api_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "api_key_secret_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "base_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object" }, { "type": "null" } ] }, "runtime_template_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sandbox_backend": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sandbox_permission_level": { "anyOf": [ { "enum": [ "default", "advanced", "privileged" ], "type": "string" }, { "type": "null" } ], "default": "default" }, "sandbox_tenancy": { "anyOf": [ { "enum": [ "conversation", "agent" ], "type": "string" }, { "type": "null" } ], "default": "conversation" }, "supported_session_kinds": { "items": { "type": "string" }, "type": "array" }, "tracing": { "anyOf": [ { "additionalProperties": false, "properties": { "auth_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "auth_token_secret_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "endpoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "environment": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "headers": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ] }, "log_user_prompt": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "signals": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] } }, "type": "object" }, { "type": "null" } ] } }, "type": "object" }, "message": { "type": "string" } }, "required": [ "code", "message", "data" ], "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Upsert Admin Runtime Profile", "tags": [ "Admin" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/runtime-profiles/{name}/models": { "get": { "description": "Model ids the console can offer for agents on this environment.\n\nEnumerated by the environment's selected model provider. A provider with\nno authoritative catalog returns an empty list and the console accepts a\nfree-text model id.", "operationId": "list_runtime_profile_models_api_v1_admin_runtime_profiles__name__models_get", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AdminRuntimeProfileModels_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "List Runtime Profile Models", "tags": [ "Admin" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/sandbox-idle-action": { "get": { "description": "Which idle actions a backend can carry out, and which one is in force.\n\nThe question a form has to ask before offering an environment the choice:\nan ``idle_action`` the backend cannot honor is refused at write time, and a\ncontrol that offers it anyway makes the operator discover that by being\nrejected.\n\nWhether a backend implements pausing is a property of the code, declared\non the seam, so there is nothing to be unreachable and ``supported`` is\na plain boolean.\n\nWhat it therefore does not answer: whether this cluster is arranged for\nsnapshots. Pausing additionally needs a containerd at the standard socket,\na CRI that pulls locally, and a registry both the node and a Pod can\nreach (docs/providers/opensandbox.md). A backend that declares pausing on\na cluster missing one of those pauses nothing — the commit fails, the box\nis left running, and the sweeper says so. So this reports capability, and\nthe form's copy carries the cluster requirement; neither pretends to be\nthe other.\n\n``default_action`` is the installation's own setting. It seeds the field\nwhen an environment is created and is not consulted again: a stored\nenvironment always carries its own action, so a sweep reads that and\nnever this.", "operationId": "describe_sandbox_idle_action_api_v1_admin_sandbox_idle_action_get", "parameters": [ { "description": "Enabled sandbox backend; omitted selects the configured default.", "in": "query", "name": "backend", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AdminSandboxIdleAction_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Describe Sandbox Idle Action", "tags": [ "Sandboxes" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/sandbox-idle-sweep": { "post": { "description": "Run the idle/expiry sweep once, now, and answer with what it did.\n\nThe expiration watcher normally invokes this sweep every 300 seconds. This\nendpoint invokes the same scan immediately, so checking idle parking or\ndead-binding convergence does not add the watcher interval to any cluster\noperation.\n\nRead-only in the sense that matters: it takes no arguments and can decide\nnothing the timer would not have decided on its next tick. It is a\n`POST` because it acts.\n\nThe summary is the tick's own — `idle_candidates` / `idle_parked` /\n`idle_active` / `idle_failed`, plus the dead-binding counters — so a caller\nsees why nothing happened, which is usually the question. An empty object\nmeans neither sweep found a candidate.", "operationId": "run_sandbox_idle_sweep_api_v1_admin_sandbox_idle_sweep_post", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AdminSandboxIdleSweep_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Run Sandbox Idle Sweep", "tags": [ "Sandboxes" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/sandbox-quota": { "get": { "description": "Each enabled backend's quota ceilings, what is held against them, and its boxes.\n\nUsage is the backend's last inventory plus the reservations for boxes\nit does not show yet, as the quota itself counts it; ``inventory_at``\nsays when that inventory was taken.", "operationId": "describe_sandbox_quota_api_v1_admin_sandbox_quota_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AdminSandboxQuota_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Describe Sandbox Quota", "tags": [ "Sandboxes" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/sandboxes": { "get": { "description": "One page of the backend's sandbox inventory.\n\nPaged at the source: ``pagination`` carries the backend's own counters,\nso the console advances by ``page`` while ``has_next_page`` holds rather\nthan assuming one response is the whole inventory.", "operationId": "list_sandboxes_api_v1_admin_sandboxes_get", "parameters": [ { "description": "Enabled sandbox backend; omitted selects the configured default.", "in": "query", "name": "backend", "required": false, "schema": { "type": "string" } }, { "description": "Backend page number.", "in": "query", "name": "page", "required": false, "schema": { "default": 1, "maximum": 1000000, "minimum": 1, "type": "integer" } }, { "description": "Backend page size.", "in": "query", "name": "page_size", "required": false, "schema": { "default": 50, "maximum": 200, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AdminSandboxPage_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "List Sandboxes", "tags": [ "Sandboxes" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/sandboxes/{sandbox_id}": { "get": { "description": "One sandbox as its backend's control plane describes it.", "operationId": "describe_sandbox_api_v1_admin_sandboxes__sandbox_id__get", "parameters": [ { "in": "path", "name": "sandbox_id", "required": true, "schema": { "title": "Sandbox Id", "type": "string" } }, { "description": "Enabled sandbox backend; omitted selects the configured default.", "in": "query", "name": "backend", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AdminSandboxSummary_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Describe Sandbox", "tags": [ "Sandboxes" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/sandboxes/{sandbox_id}/diagnostics/{scope}": { "get": { "description": "One plain-text diagnostic report, passed through as text.\n\n``text`` is prose for a human to read — no schema, no promised fields,\nno stability across backends or backend versions. It is returned inside\nthe JSON envelope purely as transport; render it verbatim and do not\nparse it. ``truncated`` marks a report the provider had to cap.\n\n``***`` in the text is a value the backend withheld, and a run of them\nis normal rather than a fault: a backend that cannot prove where a\nwithheld value ended keeps masking to the end of the report. When a\nreport reads that way, the later sections are readable as their own\nscopes.\n\nA backend or server that does not produce the report answers 501 with\nits own reason, so the caller learns the report cannot be had and why,\ninstead of receiving empty text that reads as a healthy, silent\nsandbox.\n\n``known_scopes`` is the scope vocabulary this route accepts\n(:data:`~astrabox.seams.sandbox.SANDBOX_DIAGNOSTIC_SCOPES`) — a constant,\nand named as the constant it is. It is deliberately not called\n\"available\": support is per backend and, for a control plane fronting\nseveral runtimes, potentially per runtime, so which of these four this\nsandbox can actually produce is knowable only by asking for each one.\nA field that promised availability would be advertising reports the same\nbackend goes on to refuse.", "operationId": "read_sandbox_diagnostics_api_v1_admin_sandboxes__sandbox_id__diagnostics__scope__get", "parameters": [ { "in": "path", "name": "sandbox_id", "required": true, "schema": { "title": "Sandbox Id", "type": "string" } }, { "in": "path", "name": "scope", "required": true, "schema": { "title": "Scope", "type": "string" } }, { "description": "Enabled sandbox backend; omitted selects the configured default.", "in": "query", "name": "backend", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AdminSandboxDiagnostics_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Read Sandbox Diagnostics", "tags": [ "Sandboxes" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/sandboxes/{sandbox_id}/security": { "get": { "description": "What this box reports about its own containment.\n\nAsked of the sandbox, not of the control plane: an operator opening\nthis panel wants to know whether the egress policy and the credential\nvault their deployment configured actually took effect, and an answer\nderived from that configuration cannot tell them. So every field is the\nbox's answer.\n\n``available: false`` is a finding, not a failure. It means no egress\nsidecar answered — the box has no egress policy and no vault, whatever\nwas intended — and it carries the reason. A backend that cannot ask a\nbox at all says so the same way, which an operator can tell apart from\nan uncontained box because the detail names the backend.\n\nCredentials appear by name only. The vault is write-only by\nconstruction; no stored value can be read back, here or anywhere.", "operationId": "read_sandbox_security_api_v1_admin_sandboxes__sandbox_id__security_get", "parameters": [ { "in": "path", "name": "sandbox_id", "required": true, "schema": { "title": "Sandbox Id", "type": "string" } }, { "description": "Enabled sandbox backend; omitted selects the configured default.", "in": "query", "name": "backend", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AdminSandboxSecurity_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Read Sandbox Security", "tags": [ "Sandboxes" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/sessions/all": { "get": { "operationId": "admin_list_all_sessions_api_v1_admin_sessions_all_get", "parameters": [ { "description": "Page number.", "in": "query", "name": "page", "required": false, "schema": { "default": 1, "type": "integer" } }, { "description": "Rows per page.", "in": "query", "name": "page_size", "required": false, "schema": { "default": 50, "type": "integer" } }, { "description": "Only this Agent's conversations.", "in": "query", "name": "agent_id", "required": false, "schema": { "type": "string" } }, { "description": "Inclusive Session creation-time lower bound (ISO 8601).", "in": "query", "name": "since", "required": false, "schema": { "type": "string" } }, { "description": "Inclusive Session creation-time upper bound (ISO 8601).", "in": "query", "name": "until", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AdminSessionPage_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Admin List All Sessions", "tags": [ "Admin" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/sessions/transcripts": { "get": { "description": "Stream every transcript the caller may manage as one gzip tar archive.\n\nEach session uses the SDK's directory layout, so untarring under\n``~/.claude/projects/`` makes its transcript resumable. The service applies\nowner scope and the requested agent/date filters in the session query.\n\nThe route writes and releases one session's files at a time instead of\nassembling the complete archive in memory. Sessions without mirrored\ntranscript entries are omitted.", "operationId": "admin_batch_session_transcripts_api_v1_admin_sessions_transcripts_get", "parameters": [ { "description": "Only this Agent's conversations.", "in": "query", "name": "agent_id", "required": false, "schema": { "type": "string" } }, { "description": "Inclusive Session creation-time lower bound (ISO 8601).", "in": "query", "name": "since", "required": false, "schema": { "type": "string" } }, { "description": "Inclusive Session creation-time upper bound (ISO 8601).", "in": "query", "name": "until", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/gzip": { "schema": { "format": "binary", "type": "string" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Admin Batch Session Transcripts", "tags": [ "Admin" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/sessions/{session_id}/detail": { "get": { "operationId": "admin_session_detail_api_v1_admin_sessions__session_id__detail_get", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AdminSessionDetail_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Admin Session Detail", "tags": [ "Admin" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/sessions/{session_id}/evict-runtime": { "post": { "description": "Evict cached runtime from memory (simulates request hitting a different machine).", "operationId": "admin_evict_runtime_api_v1_admin_sessions__session_id__evict_runtime_post", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AdminEvictResult_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Admin Evict Runtime", "tags": [ "Admin" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/sessions/{session_id}/history-import": { "post": { "description": "Import a migrated conversation's earlier messages, for reading only.\n\nNothing runs: no sandbox, command or turn. Import before the conversation's\nfirst message of its own; a session that already has one refuses with\n``HISTORY_IMPORT_AFTER_CONVERSATION``. A re-run of the same messages\nchanges nothing; other content under a used ``source_id``, or a new message\nplaced before imported ones, is ``HISTORY_IMPORT_CONFLICT``.", "operationId": "admin_import_session_history_api_v1_admin_sessions__session_id__history_import_post", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminHistoryImportRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AdminHistoryImportResult_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Admin Import Session History", "tags": [ "Admin" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/sessions/{session_id}/kill": { "post": { "operationId": "admin_kill_session_api_v1_admin_sessions__session_id__kill_post", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AdminKillResult_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Admin Kill Session", "tags": [ "Admin" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/sessions/{session_id}/trace": { "get": { "operationId": "admin_session_trace_api_v1_admin_sessions__session_id__trace_get", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } }, { "description": "Limit trace to this response.", "in": "query", "name": "response_id", "required": false, "schema": { "type": "string" } }, { "description": "Maximum messages in the trace.", "in": "query", "name": "message_limit", "required": false, "schema": { "default": 100, "type": "integer" } }, { "description": "Maximum output parts in the trace.", "in": "query", "name": "part_limit", "required": false, "schema": { "default": 500, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AdminSessionTrace_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Admin Session Trace", "tags": [ "Admin" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/sessions/{session_id}/transcript": { "get": { "description": "The session's transcript as the Claude Agent SDK stores it.\n\nA single ``.jsonl`` when the session has only its main\nconversation: dropped into any directory under ``~/.claude/projects/``,\n``claude --resume `` continues it. A ``.tar.gz`` preserving\nthe SDK's directory layout when subagent transcripts exist, because those\nare separate files and shipping only the main one would silently drop them.\n\nThe media type therefore follows the artifact rather than being fixed: the\ntwo cases are different files, and answering `.jsonl` for a session with\nsubagents would either misname the archive or drop the subagent\ntranscripts.", "operationId": "admin_session_transcript_api_v1_admin_sessions__session_id__transcript_get", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "responses": { "200": { "content": { "application/gzip": { "schema": { "format": "binary", "type": "string" } }, "application/x-ndjson": { "schema": { "format": "binary", "type": "string" } } }, "description": "One native JSONL transcript, or a gzip tar archive preserving all subagent transcripts." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Admin Session Transcript", "tags": [ "Admin" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/system/overview": { "get": { "operationId": "admin_system_overview_api_v1_admin_system_overview_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AdminSystemOverview_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Admin System Overview", "tags": [ "Admin" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/vaults": { "get": { "operationId": "list_vaults_api_v1_admin_vaults_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_VaultCatalog_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "List Vaults", "tags": [ "Vaults" ], "x-required-api-scope": "astrabox:admin" }, "post": { "operationId": "create_vault_api_v1_admin_vaults_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVaultRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_Vault_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Create Vault", "tags": [ "Vaults" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/vaults/{vault_id}": { "delete": { "operationId": "delete_vault_api_v1_admin_vaults__vault_id__delete", "parameters": [ { "in": "path", "name": "vault_id", "required": true, "schema": { "title": "Vault Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Delete Vault", "tags": [ "Vaults" ], "x-required-api-scope": "astrabox:admin" }, "get": { "operationId": "get_vault_api_v1_admin_vaults__vault_id__get", "parameters": [ { "in": "path", "name": "vault_id", "required": true, "schema": { "title": "Vault Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_Vault_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Get Vault", "tags": [ "Vaults" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/vaults/{vault_id}/archive": { "post": { "operationId": "archive_vault_api_v1_admin_vaults__vault_id__archive_post", "parameters": [ { "in": "path", "name": "vault_id", "required": true, "schema": { "title": "Vault Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_Vault_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Archive Vault", "tags": [ "Vaults" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/vaults/{vault_id}/bindings": { "get": { "operationId": "list_vault_bindings_api_v1_admin_vaults__vault_id__bindings_get", "parameters": [ { "in": "path", "name": "vault_id", "required": true, "schema": { "title": "Vault Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_list_VaultBindingHolder__" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "List Vault Bindings", "tags": [ "Vaults" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/vaults/{vault_id}/credentials": { "get": { "operationId": "list_credentials_api_v1_admin_vaults__vault_id__credentials_get", "parameters": [ { "in": "path", "name": "vault_id", "required": true, "schema": { "title": "Vault Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_VaultCredentialList_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "List Credentials", "tags": [ "Vaults" ], "x-required-api-scope": "astrabox:admin" }, "post": { "operationId": "create_credential_api_v1_admin_vaults__vault_id__credentials_post", "parameters": [ { "in": "path", "name": "vault_id", "required": true, "schema": { "title": "Vault Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCredentialRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_VaultCredential_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Create Credential", "tags": [ "Vaults" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/vaults/{vault_id}/credentials/{credential_id}": { "delete": { "operationId": "delete_credential_api_v1_admin_vaults__vault_id__credentials__credential_id__delete", "parameters": [ { "in": "path", "name": "vault_id", "required": true, "schema": { "title": "Vault Id", "type": "string" } }, { "in": "path", "name": "credential_id", "required": true, "schema": { "title": "Credential Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Delete Credential", "tags": [ "Vaults" ], "x-required-api-scope": "astrabox:admin" }, "patch": { "operationId": "update_credential_api_v1_admin_vaults__vault_id__credentials__credential_id__patch", "parameters": [ { "in": "path", "name": "vault_id", "required": true, "schema": { "title": "Vault Id", "type": "string" } }, { "in": "path", "name": "credential_id", "required": true, "schema": { "title": "Credential Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCredentialRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_VaultCredential_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Update Credential", "tags": [ "Vaults" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/admin/vaults/{vault_id}/credentials/{credential_id}/archive": { "post": { "operationId": "archive_credential_api_v1_admin_vaults__vault_id__credentials__credential_id__archive_post", "parameters": [ { "in": "path", "name": "vault_id", "required": true, "schema": { "title": "Vault Id", "type": "string" } }, { "in": "path", "name": "credential_id", "required": true, "schema": { "title": "Credential Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_VaultCredential_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Archive Credential", "tags": [ "Vaults" ], "x-required-api-scope": "astrabox:admin" } }, "/api/v1/agent-categories": { "get": { "operationId": "list_agent_categories_api_v1_agent_categories_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_list_AgentCategory__" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "List Agent Categories", "tags": [ "Agent Catalog" ], "x-required-api-scope": "astrabox:read" } }, "/api/v1/agent-configuration/runtime-profiles": { "get": { "description": "Secret-free RuntimeProfile choices for the Agent form.", "operationId": "list_agent_configuration_runtime_profiles_api_v1_agent_configuration_runtime_profiles_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_list_AgentRuntimeProfileOption__" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "List Agent Configuration Runtime Profiles", "tags": [ "Agents" ], "x-required-api-scope": "astrabox:read" } }, "/api/v1/agent-configuration/runtime-profiles/{name}/models": { "get": { "description": "Searchable model ids exposed by the chosen RuntimeProfile's gateway.", "operationId": "list_agent_configuration_models_api_v1_agent_configuration_runtime_profiles__name__models_get", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AgentRuntimeProfileModels_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "List Agent Configuration Models", "tags": [ "Agents" ], "x-required-api-scope": "astrabox:read" } }, "/api/v1/agent-configuration/schema": { "get": { "description": "Agent form structure for any signed-in Agent author.", "operationId": "get_agent_configuration_schema_api_v1_agent_configuration_schema_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AgentFormSchema_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Get Agent Configuration Schema", "tags": [ "Agents" ], "x-required-api-scope": "astrabox:read" } }, "/api/v1/agent-tags": { "get": { "operationId": "list_agent_tags_api_v1_agent_tags_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_list_AgentTag__" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "List Agent Tags", "tags": [ "Agent Catalog" ], "x-required-api-scope": "astrabox:read" } }, "/api/v1/agents": { "get": { "operationId": "list_agents_api_v1_agents_get", "parameters": [ { "description": "Set to 1 for a cursor page; omitted returns all visible Agents.", "in": "query", "name": "page", "required": false, "schema": { "enum": [ 1 ], "type": "integer" } }, { "description": "Page size, clamped to 1..100.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "type": "integer" } }, { "description": "Opaque next_cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Case-insensitive Agent search.", "in": "query", "name": "q", "required": false, "schema": { "type": "string" } }, { "description": "Agent availability filter.", "in": "query", "name": "status", "required": false, "schema": { "default": "all", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ApiEnvelope_AgentListPage_" }, { "$ref": "#/components/schemas/ApiEnvelope_list_AgentRecord__" } ], "title": "Response List Agents Api V1 Agents Get" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "List Agents", "tags": [ "Agents" ], "x-required-api-scope": "astrabox:read" }, "post": { "operationId": "create_agent_api_v1_agents_post", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "a2a_access": { "anyOf": [ { "enum": [ "disabled", "all", "selected" ], "type": "string" }, { "type": "null" } ], "default": "disabled" }, "a2a_agent_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] }, "artifacts_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true }, "categories": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] }, "default_repo": { "anyOf": [ { "additionalProperties": false, "properties": { "branch": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "deploy_key_secret_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "depth": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "protocol": { "anyOf": [ { "enum": [ "ssh", "https" ], "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "diff_panel": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "display_meta": { "additionalProperties": true, "properties": { "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] } }, "type": "object" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "engine_options": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ] }, "exposure_mode": { "anyOf": [ { "enum": [ "chat_only", "mcp_only", "both" ], "type": "string" }, { "type": "null" } ] }, "idle_hibernate_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "mcp_servers": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ] }, "model": { "type": "string" }, "name": { "type": "string" }, "packages": { "anyOf": [ { "items": { "additionalProperties": false, "properties": { "branch": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "deploy_key_secret_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "depth": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "kind": { "type": "string" }, "paths": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] }, "protocol": { "anyOf": [ { "enum": [ "ssh", "https" ], "type": "string" }, { "type": "null" } ] }, "sha": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "type": "string" } }, "required": [ "kind", "url" ], "type": "object" }, "type": "array" }, { "type": "null" } ] }, "prepared_capacity": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "runtime_profile_name": { "type": "string" }, "skills": { "anyOf": [ { "items": { "anyOf": [ { "type": "string" }, { "description": "A source declaration, with a relative directory and installed name.\n\n``config`` is validated by the selected provider. It must contain no secret\nmaterial: declarations are persisted and returned by the public API.", "properties": { "config": { "additionalProperties": { "type": "string" }, "title": "Config", "type": "object" }, "name": { "title": "Name", "type": "string" }, "path": { "default": "", "title": "Path", "type": "string" }, "provider": { "title": "Provider", "type": "string" }, "source": { "title": "Source", "type": "string" }, "version": { "title": "Version", "type": "string" } }, "required": [ "provider", "source", "version", "name" ], "title": "SkillSource", "type": "object" } ] }, "type": "array" }, { "type": "null" } ] }, "system": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "terminal_panel": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "use_cases": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] } }, "required": [ "name", "model", "runtime_profile_name" ], "title": "Payload", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AgentRecord_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Create Agent", "tags": [ "Agents" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/agents/{agent_id}": { "delete": { "operationId": "delete_agent_api_v1_agents__agent_id__delete", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AgentRecord_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Delete Agent", "tags": [ "Agents" ], "x-required-api-scope": "astrabox:write" }, "get": { "operationId": "get_agent_api_v1_agents__agent_id__get", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AgentRecord_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Get Agent", "tags": [ "Agents" ], "x-required-api-scope": "astrabox:read" }, "put": { "operationId": "update_agent_api_v1_agents__agent_id__put", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "a2a_access": { "anyOf": [ { "enum": [ "disabled", "all", "selected" ], "type": "string" }, { "type": "null" } ], "default": "disabled" }, "a2a_agent_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] }, "artifacts_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true }, "categories": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] }, "default_repo": { "anyOf": [ { "additionalProperties": false, "properties": { "branch": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "deploy_key_secret_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "depth": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "protocol": { "anyOf": [ { "enum": [ "ssh", "https" ], "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "diff_panel": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "display_meta": { "additionalProperties": true, "properties": { "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] } }, "type": "object" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "engine_options": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ] }, "exposure_mode": { "anyOf": [ { "enum": [ "chat_only", "mcp_only", "both" ], "type": "string" }, { "type": "null" } ] }, "idle_hibernate_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "mcp_servers": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ] }, "model": { "type": "string" }, "name": { "type": "string" }, "packages": { "anyOf": [ { "items": { "additionalProperties": false, "properties": { "branch": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "deploy_key_secret_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "depth": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "kind": { "type": "string" }, "paths": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] }, "protocol": { "anyOf": [ { "enum": [ "ssh", "https" ], "type": "string" }, { "type": "null" } ] }, "sha": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "type": "string" } }, "required": [ "kind", "url" ], "type": "object" }, "type": "array" }, { "type": "null" } ] }, "prepared_capacity": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "runtime_profile_name": { "type": "string" }, "skills": { "anyOf": [ { "items": { "anyOf": [ { "type": "string" }, { "description": "A source declaration, with a relative directory and installed name.\n\n``config`` is validated by the selected provider. It must contain no secret\nmaterial: declarations are persisted and returned by the public API.", "properties": { "config": { "additionalProperties": { "type": "string" }, "title": "Config", "type": "object" }, "name": { "title": "Name", "type": "string" }, "path": { "default": "", "title": "Path", "type": "string" }, "provider": { "title": "Provider", "type": "string" }, "source": { "title": "Source", "type": "string" }, "version": { "title": "Version", "type": "string" } }, "required": [ "provider", "source", "version", "name" ], "title": "SkillSource", "type": "object" } ] }, "type": "array" }, { "type": "null" } ] }, "system": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "terminal_panel": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "use_cases": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] }, "version": { "description": "Current optimistic-concurrency version from the Agent read.", "minimum": 1, "type": "integer" } }, "required": [ "name", "model", "runtime_profile_name" ], "title": "Payload", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AgentRecord_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Update Agent", "tags": [ "Agents" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/agents/{agent_id}/.well-known/agent-card.json": { "get": { "description": "A2A 1.0, implemented by a2a-sdk 1.2.2. Native protobuf JSON fields and error codes apply. Tenant routing and push notifications are refused. Requires an identity allowed to use the target Agent.", "externalDocs": { "url": "https://a2a-protocol.org/v1.0.0/specification/" }, "operationId": "agent_card__api_v1_agents__agent_id___well_known_agent_card_json_get", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/A2AAgentCard" } } }, "description": "Native AgentCard; capability fields describe what this Agent supports." }, "default": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Authentication/authorization rejection or native protocol error." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Discover Agent card", "tags": [ "A2A" ], "x-required-api-scope": "astrabox:read" } }, "/api/v1/agents/{agent_id}/a2a": { "post": { "description": "A2A 1.0, implemented by a2a-sdk 1.2.2. Native protobuf JSON fields and error codes apply. Tenant routing and push notifications are refused. Requires an identity allowed to use the target Agent.", "externalDocs": { "url": "https://a2a-protocol.org/v1.0.0/specification/" }, "operationId": "agent_a2a_rpc__api_v1_agents__agent_id__a2a_post", "parameters": [ { "in": "header", "name": "A2A-Version", "required": true, "schema": { "enum": [ "1.0" ], "type": "string" } }, { "in": "path", "name": "agent_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "additionalProperties": true, "properties": { "id": { "type": [ "string", "integer" ] }, "jsonrpc": { "const": "2.0" }, "method": { "const": "SendMessage" }, "params": { "$ref": "#/components/schemas/A2ASendMessageRequest" } }, "required": [ "jsonrpc", "id", "method", "params" ], "title": "SendMessage", "type": "object" }, { "additionalProperties": true, "properties": { "id": { "type": [ "string", "integer" ] }, "jsonrpc": { "const": "2.0" }, "method": { "const": "SendStreamingMessage" }, "params": { "$ref": "#/components/schemas/A2ASendMessageRequest" } }, "required": [ "jsonrpc", "id", "method", "params" ], "title": "SendStreamingMessage", "type": "object" }, { "additionalProperties": true, "properties": { "id": { "type": [ "string", "integer" ] }, "jsonrpc": { "const": "2.0" }, "method": { "const": "GetTask" }, "params": { "$ref": "#/components/schemas/A2AGetTaskRequest" } }, "required": [ "jsonrpc", "id", "method", "params" ], "title": "GetTask", "type": "object" }, { "additionalProperties": true, "properties": { "id": { "type": [ "string", "integer" ] }, "jsonrpc": { "const": "2.0" }, "method": { "const": "ListTasks" }, "params": { "$ref": "#/components/schemas/A2AListTasksRequest" } }, "required": [ "jsonrpc", "id", "method", "params" ], "title": "ListTasks", "type": "object" }, { "additionalProperties": true, "properties": { "id": { "type": [ "string", "integer" ] }, "jsonrpc": { "const": "2.0" }, "method": { "const": "CancelTask" }, "params": { "$ref": "#/components/schemas/A2ACancelTaskRequest" } }, "required": [ "jsonrpc", "id", "method", "params" ], "title": "CancelTask", "type": "object" }, { "additionalProperties": true, "properties": { "id": { "type": [ "string", "integer" ] }, "jsonrpc": { "const": "2.0" }, "method": { "const": "SubscribeToTask" }, "params": { "$ref": "#/components/schemas/A2ASubscribeToTaskRequest" } }, "required": [ "jsonrpc", "id", "method", "params" ], "title": "SubscribeToTask", "type": "object" }, { "additionalProperties": true, "properties": { "id": { "type": [ "string", "integer" ] }, "jsonrpc": { "const": "2.0" }, "method": { "const": "GetExtendedAgentCard" }, "params": { "$ref": "#/components/schemas/A2AGetExtendedAgentCardRequest" } }, "required": [ "jsonrpc", "id", "method", "params" ], "title": "GetExtendedAgentCard", "type": "object" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "properties": { "error": { "additionalProperties": true, "properties": { "code": { "type": "integer" }, "data": {}, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, "id": { "type": [ "string", "integer", "null" ] }, "jsonrpc": { "const": "2.0" }, "result": { "anyOf": [ { "$ref": "#/components/schemas/A2ASendMessageResponse" }, { "$ref": "#/components/schemas/A2ATask" }, { "$ref": "#/components/schemas/A2AListTasksResponse" }, { "$ref": "#/components/schemas/A2AAgentCard" } ] } }, "required": [ "jsonrpc", "id" ], "type": "object" } }, "text/event-stream": { "schema": { "description": "SSE data contains native JSON-RPC StreamResponse results.", "type": "string" } } }, "description": "JSON-RPC result/error, or SSE StreamResponse events for streaming methods." }, "default": { "content": { "application/json": { "schema": { "anyOf": [ { "additionalProperties": true, "properties": { "error": { "additionalProperties": true, "properties": { "code": { "type": "integer" }, "data": {}, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, "id": { "type": [ "string", "integer", "null" ] }, "jsonrpc": { "const": "2.0" }, "result": { "anyOf": [ { "$ref": "#/components/schemas/A2ASendMessageResponse" }, { "$ref": "#/components/schemas/A2ATask" }, { "$ref": "#/components/schemas/A2AListTasksResponse" }, { "$ref": "#/components/schemas/A2AAgentCard" } ] } }, "required": [ "jsonrpc", "id" ], "type": "object" }, { "$ref": "#/components/schemas/ErrorResponse" } ] } } }, "description": "Native JSON-RPC error or platform authentication/authorization rejection." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Call Agent through A2A", "tags": [ "A2A" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/agents/{agent_id}/access": { "get": { "operationId": "get_agent_access_api_v1_agents__agent_id__access_get", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AgentAccess_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Get Agent Access", "tags": [ "Agents" ], "x-required-api-scope": "astrabox:read" }, "put": { "operationId": "set_agent_access_api_v1_agents__agent_id__access_put", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetAgentAccessRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AgentAccess_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Set Agent Access", "tags": [ "Agents" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/agents/{agent_id}/connectors": { "get": { "operationId": "agent_connectors_api_v1_agents__agent_id__connectors_get", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AgentConnectorState_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Agent Connectors", "tags": [ "Connectors" ], "x-required-api-scope": "astrabox:read" } }, "/api/v1/agents/{agent_id}/connectors/{connector_id}": { "delete": { "operationId": "disable_agent_connector_api_v1_agents__agent_id__connectors__connector_id__delete", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } }, { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AgentConnectorState_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Disable Agent Connector", "tags": [ "Connectors" ], "x-required-api-scope": "astrabox:write" }, "put": { "operationId": "enable_agent_connector_api_v1_agents__agent_id__connectors__connector_id__put", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } }, { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AgentConnectorState_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Enable Agent Connector", "tags": [ "Connectors" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/agents/{agent_id}/conversations": { "post": { "operationId": "start_agent_conversation_api_v1_agents__agent_id__conversations_post", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } }, { "description": "Opaque retry key for one conversation-create operation.", "in": "header", "name": "Idempotency-Key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Opaque retry key for one conversation-create operation.", "title": "Idempotency-Key" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/StartConversationRequest" }, { "type": "null" } ], "title": " Body" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_StartedAgentConversation_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Start Agent Conversation", "tags": [ "Agents" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/agents/{agent_id}/extension-console/session": { "post": { "description": "Open the selected provider's management console for one Agent.", "operationId": "create_extension_console_session_api_v1_agents__agent_id__extension_console_session_post", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtensionConsoleSessionRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_ExtensionConsoleSession_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Create Extension Console Session", "tags": [ "Extensions" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/agents/{agent_id}/extensions": { "get": { "operationId": "get_agent_extensions_api_v1_agents__agent_id__extensions_get", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AgentExtensionCatalog_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Get Agent Extensions", "tags": [ "Extensions" ], "x-required-api-scope": "astrabox:read" }, "put": { "operationId": "set_agent_extensions_api_v1_agents__agent_id__extensions_put", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetAgentExtensionsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AgentExtensionCatalog_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Set Agent Extensions", "tags": [ "Extensions" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/agents/{agent_id}/favorite": { "delete": { "operationId": "unfavorite_agent_api_v1_agents__agent_id__favorite_delete", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AgentFavorite_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Unfavorite Agent", "tags": [ "Agent Catalog" ], "x-required-api-scope": "astrabox:write" }, "put": { "operationId": "favorite_agent_api_v1_agents__agent_id__favorite_put", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AgentFavorite_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Favorite Agent", "tags": [ "Agent Catalog" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/agents/{agent_id}/hibernate": { "post": { "operationId": "hibernate_agent_api_v1_agents__agent_id__hibernate_post", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AgentRecord_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Hibernate Agent", "tags": [ "Agents" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/agents/{agent_id}/prepared-runtime": { "get": { "description": "The platform unit, if any, waiting for this Agent's next Session.", "operationId": "get_agent_prepared_runtime_api_v1_agents__agent_id__prepared_runtime_get", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AgentPreparedRuntimeStatus_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Get Agent Prepared Runtime", "tags": [ "Agents" ], "x-required-api-scope": "astrabox:read" } }, "/api/v1/agents/{agent_id}/prepared-runtime/refresh": { "post": { "operationId": "refresh_agent_prepared_runtime_api_v1_agents__agent_id__prepared_runtime_refresh_post", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AgentPreparedRuntimeStatus_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Refresh Agent Prepared Runtime", "tags": [ "Agents" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/agents/{agent_id}/sessions": { "get": { "operationId": "list_agent_sessions_api_v1_agents__agent_id__sessions_get", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } }, { "description": "Maximum visible conversations to return, capped at 1000.", "in": "query", "name": "limit", "required": false, "schema": { "default": 500, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_list_SessionRecord__" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "List Agent Sessions", "tags": [ "Agents" ], "x-required-api-scope": "astrabox:read" } }, "/api/v1/agents/{agent_id}/wake": { "post": { "operationId": "wake_agent_api_v1_agents__agent_id__wake_post", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "title": "Agent Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AgentRecord_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Wake Agent", "tags": [ "Agents" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/artifact-share/{token}/runtime": { "get": { "operationId": "artifact_runtime_api_v1_artifact_share__token__runtime_get", "parameters": [ { "in": "path", "name": "token", "required": true, "schema": { "title": "Token", "type": "string" } }, { "in": "query", "name": "guest_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Guest Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_ArtifactRuntime_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Artifact Runtime", "tags": [ "Artifacts" ] } }, "/api/v1/artifact-share/{token}/runtime/agent-runs": { "post": { "operationId": "artifact_agent_run_api_v1_artifact_share__token__runtime_agent_runs_post", "parameters": [ { "in": "path", "name": "token", "required": true, "schema": { "title": "Token", "type": "string" } }, { "in": "query", "name": "guest_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Guest Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactAgentRunRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_ArtifactAgentRun_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Artifact Agent Run", "tags": [ "Artifacts" ] } }, "/api/v1/artifact-share/{token}/runtime/agent-runs/{run_id}": { "get": { "operationId": "artifact_agent_status_api_v1_artifact_share__token__runtime_agent_runs__run_id__get", "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } }, { "in": "path", "name": "token", "required": true, "schema": { "title": "Token", "type": "string" } }, { "in": "query", "name": "guest_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Guest Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_ArtifactAgentStatus_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Artifact Agent Status", "tags": [ "Artifacts" ] } }, "/api/v1/artifact-share/{token}/runtime/data-add": { "post": { "operationId": "artifact_data_add_api_v1_artifact_share__token__runtime_data_add_post", "parameters": [ { "in": "path", "name": "token", "required": true, "schema": { "title": "Token", "type": "string" } }, { "in": "query", "name": "guest_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Guest Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactAddRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_dict_str__Any__", "additionalProperties": true, "properties": { "code": { "type": "string" }, "data": { "additionalProperties": true, "properties": { "id": { "type": "string" }, "path": { "type": "string" } }, "type": "object" }, "message": { "type": "string" } }, "required": [ "code", "message", "data" ], "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Artifact Data Add", "tags": [ "Artifacts" ] } }, "/api/v1/artifact-share/{token}/runtime/data-query": { "post": { "operationId": "artifact_data_query_api_v1_artifact_share__token__runtime_data_query_post", "parameters": [ { "in": "path", "name": "token", "required": true, "schema": { "title": "Token", "type": "string" } }, { "in": "query", "name": "guest_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Guest Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactQueryRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_dict_str__Any__", "additionalProperties": true, "properties": { "code": { "type": "string" }, "data": { "additionalProperties": true, "properties": { "items": { "items": { "additionalProperties": true, "properties": { "data": { "additionalProperties": true, "type": "object" }, "id": { "type": "string" }, "path": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "message": { "type": "string" } }, "required": [ "code", "message", "data" ], "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Artifact Data Query", "tags": [ "Artifacts" ] } }, "/api/v1/artifact-share/{token}/runtime/data/{path}": { "delete": { "operationId": "artifact_data_delete_api_v1_artifact_share__token__runtime_data__path__delete", "parameters": [ { "in": "path", "name": "path", "required": true, "schema": { "title": "Path", "type": "string" } }, { "in": "path", "name": "token", "required": true, "schema": { "title": "Token", "type": "string" } }, { "in": "query", "name": "guest_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Guest Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_dict_str__Any__", "additionalProperties": true, "properties": { "code": { "type": "string" }, "data": { "additionalProperties": true, "properties": { "writes": { "items": { "additionalProperties": true, "properties": { "op": { "type": "string" }, "path": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "message": { "type": "string" } }, "required": [ "code", "message", "data" ], "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Artifact Data Delete", "tags": [ "Artifacts" ] }, "get": { "operationId": "artifact_data_get_api_v1_artifact_share__token__runtime_data__path__get", "parameters": [ { "in": "path", "name": "path", "required": true, "schema": { "title": "Path", "type": "string" } }, { "in": "path", "name": "token", "required": true, "schema": { "title": "Token", "type": "string" } }, { "in": "query", "name": "guest_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Guest Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_dict_str__Any__", "additionalProperties": true, "properties": { "code": { "type": "string" }, "data": { "additionalProperties": true, "properties": { "data": { "description": "Stored JSON document, or null when absent." }, "exists": { "type": "boolean" }, "path": { "type": "string" } }, "type": "object" }, "message": { "type": "string" } }, "required": [ "code", "message", "data" ], "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Artifact Data Get", "tags": [ "Artifacts" ] }, "patch": { "operationId": "artifact_data_update_api_v1_artifact_share__token__runtime_data__path__patch", "parameters": [ { "in": "path", "name": "path", "required": true, "schema": { "title": "Path", "type": "string" } }, { "in": "path", "name": "token", "required": true, "schema": { "title": "Token", "type": "string" } }, { "in": "query", "name": "guest_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Guest Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactDataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_dict_str__Any__", "additionalProperties": true, "properties": { "code": { "type": "string" }, "data": { "additionalProperties": true, "properties": { "writes": { "items": { "additionalProperties": true, "properties": { "op": { "type": "string" }, "path": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "message": { "type": "string" } }, "required": [ "code", "message", "data" ], "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Artifact Data Update", "tags": [ "Artifacts" ] }, "put": { "operationId": "artifact_data_set_api_v1_artifact_share__token__runtime_data__path__put", "parameters": [ { "in": "path", "name": "path", "required": true, "schema": { "title": "Path", "type": "string" } }, { "in": "path", "name": "token", "required": true, "schema": { "title": "Token", "type": "string" } }, { "in": "query", "name": "guest_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Guest Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactDataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_dict_str__Any__", "additionalProperties": true, "properties": { "code": { "type": "string" }, "data": { "additionalProperties": true, "properties": { "writes": { "items": { "additionalProperties": true, "properties": { "op": { "type": "string" }, "path": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "message": { "type": "string" } }, "required": [ "code", "message", "data" ], "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Artifact Data Set", "tags": [ "Artifacts" ] } }, "/api/v1/artifact-share/{token}/runtime/live": { "get": { "operationId": "artifact_live_api_v1_artifact_share__token__runtime_live_get", "parameters": [ { "in": "path", "name": "token", "required": true, "schema": { "title": "Token", "type": "string" } }, { "in": "query", "name": "after_seq", "required": false, "schema": { "default": 0, "minimum": 0, "title": "After Seq", "type": "integer" } }, { "in": "query", "name": "guest_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Guest Id" } } ], "responses": { "200": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "Server-sent events. See the Artifact runtime guide for event payloads and lifecycle." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Artifact Live", "tags": [ "Artifacts" ] } }, "/api/v1/artifact-share/{token}/runtime/publish": { "post": { "operationId": "artifact_publish_api_v1_artifact_share__token__runtime_publish_post", "parameters": [ { "in": "path", "name": "token", "required": true, "schema": { "title": "Token", "type": "string" } }, { "in": "query", "name": "guest_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Guest Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactPublishRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_ArtifactRecord_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Artifact Publish", "tags": [ "Artifacts" ] } }, "/api/v1/artifact-share/{token}/runtime/room/{room}/emit": { "post": { "operationId": "artifact_room_emit_api_v1_artifact_share__token__runtime_room__room__emit_post", "parameters": [ { "in": "path", "name": "room", "required": true, "schema": { "title": "Room", "type": "string" } }, { "in": "path", "name": "token", "required": true, "schema": { "title": "Token", "type": "string" } }, { "in": "query", "name": "guest_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Guest Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactRoomRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_dict_str__Any__", "additionalProperties": true, "properties": { "code": { "type": "string" }, "data": { "additionalProperties": true, "properties": { "seq": { "type": "integer" } }, "type": "object" }, "message": { "type": "string" } }, "required": [ "code", "message", "data" ], "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Artifact Room Emit", "tags": [ "Artifacts" ] } }, "/api/v1/artifact-share/{token}/runtime/room/{room}/presence": { "post": { "operationId": "artifact_room_presence_api_v1_artifact_share__token__runtime_room__room__presence_post", "parameters": [ { "in": "path", "name": "room", "required": true, "schema": { "title": "Room", "type": "string" } }, { "in": "path", "name": "token", "required": true, "schema": { "title": "Token", "type": "string" } }, { "in": "query", "name": "guest_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Guest Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactPresenceRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_dict_str__Any__", "additionalProperties": true, "properties": { "code": { "type": "string" }, "data": { "additionalProperties": true, "properties": { "seq": { "type": "integer" } }, "type": "object" }, "message": { "type": "string" } }, "required": [ "code", "message", "data" ], "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Artifact Room Presence", "tags": [ "Artifacts" ] } }, "/api/v1/artifact-share/{token}/runtime/sample": { "post": { "operationId": "artifact_sample_api_v1_artifact_share__token__runtime_sample_post", "parameters": [ { "in": "path", "name": "token", "required": true, "schema": { "title": "Token", "type": "string" } }, { "in": "query", "name": "guest_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Guest Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactSampleRequest" } } }, "required": true }, "responses": { "200": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "Server-sent events. See the Artifact runtime guide for event payloads and lifecycle." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Artifact Sample", "tags": [ "Artifacts" ] } }, "/api/v1/artifact-share/{token}/runtime/viewers": { "get": { "operationId": "artifact_viewers_api_v1_artifact_share__token__runtime_viewers_get", "parameters": [ { "in": "path", "name": "token", "required": true, "schema": { "title": "Token", "type": "string" } }, { "in": "query", "name": "ids", "required": false, "schema": { "default": "", "title": "Ids", "type": "string" } }, { "in": "query", "name": "guest_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Guest Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_dict_str__Any__", "additionalProperties": true, "properties": { "code": { "type": "string" }, "data": { "additionalProperties": true, "properties": { "profiles": { "items": { "additionalProperties": true, "properties": { "display_name": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "message": { "type": "string" } }, "required": [ "code", "message", "data" ], "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Artifact Viewers", "tags": [ "Artifacts" ] } }, "/api/v1/artifacts": { "get": { "operationId": "list_artifacts_api_v1_artifacts_get", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "session_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Session Id" } }, { "in": "query", "name": "assistant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assistant Id" } }, { "in": "query", "name": "q", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_ArtifactPage_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "List Artifacts", "tags": [ "Artifacts" ], "x-required-api-scope": "astrabox:read" } }, "/api/v1/artifacts/{artifact_id}": { "delete": { "operationId": "delete_artifact_api_v1_artifacts__artifact_id__delete", "parameters": [ { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_dict_str__bool__" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Delete Artifact", "tags": [ "Artifacts" ], "x-required-api-scope": "astrabox:write" }, "get": { "operationId": "get_artifact_api_v1_artifacts__artifact_id__get", "parameters": [ { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_ArtifactDetail_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Get Artifact", "tags": [ "Artifacts" ], "x-required-api-scope": "astrabox:read" }, "patch": { "operationId": "patch_artifact_api_v1_artifacts__artifact_id__patch", "parameters": [ { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactMetadataPatch" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_ArtifactRecord_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Patch Artifact", "tags": [ "Artifacts" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/artifacts/{artifact_id}/runtime": { "get": { "operationId": "artifact_runtime_api_v1_artifacts__artifact_id__runtime_get", "parameters": [ { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } }, { "in": "query", "name": "guest_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Guest Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_ArtifactRuntime_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Artifact Runtime", "tags": [ "Artifacts" ], "x-required-api-scope": "astrabox:read" } }, "/api/v1/artifacts/{artifact_id}/runtime/agent-runs": { "post": { "operationId": "artifact_agent_run_api_v1_artifacts__artifact_id__runtime_agent_runs_post", "parameters": [ { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } }, { "in": "query", "name": "guest_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Guest Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactAgentRunRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_ArtifactAgentRun_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Artifact Agent Run", "tags": [ "Artifacts" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/artifacts/{artifact_id}/runtime/agent-runs/{run_id}": { "get": { "operationId": "artifact_agent_status_api_v1_artifacts__artifact_id__runtime_agent_runs__run_id__get", "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } }, { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } }, { "in": "query", "name": "guest_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Guest Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_ArtifactAgentStatus_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Artifact Agent Status", "tags": [ "Artifacts" ], "x-required-api-scope": "astrabox:read" } }, "/api/v1/artifacts/{artifact_id}/runtime/data-add": { "post": { "operationId": "artifact_data_add_api_v1_artifacts__artifact_id__runtime_data_add_post", "parameters": [ { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } }, { "in": "query", "name": "guest_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Guest Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactAddRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_dict_str__Any__", "additionalProperties": true, "properties": { "code": { "type": "string" }, "data": { "additionalProperties": true, "properties": { "id": { "type": "string" }, "path": { "type": "string" } }, "type": "object" }, "message": { "type": "string" } }, "required": [ "code", "message", "data" ], "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Artifact Data Add", "tags": [ "Artifacts" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/artifacts/{artifact_id}/runtime/data-query": { "post": { "operationId": "artifact_data_query_api_v1_artifacts__artifact_id__runtime_data_query_post", "parameters": [ { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } }, { "in": "query", "name": "guest_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Guest Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactQueryRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_dict_str__Any__", "additionalProperties": true, "properties": { "code": { "type": "string" }, "data": { "additionalProperties": true, "properties": { "items": { "items": { "additionalProperties": true, "properties": { "data": { "additionalProperties": true, "type": "object" }, "id": { "type": "string" }, "path": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "message": { "type": "string" } }, "required": [ "code", "message", "data" ], "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Artifact Data Query", "tags": [ "Artifacts" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/artifacts/{artifact_id}/runtime/data/{path}": { "delete": { "operationId": "artifact_data_delete_api_v1_artifacts__artifact_id__runtime_data__path__delete", "parameters": [ { "in": "path", "name": "path", "required": true, "schema": { "title": "Path", "type": "string" } }, { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } }, { "in": "query", "name": "guest_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Guest Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_dict_str__Any__", "additionalProperties": true, "properties": { "code": { "type": "string" }, "data": { "additionalProperties": true, "properties": { "writes": { "items": { "additionalProperties": true, "properties": { "op": { "type": "string" }, "path": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "message": { "type": "string" } }, "required": [ "code", "message", "data" ], "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Artifact Data Delete", "tags": [ "Artifacts" ], "x-required-api-scope": "astrabox:write" }, "get": { "operationId": "artifact_data_get_api_v1_artifacts__artifact_id__runtime_data__path__get", "parameters": [ { "in": "path", "name": "path", "required": true, "schema": { "title": "Path", "type": "string" } }, { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } }, { "in": "query", "name": "guest_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Guest Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_dict_str__Any__", "additionalProperties": true, "properties": { "code": { "type": "string" }, "data": { "additionalProperties": true, "properties": { "data": { "description": "Stored JSON document, or null when absent." }, "exists": { "type": "boolean" }, "path": { "type": "string" } }, "type": "object" }, "message": { "type": "string" } }, "required": [ "code", "message", "data" ], "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Artifact Data Get", "tags": [ "Artifacts" ], "x-required-api-scope": "astrabox:read" }, "patch": { "operationId": "artifact_data_update_api_v1_artifacts__artifact_id__runtime_data__path__patch", "parameters": [ { "in": "path", "name": "path", "required": true, "schema": { "title": "Path", "type": "string" } }, { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } }, { "in": "query", "name": "guest_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Guest Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactDataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_dict_str__Any__", "additionalProperties": true, "properties": { "code": { "type": "string" }, "data": { "additionalProperties": true, "properties": { "writes": { "items": { "additionalProperties": true, "properties": { "op": { "type": "string" }, "path": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "message": { "type": "string" } }, "required": [ "code", "message", "data" ], "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Artifact Data Update", "tags": [ "Artifacts" ], "x-required-api-scope": "astrabox:write" }, "put": { "operationId": "artifact_data_set_api_v1_artifacts__artifact_id__runtime_data__path__put", "parameters": [ { "in": "path", "name": "path", "required": true, "schema": { "title": "Path", "type": "string" } }, { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } }, { "in": "query", "name": "guest_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Guest Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactDataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_dict_str__Any__", "additionalProperties": true, "properties": { "code": { "type": "string" }, "data": { "additionalProperties": true, "properties": { "writes": { "items": { "additionalProperties": true, "properties": { "op": { "type": "string" }, "path": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "message": { "type": "string" } }, "required": [ "code", "message", "data" ], "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Artifact Data Set", "tags": [ "Artifacts" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/artifacts/{artifact_id}/runtime/live": { "get": { "operationId": "artifact_live_api_v1_artifacts__artifact_id__runtime_live_get", "parameters": [ { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } }, { "in": "query", "name": "after_seq", "required": false, "schema": { "default": 0, "minimum": 0, "title": "After Seq", "type": "integer" } }, { "in": "query", "name": "guest_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Guest Id" } } ], "responses": { "200": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "Server-sent events. See the Artifact runtime guide for event payloads and lifecycle." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Artifact Live", "tags": [ "Artifacts" ], "x-required-api-scope": "astrabox:read" } }, "/api/v1/artifacts/{artifact_id}/runtime/publish": { "post": { "operationId": "artifact_publish_api_v1_artifacts__artifact_id__runtime_publish_post", "parameters": [ { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } }, { "in": "query", "name": "guest_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Guest Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactPublishRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_ArtifactRecord_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Artifact Publish", "tags": [ "Artifacts" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/artifacts/{artifact_id}/runtime/room/{room}/emit": { "post": { "operationId": "artifact_room_emit_api_v1_artifacts__artifact_id__runtime_room__room__emit_post", "parameters": [ { "in": "path", "name": "room", "required": true, "schema": { "title": "Room", "type": "string" } }, { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } }, { "in": "query", "name": "guest_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Guest Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactRoomRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_dict_str__Any__", "additionalProperties": true, "properties": { "code": { "type": "string" }, "data": { "additionalProperties": true, "properties": { "seq": { "type": "integer" } }, "type": "object" }, "message": { "type": "string" } }, "required": [ "code", "message", "data" ], "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Artifact Room Emit", "tags": [ "Artifacts" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/artifacts/{artifact_id}/runtime/room/{room}/presence": { "post": { "operationId": "artifact_room_presence_api_v1_artifacts__artifact_id__runtime_room__room__presence_post", "parameters": [ { "in": "path", "name": "room", "required": true, "schema": { "title": "Room", "type": "string" } }, { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } }, { "in": "query", "name": "guest_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Guest Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactPresenceRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_dict_str__Any__", "additionalProperties": true, "properties": { "code": { "type": "string" }, "data": { "additionalProperties": true, "properties": { "seq": { "type": "integer" } }, "type": "object" }, "message": { "type": "string" } }, "required": [ "code", "message", "data" ], "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Artifact Room Presence", "tags": [ "Artifacts" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/artifacts/{artifact_id}/runtime/sample": { "post": { "operationId": "artifact_sample_api_v1_artifacts__artifact_id__runtime_sample_post", "parameters": [ { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } }, { "in": "query", "name": "guest_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Guest Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactSampleRequest" } } }, "required": true }, "responses": { "200": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "Server-sent events. See the Artifact runtime guide for event payloads and lifecycle." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Artifact Sample", "tags": [ "Artifacts" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/artifacts/{artifact_id}/runtime/viewers": { "get": { "operationId": "artifact_viewers_api_v1_artifacts__artifact_id__runtime_viewers_get", "parameters": [ { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } }, { "in": "query", "name": "ids", "required": false, "schema": { "default": "", "title": "Ids", "type": "string" } }, { "in": "query", "name": "guest_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Guest Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_dict_str__Any__", "additionalProperties": true, "properties": { "code": { "type": "string" }, "data": { "additionalProperties": true, "properties": { "profiles": { "items": { "additionalProperties": true, "properties": { "display_name": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "message": { "type": "string" } }, "required": [ "code", "message", "data" ], "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Artifact Viewers", "tags": [ "Artifacts" ], "x-required-api-scope": "astrabox:read" } }, "/api/v1/artifacts/{artifact_id}/share": { "delete": { "operationId": "disable_artifact_share_api_v1_artifacts__artifact_id__share_delete", "parameters": [ { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_ArtifactShare_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Disable Artifact Share", "tags": [ "Artifacts" ], "x-required-api-scope": "astrabox:write" }, "get": { "operationId": "get_artifact_share_api_v1_artifacts__artifact_id__share_get", "parameters": [ { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_ArtifactShare_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Get Artifact Share", "tags": [ "Artifacts" ], "x-required-api-scope": "astrabox:read" }, "post": { "operationId": "enable_artifact_share_api_v1_artifacts__artifact_id__share_post", "parameters": [ { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactShareRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_ArtifactShare_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Enable Artifact Share", "tags": [ "Artifacts" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/artifacts/{artifact_id}/versions": { "get": { "operationId": "list_artifact_versions_api_v1_artifacts__artifact_id__versions_get", "parameters": [ { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_list_ArtifactVersionRecord__" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "List Artifact Versions", "tags": [ "Artifacts" ], "x-required-api-scope": "astrabox:read" } }, "/api/v1/artifacts/{artifact_id}/versions/{version}": { "get": { "operationId": "get_artifact_version_api_v1_artifacts__artifact_id__versions__version__get", "parameters": [ { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_ArtifactDetail_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Get Artifact Version", "tags": [ "Artifacts" ], "x-required-api-scope": "astrabox:read" } }, "/api/v1/artifacts/{artifact_id}/versions/{version}/restore": { "post": { "operationId": "restore_artifact_version_api_v1_artifacts__artifact_id__versions__version__restore_post", "parameters": [ { "in": "path", "name": "artifact_id", "required": true, "schema": { "title": "Artifact Id", "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "title": "Version", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_ArtifactRecord_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Restore Artifact Version", "tags": [ "Artifacts" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/assistant-a2a/{binding_id}/agents/{agent_id}": { "post": { "description": "A2A 1.0, implemented by a2a-sdk 1.2.2. Native protobuf JSON fields and error codes apply. Tenant routing and push notifications are refused. Requires the workspace-and-target-bound Assistant capability bearer.", "externalDocs": { "url": "https://a2a-protocol.org/v1.0.0/specification/" }, "operationId": "assistant_a2a_rpc__api_v1_assistant_a2a__binding_id__agents__agent_id__post", "parameters": [ { "in": "header", "name": "A2A-Version", "required": true, "schema": { "enum": [ "1.0" ], "type": "string" } }, { "in": "path", "name": "binding_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "agent_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "additionalProperties": true, "properties": { "id": { "type": [ "string", "integer" ] }, "jsonrpc": { "const": "2.0" }, "method": { "const": "SendMessage" }, "params": { "$ref": "#/components/schemas/A2ASendMessageRequest" } }, "required": [ "jsonrpc", "id", "method", "params" ], "title": "SendMessage", "type": "object" }, { "additionalProperties": true, "properties": { "id": { "type": [ "string", "integer" ] }, "jsonrpc": { "const": "2.0" }, "method": { "const": "SendStreamingMessage" }, "params": { "$ref": "#/components/schemas/A2ASendMessageRequest" } }, "required": [ "jsonrpc", "id", "method", "params" ], "title": "SendStreamingMessage", "type": "object" }, { "additionalProperties": true, "properties": { "id": { "type": [ "string", "integer" ] }, "jsonrpc": { "const": "2.0" }, "method": { "const": "GetTask" }, "params": { "$ref": "#/components/schemas/A2AGetTaskRequest" } }, "required": [ "jsonrpc", "id", "method", "params" ], "title": "GetTask", "type": "object" }, { "additionalProperties": true, "properties": { "id": { "type": [ "string", "integer" ] }, "jsonrpc": { "const": "2.0" }, "method": { "const": "ListTasks" }, "params": { "$ref": "#/components/schemas/A2AListTasksRequest" } }, "required": [ "jsonrpc", "id", "method", "params" ], "title": "ListTasks", "type": "object" }, { "additionalProperties": true, "properties": { "id": { "type": [ "string", "integer" ] }, "jsonrpc": { "const": "2.0" }, "method": { "const": "CancelTask" }, "params": { "$ref": "#/components/schemas/A2ACancelTaskRequest" } }, "required": [ "jsonrpc", "id", "method", "params" ], "title": "CancelTask", "type": "object" }, { "additionalProperties": true, "properties": { "id": { "type": [ "string", "integer" ] }, "jsonrpc": { "const": "2.0" }, "method": { "const": "SubscribeToTask" }, "params": { "$ref": "#/components/schemas/A2ASubscribeToTaskRequest" } }, "required": [ "jsonrpc", "id", "method", "params" ], "title": "SubscribeToTask", "type": "object" }, { "additionalProperties": true, "properties": { "id": { "type": [ "string", "integer" ] }, "jsonrpc": { "const": "2.0" }, "method": { "const": "GetExtendedAgentCard" }, "params": { "$ref": "#/components/schemas/A2AGetExtendedAgentCardRequest" } }, "required": [ "jsonrpc", "id", "method", "params" ], "title": "GetExtendedAgentCard", "type": "object" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "properties": { "error": { "additionalProperties": true, "properties": { "code": { "type": "integer" }, "data": {}, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, "id": { "type": [ "string", "integer", "null" ] }, "jsonrpc": { "const": "2.0" }, "result": { "anyOf": [ { "$ref": "#/components/schemas/A2ASendMessageResponse" }, { "$ref": "#/components/schemas/A2ATask" }, { "$ref": "#/components/schemas/A2AListTasksResponse" }, { "$ref": "#/components/schemas/A2AAgentCard" } ] } }, "required": [ "jsonrpc", "id" ], "type": "object" } }, "text/event-stream": { "schema": { "description": "SSE data contains native JSON-RPC StreamResponse results.", "type": "string" } } }, "description": "JSON-RPC result/error, or SSE StreamResponse events for streaming methods." }, "default": { "content": { "application/json": { "schema": { "anyOf": [ { "additionalProperties": true, "properties": { "error": { "additionalProperties": true, "properties": { "code": { "type": "integer" }, "data": {}, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, "id": { "type": [ "string", "integer", "null" ] }, "jsonrpc": { "const": "2.0" }, "result": { "anyOf": [ { "$ref": "#/components/schemas/A2ASendMessageResponse" }, { "$ref": "#/components/schemas/A2ATask" }, { "$ref": "#/components/schemas/A2AListTasksResponse" }, { "$ref": "#/components/schemas/A2AAgentCard" } ] } }, "required": [ "jsonrpc", "id" ], "type": "object" }, { "$ref": "#/components/schemas/ErrorResponse" } ] } } }, "description": "Native JSON-RPC error or platform authentication/authorization rejection." } }, "security": [ { "BearerAuth": [] } ], "summary": "Call Agent through A2A", "tags": [ "A2A" ] } }, "/api/v1/assistant-a2a/{binding_id}/agents/{agent_id}/.well-known/agent-card.json": { "get": { "description": "A2A 1.0, implemented by a2a-sdk 1.2.2. Native protobuf JSON fields and error codes apply. Tenant routing and push notifications are refused. Requires the workspace-and-target-bound Assistant capability bearer.", "externalDocs": { "url": "https://a2a-protocol.org/v1.0.0/specification/" }, "operationId": "agent_card__api_v1_assistant_a2a__binding_id__agents__agent_id___well_known_agent_card_json_get", "parameters": [ { "in": "path", "name": "binding_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "agent_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/A2AAgentCard" } } }, "description": "Native AgentCard; capability fields describe what this Agent supports." }, "default": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Authentication/authorization rejection or native protocol error." } }, "security": [ { "BearerAuth": [] } ], "summary": "Discover Agent card", "tags": [ "A2A" ] } }, "/api/v1/assistants": { "get": { "operationId": "list_assistants_api_v1_assistants_get", "parameters": [ { "description": "Set to 1 for a cursor page; omitted returns all owned Assistants.", "in": "query", "name": "page", "required": false, "schema": { "enum": [ 1 ], "type": "integer" } }, { "description": "Page size, clamped to 1..100.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "type": "integer" } }, { "description": "Opaque next_cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Assistant search.", "in": "query", "name": "q", "required": false, "schema": { "type": "string" } }, { "description": "Workspace-state filter.", "in": "query", "name": "status", "required": false, "schema": { "default": "all", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ApiEnvelope_AssistantListPage_" }, { "$ref": "#/components/schemas/ApiEnvelope_list_Assistant__" } ], "title": "Response List Assistants Api V1 Assistants Get" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "List Assistants", "tags": [ "Assistant" ], "x-required-api-scope": "astrabox:read" }, "post": { "operationId": "create_assistant_api_v1_assistants_post", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "properties": { "description": { "type": [ "string", "null" ] }, "display_name": { "type": "string" }, "engine_kind": { "description": "If supplied, must match the RuntimeProfile's Assistant-capable program.", "type": "string" }, "engine_options": { "additionalProperties": true, "description": "Configuration owned and validated by the selected program.", "type": "object" }, "icon": { "type": [ "string", "null" ] }, "mcp_servers": { "additionalProperties": true, "description": "Name-keyed native MCP server declarations.", "type": "object" }, "model_config_override": { "additionalProperties": false, "properties": { "model_name": { "type": "string" } }, "type": "object" }, "packages": { "description": "Package declarations accepted by the installed program.", "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "permission_mode_default": { "description": "A permission mode declared by the Environment's program.", "type": "string" }, "runtime_profile_name": { "type": "string" }, "skills": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "items": { "anyOf": [ { "type": "string" }, { "description": "A source declaration, with a relative directory and installed name.\n\n``config`` is validated by the selected provider. It must contain no secret\nmaterial: declarations are persisted and returned by the public API.", "properties": { "config": { "additionalProperties": { "type": "string" }, "title": "Config", "type": "object" }, "name": { "title": "Name", "type": "string" }, "path": { "default": "", "title": "Path", "type": "string" }, "provider": { "title": "Provider", "type": "string" }, "source": { "title": "Source", "type": "string" }, "version": { "title": "Version", "type": "string" } }, "required": [ "provider", "source", "version", "name" ], "title": "SkillSource", "type": "object" } ] }, "type": "array" } ], "description": "Skill Git URLs or provider source descriptors; a single URL is accepted as shorthand for one entry." }, "system": { "type": [ "string", "null" ] }, "timezone": { "type": "string" } }, "required": [ "display_name", "runtime_profile_name" ], "title": "Payload", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_Assistant_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Create Assistant", "tags": [ "Assistant" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/assistants/primary": { "post": { "operationId": "ensure_primary_assistant_api_v1_assistants_primary_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnsurePrimaryAssistantRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_Assistant_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Ensure Primary Assistant", "tags": [ "Assistant" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/assistants/{assistant_id}": { "delete": { "operationId": "delete_assistant_api_v1_assistants__assistant_id__delete", "parameters": [ { "in": "path", "name": "assistant_id", "required": true, "schema": { "title": "Assistant Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AssistantDeletion_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Delete Assistant", "tags": [ "Assistant" ], "x-required-api-scope": "astrabox:write" }, "get": { "operationId": "get_assistant_api_v1_assistants__assistant_id__get", "parameters": [ { "in": "path", "name": "assistant_id", "required": true, "schema": { "title": "Assistant Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_Assistant_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Get Assistant", "tags": [ "Assistant" ], "x-required-api-scope": "astrabox:read" }, "patch": { "operationId": "update_assistant_api_v1_assistants__assistant_id__patch", "parameters": [ { "in": "path", "name": "assistant_id", "required": true, "schema": { "title": "Assistant Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "description": "Partial update. RuntimeProfile and program are fixed after workspace materialization; unsupported update keys are ignored by the existing service.", "properties": { "description": { "type": [ "string", "null" ] }, "display_name": { "type": "string" }, "engine_options": { "additionalProperties": true, "description": "Configuration owned and validated by the selected program.", "type": "object" }, "icon": { "type": [ "string", "null" ] }, "mcp_servers": { "additionalProperties": true, "description": "Name-keyed native MCP server declarations.", "type": "object" }, "model_config_override": { "additionalProperties": false, "properties": { "model_name": { "type": "string" } }, "type": "object" }, "packages": { "description": "Package declarations accepted by the installed program.", "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "permission_mode_default": { "description": "A permission mode declared by the Environment's program.", "type": "string" }, "skills": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "items": { "anyOf": [ { "type": "string" }, { "description": "A source declaration, with a relative directory and installed name.\n\n``config`` is validated by the selected provider. It must contain no secret\nmaterial: declarations are persisted and returned by the public API.", "properties": { "config": { "additionalProperties": { "type": "string" }, "title": "Config", "type": "object" }, "name": { "title": "Name", "type": "string" }, "path": { "default": "", "title": "Path", "type": "string" }, "provider": { "title": "Provider", "type": "string" }, "source": { "title": "Source", "type": "string" }, "version": { "title": "Version", "type": "string" } }, "required": [ "provider", "source", "version", "name" ], "title": "SkillSource", "type": "object" } ] }, "type": "array" } ], "description": "Skill Git URLs or provider source descriptors; a single URL is accepted as shorthand for one entry." }, "system": { "type": [ "string", "null" ] }, "timezone": { "type": "string" } }, "title": "Payload", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_Assistant_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Update Assistant", "tags": [ "Assistant" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/assistants/{assistant_id}/connectors": { "get": { "operationId": "assistant_connectors_api_v1_assistants__assistant_id__connectors_get", "parameters": [ { "in": "path", "name": "assistant_id", "required": true, "schema": { "title": "Assistant Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AssistantConnectorState_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Assistant Connectors", "tags": [ "Connectors" ], "x-required-api-scope": "astrabox:read" } }, "/api/v1/assistants/{assistant_id}/connectors/{connector_id}": { "delete": { "operationId": "disable_assistant_connector_api_v1_assistants__assistant_id__connectors__connector_id__delete", "parameters": [ { "in": "path", "name": "assistant_id", "required": true, "schema": { "title": "Assistant Id", "type": "string" } }, { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AssistantConnectorState_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Disable Assistant Connector", "tags": [ "Connectors" ], "x-required-api-scope": "astrabox:write" }, "put": { "operationId": "enable_assistant_connector_api_v1_assistants__assistant_id__connectors__connector_id__put", "parameters": [ { "in": "path", "name": "assistant_id", "required": true, "schema": { "title": "Assistant Id", "type": "string" } }, { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AssistantConnectorState_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Enable Assistant Connector", "tags": [ "Connectors" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/assistants/{assistant_id}/conversations": { "post": { "operationId": "start_assistant_conversation_api_v1_assistants__assistant_id__conversations_post", "parameters": [ { "in": "path", "name": "assistant_id", "required": true, "schema": { "title": "Assistant Id", "type": "string" } }, { "description": "Opaque retry key for one conversation-create operation.", "in": "header", "name": "Idempotency-Key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Opaque retry key for one conversation-create operation.", "title": "Idempotency-Key" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/StartConversationRequest" }, { "type": "null" } ], "title": " Body" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_StartedAssistantConversation_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Start Assistant Conversation", "tags": [ "Assistant" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/assistants/{assistant_id}/deployments": { "get": { "operationId": "list_assistant_deployments_api_v1_assistants__assistant_id__deployments_get", "parameters": [ { "in": "path", "name": "assistant_id", "required": true, "schema": { "title": "Assistant Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_list_DeploymentRecord__" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "List Assistant Deployments", "tags": [ "Deployments" ], "x-required-api-scope": "astrabox:read" }, "post": { "operationId": "create_assistant_deployment_api_v1_assistants__assistant_id__deployments_post", "parameters": [ { "in": "path", "name": "assistant_id", "required": true, "schema": { "title": "Assistant Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "properties": { "allowed_participants": { "items": { "type": "string" }, "type": "array" }, "attention_policy": { "description": "Attention policy supported by the installed channel provider.", "type": "string" }, "channel_config": { "additionalProperties": true, "description": "Fields from the selected channel provider's config_fields catalog.", "type": "object" }, "credentials": { "additionalProperties": { "type": "string" }, "description": "Private values from that provider's credential_fields catalog; reads return masks.", "type": "object" }, "enabled": { "type": "boolean" }, "execution_mode": { "description": "One execution_modes value from the selected channel provider.", "type": "string" }, "execution_user_id": { "description": "Account execution subject; configuring it requires platform administration.", "type": "string" }, "name": { "type": "string" }, "prompt_prefix": { "type": "string" }, "response_instruction": { "type": "string" }, "scene": { "description": "Installed trigger scene: a webhook, schedule, or channel provider's advertised scene.", "type": "string" }, "schedule": { "additionalProperties": true, "description": "Recurring schedule: five cron fields and an IANA timezone.", "properties": { "cron": { "type": "string" }, "timezone": { "type": "string" } }, "type": "object" }, "secret": { "description": "Trigger secret where the selected scene uses one.", "type": [ "string", "null" ] } }, "required": [ "scene" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_DeploymentRecord_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Create Assistant Deployment", "tags": [ "Deployments" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/assistants/{assistant_id}/deployments/{deployment_id}": { "delete": { "operationId": "delete_assistant_deployment_api_v1_assistants__assistant_id__deployments__deployment_id__delete", "parameters": [ { "in": "path", "name": "assistant_id", "required": true, "schema": { "title": "Assistant Id", "type": "string" } }, { "in": "path", "name": "deployment_id", "required": true, "schema": { "title": "Deployment Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_DeletedDeployment_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Delete Assistant Deployment", "tags": [ "Deployments" ], "x-required-api-scope": "astrabox:write" }, "put": { "operationId": "update_assistant_deployment_api_v1_assistants__assistant_id__deployments__deployment_id__put", "parameters": [ { "in": "path", "name": "assistant_id", "required": true, "schema": { "title": "Assistant Id", "type": "string" } }, { "in": "path", "name": "deployment_id", "required": true, "schema": { "title": "Deployment Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "description": "Partial update of a trigger binding; authorization and scene validation remain server-side.", "properties": { "allowed_participants": { "items": { "type": "string" }, "type": "array" }, "attention_policy": { "description": "Attention policy supported by the installed channel provider.", "type": "string" }, "channel_config": { "additionalProperties": true, "description": "Fields from the selected channel provider's config_fields catalog.", "type": "object" }, "credentials": { "additionalProperties": { "type": "string" }, "description": "Private values from that provider's credential_fields catalog; reads return masks.", "type": "object" }, "enabled": { "type": "boolean" }, "execution_mode": { "description": "One execution_modes value from the selected channel provider.", "type": "string" }, "execution_user_id": { "description": "Account execution subject; configuring it requires platform administration.", "type": "string" }, "name": { "type": "string" }, "prompt_prefix": { "type": "string" }, "response_instruction": { "type": "string" }, "scene": { "description": "Installed trigger scene: a webhook, schedule, or channel provider's advertised scene.", "type": "string" }, "schedule": { "additionalProperties": true, "description": "Recurring schedule: five cron fields and an IANA timezone.", "properties": { "cron": { "type": "string" }, "timezone": { "type": "string" } }, "type": "object" }, "secret": { "description": "Trigger secret where the selected scene uses one.", "type": [ "string", "null" ] } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_DeploymentRecord_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Update Assistant Deployment", "tags": [ "Deployments" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/assistants/{assistant_id}/deployments/{deployment_id}/runs": { "get": { "operationId": "list_assistant_deployment_runs_api_v1_assistants__assistant_id__deployments__deployment_id__runs_get", "parameters": [ { "in": "path", "name": "assistant_id", "required": true, "schema": { "title": "Assistant Id", "type": "string" } }, { "in": "path", "name": "deployment_id", "required": true, "schema": { "title": "Deployment Id", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_list_DeploymentRun__" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "List Assistant Deployment Runs", "tags": [ "Deployments" ], "x-required-api-scope": "astrabox:read" }, "post": { "operationId": "trigger_assistant_deployment_run_api_v1_assistants__assistant_id__deployments__deployment_id__runs_post", "parameters": [ { "in": "path", "name": "assistant_id", "required": true, "schema": { "title": "Assistant Id", "type": "string" } }, { "in": "path", "name": "deployment_id", "required": true, "schema": { "title": "Deployment Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_DeploymentRun_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Trigger Assistant Deployment Run", "tags": [ "Deployments" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/assistants/{assistant_id}/deployments/{deployment_id}/runs/{run_id}/replay": { "post": { "operationId": "replay_assistant_deployment_run_api_v1_assistants__assistant_id__deployments__deployment_id__runs__run_id__replay_post", "parameters": [ { "in": "path", "name": "assistant_id", "required": true, "schema": { "title": "Assistant Id", "type": "string" } }, { "in": "path", "name": "deployment_id", "required": true, "schema": { "title": "Deployment Id", "type": "string" } }, { "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_DeploymentRun_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Replay Assistant Deployment Run", "tags": [ "Deployments" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/assistants/{assistant_id}/extensions": { "get": { "operationId": "get_assistant_extensions_api_v1_assistants__assistant_id__extensions_get", "parameters": [ { "in": "path", "name": "assistant_id", "required": true, "schema": { "title": "Assistant Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AssistantExtensionCatalog_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Get Assistant Extensions", "tags": [ "Extensions" ], "x-required-api-scope": "astrabox:read" }, "put": { "operationId": "set_assistant_extensions_api_v1_assistants__assistant_id__extensions_put", "parameters": [ { "in": "path", "name": "assistant_id", "required": true, "schema": { "title": "Assistant Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetAgentExtensionsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AssistantExtensionCatalog_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Set Assistant Extensions", "tags": [ "Extensions" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/assistants/{assistant_id}/main-conversation": { "post": { "operationId": "open_main_conversation_api_v1_assistants__assistant_id__main_conversation_post", "parameters": [ { "in": "path", "name": "assistant_id", "required": true, "schema": { "title": "Assistant Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_StartedAssistantConversation_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Open Main Conversation", "tags": [ "Assistant" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/assistants/{assistant_id}/workspace": { "delete": { "operationId": "destroy_workspace_api_v1_assistants__assistant_id__workspace_delete", "parameters": [ { "in": "path", "name": "assistant_id", "required": true, "schema": { "title": "Assistant Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AssistantWorkspaceDestruction_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Destroy Workspace", "tags": [ "Assistant" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/assistants/{assistant_id}/workspace/hibernate": { "post": { "operationId": "hibernate_workspace_api_v1_assistants__assistant_id__workspace_hibernate_post", "parameters": [ { "in": "path", "name": "assistant_id", "required": true, "schema": { "title": "Assistant Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AssistantWorkspaceHibernation_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Hibernate Workspace", "tags": [ "Assistant" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/assistants/{assistant_id}/workspace/wake": { "post": { "operationId": "wake_workspace_api_v1_assistants__assistant_id__workspace_wake_post", "parameters": [ { "in": "path", "name": "assistant_id", "required": true, "schema": { "title": "Assistant Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AssistantWorkspace_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Wake Workspace", "tags": [ "Assistant" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/auth/callback": { "get": { "operationId": "auth_callback_api_v1_auth_callback_get", "parameters": [ { "description": "OIDC authorization response parameter.", "in": "query", "name": "code", "required": false, "schema": { "type": "string" } }, { "description": "OIDC authorization response parameter.", "in": "query", "name": "state", "required": false, "schema": { "type": "string" } }, { "description": "OIDC authorization response parameter.", "in": "query", "name": "error", "required": false, "schema": { "type": "string" } }, { "description": "OIDC authorization response parameter.", "in": "query", "name": "error_description", "required": false, "schema": { "type": "string" } }, { "description": "Signed state/PKCE flow cookie required on successful callbacks.", "in": "cookie", "name": "astrabox_auth_flow", "required": false, "schema": { "type": "string" } } ], "responses": { "302": { "description": "Redirect to the console; sets astrabox_session and deletes the flow cookie." }, "400": { "content": { "application/json": { "schema": { "additionalProperties": true, "properties": { "code": { "const": "AUTH_FLOW_FAILED" }, "message": { "type": "string" }, "success": { "const": false, "type": "boolean" } }, "required": [ "success", "code", "message" ], "type": "object" } } }, "description": "OIDC flow failed." }, "401": { "content": { "application/json": { "schema": { "additionalProperties": true, "properties": { "code": { "const": "AUTH_FLOW_FAILED" }, "message": { "type": "string" }, "success": { "const": false, "type": "boolean" } }, "required": [ "success", "code", "message" ], "type": "object" } } }, "description": "OIDC flow failed." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "502": { "content": { "application/json": { "schema": { "additionalProperties": true, "properties": { "code": { "const": "AUTH_FLOW_FAILED" }, "message": { "type": "string" }, "success": { "const": false, "type": "boolean" } }, "required": [ "success", "code", "message" ], "type": "object" } } }, "description": "OIDC flow failed." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Auth Callback", "tags": [ "Auth" ], "x-configuration": "ASTRABOX_WEB_IDENTITY=oidc" } }, "/api/v1/auth/login": { "get": { "operationId": "auth_login_api_v1_auth_login_get", "parameters": [ { "description": "Console path to visit after login; external URLs are refused.", "in": "query", "name": "next", "required": false, "schema": { "default": "/", "type": "string" } } ], "responses": { "302": { "description": "Redirect to the IdP; sets the signed astrabox_auth_flow PKCE/state cookie.", "headers": { "Location": { "schema": { "type": "string" } }, "Set-Cookie": { "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Auth Login", "tags": [ "Auth" ], "x-configuration": "ASTRABOX_WEB_IDENTITY=oidc" } }, "/api/v1/auth/logout": { "post": { "operationId": "auth_logout_api_v1_auth_logout_post", "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Auth Logout", "tags": [ "Auth" ], "x-configuration": "ASTRABOX_WEB_IDENTITY=oidc" } }, "/api/v1/auth/session": { "get": { "description": "Session probe for the console: which user, if any. Never 401s —\nthe frontend uses it to decide whether to show the sign-in state.", "operationId": "auth_session_api_v1_auth_session_get", "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "additionalProperties": true, "properties": { "authenticated": { "const": false } }, "required": [ "authenticated" ], "type": "object" }, { "additionalProperties": true, "properties": { "authenticated": { "const": true }, "user": { "additionalProperties": true, "properties": { "display_name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "roles": { "items": { "type": "string" }, "type": "array" }, "user_id": { "type": "string" } }, "required": [ "user_id", "display_name", "email", "roles" ], "type": "object" } }, "required": [ "authenticated", "user" ], "type": "object" } ] } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Auth Session", "tags": [ "Auth" ], "x-configuration": "ASTRABOX_WEB_IDENTITY=oidc" } }, "/api/v1/channel-providers": { "get": { "operationId": "list_channel_providers_for_owner_api_v1_channel_providers_get", "parameters": [ { "in": "query", "name": "agent_id", "required": false, "schema": { "default": "", "title": "Agent Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_list_ChannelProviderRecord__" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "List Channel Providers For Owner", "tags": [ "Deployments" ], "x-required-api-scope": "astrabox:read" } }, "/api/v1/connectors": { "get": { "operationId": "list_connectors_api_v1_connectors_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_list_Connector__" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "List Connectors", "tags": [ "Connectors" ], "x-required-api-scope": "astrabox:read" } }, "/api/v1/connectors/{connector_id}/assistants": { "post": { "operationId": "offer_connector_in_assistants_api_v1_connectors__connector_id__assistants_post", "parameters": [ { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AdoptedConnector_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Offer Connector In Assistants", "tags": [ "Connectors" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/connectors/{connector_id}/authorize": { "post": { "operationId": "authorize_connector_api_v1_connectors__connector_id__authorize_post", "parameters": [ { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_AuthorizeResponse_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Authorize Connector", "tags": [ "Connectors" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/connectors/{connector_id}/connection": { "delete": { "operationId": "disconnect_connector_api_v1_connectors__connector_id__connection_delete", "parameters": [ { "in": "path", "name": "connector_id", "required": true, "schema": { "title": "Connector Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "properties": { "code": { "type": "string" }, "data": { "additionalProperties": true, "properties": { "connector_id": { "type": "string" }, "removed": { "type": "boolean" } }, "required": [ "connector_id", "removed" ], "type": "object" }, "message": { "type": "string" } }, "required": [ "code", "message", "data" ], "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Disconnect Connector", "tags": [ "Connectors" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/deployments/{deployment_id}/callback/{callback_path}": { "delete": { "description": "Provider-owned callback path, query, headers, authentication, body and status. Bytes are forwarded unchanged to the provider advertised by /api/v1/channel-providers; use its documentation_url and callback_path.", "operationId": "channel_callback__api_v1_deployments__deployment_id__callback__callback_path__delete", "parameters": [ { "in": "path", "name": "deployment_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "callback_path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "format": "binary", "type": "string" } } }, "required": false }, "responses": { "default": { "content": { "*/*": { "schema": { "format": "binary", "type": "string" } } }, "description": "Provider-owned status, headers and raw response body." } }, "summary": "Forward a channel provider callback", "tags": [ "Channels" ] }, "get": { "description": "Provider-owned callback path, query, headers, authentication, body and status. Bytes are forwarded unchanged to the provider advertised by /api/v1/channel-providers; use its documentation_url and callback_path.", "operationId": "channel_callback__api_v1_deployments__deployment_id__callback__callback_path__get", "parameters": [ { "in": "path", "name": "deployment_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "callback_path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "format": "binary", "type": "string" } } }, "required": false }, "responses": { "default": { "content": { "*/*": { "schema": { "format": "binary", "type": "string" } } }, "description": "Provider-owned status, headers and raw response body." } }, "summary": "Forward a channel provider callback", "tags": [ "Channels" ] }, "head": { "description": "Provider-owned callback path, query, headers, authentication, body and status. Bytes are forwarded unchanged to the provider advertised by /api/v1/channel-providers; use its documentation_url and callback_path.", "operationId": "channel_callback__api_v1_deployments__deployment_id__callback__callback_path__head", "parameters": [ { "in": "path", "name": "deployment_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "callback_path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "format": "binary", "type": "string" } } }, "required": false }, "responses": { "default": { "content": { "*/*": { "schema": { "format": "binary", "type": "string" } } }, "description": "Provider-owned status, headers and raw response body." } }, "summary": "Forward a channel provider callback", "tags": [ "Channels" ] }, "options": { "description": "Provider-owned callback path, query, headers, authentication, body and status. Bytes are forwarded unchanged to the provider advertised by /api/v1/channel-providers; use its documentation_url and callback_path.", "operationId": "channel_callback__api_v1_deployments__deployment_id__callback__callback_path__options", "parameters": [ { "in": "path", "name": "deployment_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "callback_path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "format": "binary", "type": "string" } } }, "required": false }, "responses": { "default": { "content": { "*/*": { "schema": { "format": "binary", "type": "string" } } }, "description": "Provider-owned status, headers and raw response body." } }, "summary": "Forward a channel provider callback", "tags": [ "Channels" ] }, "patch": { "description": "Provider-owned callback path, query, headers, authentication, body and status. Bytes are forwarded unchanged to the provider advertised by /api/v1/channel-providers; use its documentation_url and callback_path.", "operationId": "channel_callback__api_v1_deployments__deployment_id__callback__callback_path__patch", "parameters": [ { "in": "path", "name": "deployment_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "callback_path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "format": "binary", "type": "string" } } }, "required": false }, "responses": { "default": { "content": { "*/*": { "schema": { "format": "binary", "type": "string" } } }, "description": "Provider-owned status, headers and raw response body." } }, "summary": "Forward a channel provider callback", "tags": [ "Channels" ] }, "post": { "description": "Provider-owned callback path, query, headers, authentication, body and status. Bytes are forwarded unchanged to the provider advertised by /api/v1/channel-providers; use its documentation_url and callback_path.", "operationId": "channel_callback__api_v1_deployments__deployment_id__callback__callback_path__post", "parameters": [ { "in": "path", "name": "deployment_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "callback_path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "format": "binary", "type": "string" } } }, "required": false }, "responses": { "default": { "content": { "*/*": { "schema": { "format": "binary", "type": "string" } } }, "description": "Provider-owned status, headers and raw response body." } }, "summary": "Forward a channel provider callback", "tags": [ "Channels" ] }, "put": { "description": "Provider-owned callback path, query, headers, authentication, body and status. Bytes are forwarded unchanged to the provider advertised by /api/v1/channel-providers; use its documentation_url and callback_path.", "operationId": "channel_callback__api_v1_deployments__deployment_id__callback__callback_path__put", "parameters": [ { "in": "path", "name": "deployment_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "callback_path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "format": "binary", "type": "string" } } }, "required": false }, "responses": { "default": { "content": { "*/*": { "schema": { "format": "binary", "type": "string" } } }, "description": "Provider-owned status, headers and raw response body." } }, "summary": "Forward a channel provider callback", "tags": [ "Channels" ] } }, "/api/v1/deployments/{deployment_id}/trigger": { "post": { "description": "Authenticate with the configured trigger scene: HMAC webhook headers or the native channel provider credential. Request bytes follow that scene; see the webhook and channel guides.", "operationId": "trigger_deployment_api_v1_deployments__deployment_id__trigger_post", "parameters": [ { "in": "path", "name": "deployment_id", "required": true, "schema": { "title": "Deployment Id", "type": "string" } }, { "description": "Required by the HMAC webhook scene.", "in": "header", "name": "X-Webhook-Timestamp", "required": false, "schema": { "type": "string" } }, { "description": "Required by the HMAC webhook scene.", "in": "header", "name": "X-Webhook-Signature", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "format": "binary", "type": "string" } }, "application/json": { "schema": { "description": "Webhook JSON event; provider scenes define their own payload." } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_DeploymentTriggerAck_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Trigger Deployment", "tags": [ "Deployments" ] } }, "/api/v1/environments": { "get": { "operationId": "list_accessible_environments_api_v1_environments_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_list_EnvironmentView__" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "List Accessible Environments", "tags": [ "Environments" ], "x-required-api-scope": "astrabox:read" } }, "/api/v1/environments/current": { "get": { "operationId": "get_current_environment_api_v1_environments_current_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_CurrentEnvironment_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Get Current Environment", "tags": [ "Environments" ], "x-required-api-scope": "astrabox:read" } }, "/api/v1/exposed-ports/{deployment_id}/{port}/url": { "get": { "description": "Return a fresh browser-reachable URL for a sandbox port.\n\nThe request itself is authenticated and ownership-checked before the\nplatform mints a new short-lived bearer URL.\n\nThe success answer is the envelope dict, not a ``JSONResponse`` holding\nit: FastAPI sends a response object through untouched, which would\nleave ``response_model`` describing this route without checking it.", "operationId": "refresh_exposed_port_url_api_v1_exposed_ports__deployment_id___port__url_get", "parameters": [ { "in": "path", "name": "deployment_id", "required": true, "schema": { "title": "Deployment Id", "type": "string" } }, { "in": "path", "name": "port", "required": true, "schema": { "title": "Port", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_ExposedPortUrl_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Refresh Exposed Port Url", "tags": [ "Platform Mcp" ], "x-required-api-scope": "astrabox:read" } }, "/api/v1/extension-provider": { "get": { "description": "What the console offers for extension catalogs; reads no catalog.", "operationId": "get_extension_provider_api_v1_extension_provider_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_DeploymentExtensionProvider_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Get Extension Provider", "tags": [ "Extensions" ], "x-required-api-scope": "astrabox:read" } }, "/api/v1/mcp": { "get": { "description": "After authenticating the caller and checking Origin, returns 405; use POST for the stateless MCP facade.", "operationId": "agent_mcp_event_stream__api_v1_mcp_get", "parameters": [], "responses": { "405": { "description": "Standalone SSE is not supported.", "headers": { "Allow": { "schema": { "const": "POST" } } } }, "default": { "content": { "application/json": { "schema": { "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Caller or Origin rejected; code/message transport error or platform identity error envelope." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] }, { "MCPClientToken": [] } ], "summary": "Decline the optional standalone MCP event stream", "tags": [ "Agent MCP" ], "x-required-api-scope": "astrabox:read" }, "post": { "operationId": "agent_mcp_endpoint_api_v1_mcp_post", "parameters": [ { "description": "Required after initialization; use a version negotiated by initialize.", "in": "header", "name": "MCP-Protocol-Version", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "allOf": [ { "additionalProperties": true, "description": "A native JSON-RPC 2.0 request or notification.", "properties": { "id": { "description": "Absent for a notification.", "type": [ "string", "integer", "null" ] }, "jsonrpc": { "const": "2.0" }, "method": { "type": "string" }, "params": { "additionalProperties": true, "description": "Parameters defined by the selected native protocol method.", "type": "object" } }, "required": [ "jsonrpc", "method" ], "type": "object" }, { "$ref": "#/components/schemas/MCPClientCall" } ], "title": "Payload", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "description": "The native protocol supplies result on success or error on failure, never an AstraBox success envelope.", "properties": { "error": { "additionalProperties": true, "properties": { "code": { "type": "integer" }, "data": { "description": "A JSON value defined by the named tool, program, or data document." }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, "id": { "type": [ "string", "integer", "null" ] }, "jsonrpc": { "const": "2.0" }, "result": { "$ref": "#/components/schemas/MCPServerResult" } }, "required": [ "jsonrpc", "id" ], "type": "object" } } }, "description": "Native MCP JSON-RPC result or error." }, "202": { "description": "Notification accepted without a response body." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } ] } } }, "description": "Transport rejection: code/message; framework and identity rejections may use the platform error envelope. Native method failures use JSON-RPC responses." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] }, { "MCPClientToken": [] } ], "summary": "Agent Mcp Endpoint", "tags": [ "Agent Mcp" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/mcp-tokens": { "get": { "operationId": "list_mcp_tokens_api_v1_mcp_tokens_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_MCPClientTokenList_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "List Mcp Tokens", "tags": [ "Mcp Tokens" ], "x-required-api-scope": "astrabox:read" }, "post": { "operationId": "issue_mcp_token_api_v1_mcp_tokens_post", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "properties": { "expires_in_days": { "description": "Lifetime in days; null uses the token service's no-expiry behavior.", "type": [ "integer", "null" ] }, "name": { "type": "string" }, "scope": { "default": "converse", "enum": [ "read", "converse" ], "type": "string" } }, "title": "Payload", "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_IssuedMCPClientToken_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Issue Mcp Token", "tags": [ "Mcp Tokens" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/mcp-tokens/{token_id}": { "delete": { "operationId": "revoke_mcp_token_api_v1_mcp_tokens__token_id__delete", "parameters": [ { "in": "path", "name": "token_id", "required": true, "schema": { "title": "Token Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Revoke Mcp Token", "tags": [ "Mcp Tokens" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/me/schedules": { "get": { "operationId": "list_personal_schedules_api_v1_me_schedules_get", "parameters": [ { "in": "query", "name": "source_assistant_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Assistant Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_list_DeploymentRecord__" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "List Personal Schedules", "tags": [ "Deployments" ], "x-required-api-scope": "astrabox:read" }, "post": { "operationId": "create_personal_schedule_api_v1_me_schedules_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonalScheduleCreate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_DeploymentRecord_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Create Personal Schedule", "tags": [ "Deployments" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/me/schedules/{deployment_id}": { "delete": { "operationId": "delete_personal_schedule_api_v1_me_schedules__deployment_id__delete", "parameters": [ { "in": "path", "name": "deployment_id", "required": true, "schema": { "title": "Deployment Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_DeletedDeployment_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Delete Personal Schedule", "tags": [ "Deployments" ], "x-required-api-scope": "astrabox:write" }, "put": { "operationId": "update_personal_schedule_api_v1_me_schedules__deployment_id__put", "parameters": [ { "in": "path", "name": "deployment_id", "required": true, "schema": { "title": "Deployment Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "properties": { "enabled": { "type": "boolean" }, "name": { "type": "string" }, "prompt_prefix": { "type": "string" }, "schedule": { "additionalProperties": true, "description": "Recurring schedule: five cron fields and an IANA timezone.", "properties": { "cron": { "type": "string" }, "timezone": { "type": "string" } }, "type": "object" } }, "title": "Patch", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_DeploymentRecord_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Update Personal Schedule", "tags": [ "Deployments" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/me/schedules/{deployment_id}/runs": { "get": { "operationId": "list_personal_schedule_runs_api_v1_me_schedules__deployment_id__runs_get", "parameters": [ { "in": "path", "name": "deployment_id", "required": true, "schema": { "title": "Deployment Id", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_list_DeploymentRun__" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "List Personal Schedule Runs", "tags": [ "Deployments" ], "x-required-api-scope": "astrabox:read" }, "post": { "operationId": "trigger_personal_schedule_api_v1_me_schedules__deployment_id__runs_post", "parameters": [ { "in": "path", "name": "deployment_id", "required": true, "schema": { "title": "Deployment Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_DeploymentRun_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Trigger Personal Schedule", "tags": [ "Deployments" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/me/schedules/{deployment_id}/runs/{run_id}/replay": { "post": { "operationId": "replay_personal_schedule_run_api_v1_me_schedules__deployment_id__runs__run_id__replay_post", "parameters": [ { "in": "path", "name": "deployment_id", "required": true, "schema": { "title": "Deployment Id", "type": "string" } }, { "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_DeploymentRun_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Replay Personal Schedule Run", "tags": [ "Deployments" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/platform-mcp/{deployment_id}/{server_name}/{capability}/mcp": { "post": { "operationId": "platform_mcp_streamable_http_api_v1_platform_mcp__deployment_id___server_name___capability__mcp_post", "parameters": [ { "in": "path", "name": "deployment_id", "required": true, "schema": { "title": "Deployment Id", "type": "string" } }, { "in": "path", "name": "server_name", "required": true, "schema": { "title": "Server Name", "type": "string" } }, { "in": "path", "name": "capability", "required": true, "schema": { "title": "Capability", "type": "string" } }, { "description": "Session identifier returned by the native MCP server.", "in": "header", "name": "Mcp-Session-Id", "schema": { "type": "string" } }, { "description": "Negotiated native MCP protocol version.", "in": "header", "name": "MCP-Protocol-Version", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "additionalProperties": true, "description": "A native JSON-RPC 2.0 request or notification.", "properties": { "id": { "description": "Absent for a notification.", "type": [ "string", "integer", "null" ] }, "jsonrpc": { "const": "2.0" }, "method": { "type": "string" }, "params": { "additionalProperties": true, "description": "Parameters defined by the selected native protocol method.", "type": "object" } }, "required": [ "jsonrpc", "method" ], "type": "object" }, { "$ref": "#/components/schemas/MCPClientCall" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "description": "The native protocol supplies result on success or error on failure, never an AstraBox success envelope.", "properties": { "error": { "additionalProperties": true, "properties": { "code": { "type": "integer" }, "data": { "description": "A JSON value defined by the named tool, program, or data document." }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, "id": { "type": [ "string", "integer", "null" ] }, "jsonrpc": { "const": "2.0" }, "result": { "$ref": "#/components/schemas/MCPServerResult" } }, "required": [ "jsonrpc", "id" ], "type": "object" } } }, "description": "Native MCP JSON-RPC response." }, "202": { "description": "Accepted native notification, with no response body." }, "204": { "description": "Native MCP server returned no content." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Platform Mcp Streamable Http", "tags": [ "Platform Mcp" ] } }, "/api/v1/sandbox-callback/{subject_type}/{subject_id}/{generation}/{token}": { "post": { "operationId": "sandbox_lifecycle_callback_api_v1_sandbox_callback__subject_type___subject_id___generation___token__post", "parameters": [ { "in": "path", "name": "subject_type", "required": true, "schema": { "title": "Subject Type", "type": "string" } }, { "in": "path", "name": "subject_id", "required": true, "schema": { "title": "Subject Id", "type": "string" } }, { "in": "path", "name": "generation", "required": true, "schema": { "title": "Generation", "type": "string" } }, { "in": "path", "name": "token", "required": true, "schema": { "title": "Token", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "properties": { "expireTime": { "description": "Provider expiry observation, parsed as a timestamp.", "type": [ "string", "number", "null" ] }, "status": { "description": "Sandbox provider lifecycle status.", "type": "string" } }, "required": [ "status" ], "title": "Payload", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_SandboxCallbackResult_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Sandbox Lifecycle Callback", "tags": [ "Sandbox Callback" ] } }, "/api/v1/sbxcap/{cap_token}/api/v1/runtime-state/load": { "post": { "operationId": "runtime_state_load_api_v1_sbxcap__cap_token__api_v1_runtime_state_load_post", "parameters": [ { "in": "path", "name": "cap_token", "required": true, "schema": { "title": "Cap Token", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuntimeStateLoadRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_RuntimeStateLoadResult_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Runtime State Load", "tags": [ "Runtime State" ] } }, "/api/v1/sbxcap/{cap_token}/api/v1/runtime-state/profile/load": { "post": { "operationId": "runtime_profile_load_api_v1_sbxcap__cap_token__api_v1_runtime_state_profile_load_post", "parameters": [ { "in": "path", "name": "cap_token", "required": true, "schema": { "title": "Cap Token", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuntimeStateLoadRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_RuntimeStateLoadResult_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Runtime Profile Load", "tags": [ "Runtime State" ] } }, "/api/v1/sbxcap/{cap_token}/api/v1/runtime-state/profile/save": { "post": { "operationId": "runtime_profile_save_api_v1_sbxcap__cap_token__api_v1_runtime_state_profile_save_post", "parameters": [ { "in": "path", "name": "cap_token", "required": true, "schema": { "title": "Cap Token", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuntimeStateSaveRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_RuntimeStateSaveResult_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Runtime Profile Save", "tags": [ "Runtime State" ] } }, "/api/v1/sbxcap/{cap_token}/api/v1/runtime-state/save": { "post": { "operationId": "runtime_state_save_api_v1_sbxcap__cap_token__api_v1_runtime_state_save_post", "parameters": [ { "in": "path", "name": "cap_token", "required": true, "schema": { "title": "Cap Token", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuntimeStateSaveRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_RuntimeStateSaveResult_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Runtime State Save", "tags": [ "Runtime State" ] } }, "/api/v1/sbxcap/{cap_token}/api/v1/sandbox/{sandbox_id}/terminating": { "post": { "description": "The box says it is going away. The platform decides who that affects.\n\nScoped to the box, not to a conversation, because the box is what knows\nand a box can have Session, Agent, and Assistant-workspace owners. It\nreports one fact — \"I am being torn down\" — and the platform resolves\nevery durable owner by ``sandbox_id``. The box asserts none of those\nrelationships; they are platform state.\n\nA Pod also exits during an intentional lifecycle transition. The owner\nrecords that intent before touching the box, so the convergence\noperation preserves:\n\n* a parked Session and its Agent-owned shared-box pointer;\n* an Assistant workspace whose files committed and whose old box is\n being released, plus every Session attached to it;\n* a Session already being ended or deleted.\n\nA notice from a box with no durable owner is not an error — it is normal\nfor a box whose owners moved on and for unclaimed prepared capacity.", "operationId": "sandbox_terminating_notice_api_v1_sbxcap__cap_token__api_v1_sandbox__sandbox_id__terminating_post", "parameters": [ { "in": "path", "name": "cap_token", "required": true, "schema": { "title": "Cap Token", "type": "string" } }, { "in": "path", "name": "sandbox_id", "required": true, "schema": { "title": "Sandbox Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "description": "Payload fields are not used: sandbox identity and capability are in the URL. The platform resolves affected owners itself.", "properties": {}, "title": "Payload", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_SandboxTerminatingResult_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Sandbox Terminating Notice", "tags": [ "Sandbox Callback" ] } }, "/api/v1/sbxcap/{cap_token}/api/v1/transcript/{session_id}/append": { "post": { "operationId": "transcript_append_scoped_api_v1_sbxcap__cap_token__api_v1_transcript__session_id__append_post", "parameters": [ { "in": "path", "name": "cap_token", "required": true, "schema": { "title": "Cap Token", "type": "string" } }, { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "properties": { "append_id": { "type": "string" }, "entries": { "items": { "additionalProperties": true, "description": "One native SessionStore entry, preserved verbatim.", "type": "object" }, "type": "array" }, "key": { "additionalProperties": true, "properties": { "project_key": { "type": "string" }, "session_id": { "type": "string" }, "subpath": { "type": "string" } }, "required": [ "project_key", "session_id" ], "type": "object" }, "payload_sha256": { "description": "Digest of the canonical key/entries batch.", "pattern": "^[0-9a-fA-F]{64}$", "type": "string" } }, "required": [ "key", "entries", "append_id", "payload_sha256" ], "title": "Payload", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_TranscriptAppendResult_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Transcript Append Scoped", "tags": [ "Transcript" ] } }, "/api/v1/sbxcap/{cap_token}/api/v1/transcript/{session_id}/list-sessions": { "post": { "operationId": "transcript_list_sessions_scoped_api_v1_sbxcap__cap_token__api_v1_transcript__session_id__list_sessions_post", "parameters": [ { "in": "path", "name": "cap_token", "required": true, "schema": { "title": "Cap Token", "type": "string" } }, { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "properties": { "project_key": { "type": "string" } }, "required": [ "project_key" ], "title": "Payload", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_TranscriptSessionList_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Transcript List Sessions Scoped", "tags": [ "Transcript" ] } }, "/api/v1/sbxcap/{cap_token}/api/v1/transcript/{session_id}/list-subkeys": { "post": { "operationId": "transcript_list_subkeys_scoped_api_v1_sbxcap__cap_token__api_v1_transcript__session_id__list_subkeys_post", "parameters": [ { "in": "path", "name": "cap_token", "required": true, "schema": { "title": "Cap Token", "type": "string" } }, { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "properties": { "key": { "additionalProperties": true, "properties": { "project_key": { "type": "string" }, "session_id": { "type": "string" }, "subpath": { "type": "string" } }, "required": [ "project_key", "session_id" ], "type": "object" } }, "required": [ "key" ], "title": "Payload", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_TranscriptSubkeyList_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Transcript List Subkeys Scoped", "tags": [ "Transcript" ] } }, "/api/v1/sbxcap/{cap_token}/api/v1/transcript/{session_id}/load": { "post": { "operationId": "transcript_load_scoped_api_v1_sbxcap__cap_token__api_v1_transcript__session_id__load_post", "parameters": [ { "in": "path", "name": "cap_token", "required": true, "schema": { "title": "Cap Token", "type": "string" } }, { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "properties": { "key": { "additionalProperties": true, "properties": { "project_key": { "type": "string" }, "session_id": { "type": "string" }, "subpath": { "type": "string" } }, "required": [ "project_key", "session_id" ], "type": "object" } }, "required": [ "key" ], "title": "Payload", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_TranscriptLoadResult_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Transcript Load Scoped", "tags": [ "Transcript" ] } }, "/api/v1/sessions": { "get": { "operationId": "list_sessions_api_v1_sessions_get", "parameters": [ { "description": "Set to 1 for a cursor page; omitted returns the complete visible list.", "in": "query", "name": "page", "required": false, "schema": { "enum": [ 1 ], "type": "integer" } }, { "description": "Page size, clamped to 1..100; used only with page=1.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "type": "integer" } }, { "description": "Opaque next_cursor from the preceding page.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ApiEnvelope_SessionListPage_" }, { "$ref": "#/components/schemas/ApiEnvelope_list_SessionRecord__" } ], "title": "Response List Sessions Api V1 Sessions Get" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "List Sessions", "tags": [ "Sessions" ], "x-required-api-scope": "astrabox:read" } }, "/api/v1/sessions/{session_id}": { "delete": { "operationId": "delete_session_api_v1_sessions__session_id__delete", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_SessionDeletion_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Delete Session", "tags": [ "Sessions" ], "x-required-api-scope": "astrabox:write" }, "get": { "operationId": "get_session_api_v1_sessions__session_id__get", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_SessionRecord_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Get Session", "tags": [ "Sessions" ], "x-required-api-scope": "astrabox:read" }, "patch": { "operationId": "update_session_api_v1_sessions__session_id__patch", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_SessionTitle_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Update Session", "tags": [ "Sessions" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/sessions/{session_id}/archive": { "post": { "operationId": "archive_session_api_v1_sessions__session_id__archive_post", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_SessionArchival_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Archive Session", "tags": [ "Sessions" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/sessions/{session_id}/browser": { "post": { "operationId": "open_session_browser_api_v1_sessions__session_id__browser_post", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_SessionBrowserAccess_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Open Session Browser", "tags": [ "Session Browser" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/sessions/{session_id}/child-runs": { "get": { "operationId": "list_session_child_runs_api_v1_sessions__session_id__child_runs_get", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_SessionChildRunPage_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "List Session Child Runs", "tags": [ "Sessions" ], "x-required-api-scope": "astrabox:read" } }, "/api/v1/sessions/{session_id}/child-runs/{child_run_id}/messages": { "get": { "operationId": "get_session_child_run_messages_api_v1_sessions__session_id__child_runs__child_run_id__messages_get", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } }, { "in": "path", "name": "child_run_id", "required": true, "schema": { "title": "Child Run Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_ChildRunMessagePage_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Get Session Child Run Messages", "tags": [ "Sessions" ], "x-required-api-scope": "astrabox:read" } }, "/api/v1/sessions/{session_id}/child-runs/{child_run_id}/stop": { "post": { "operationId": "stop_session_child_run_api_v1_sessions__session_id__child_runs__child_run_id__stop_post", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } }, { "in": "path", "name": "child_run_id", "required": true, "schema": { "title": "Child Run Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_ChildRunStopResult_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Stop Session Child Run", "tags": [ "Sessions" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/sessions/{session_id}/conversation/end": { "post": { "operationId": "end_conversation_api_v1_sessions__session_id__conversation_end_post", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_ConversationEndResult_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "End Conversation", "tags": [ "Turns" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/sessions/{session_id}/file-changes": { "get": { "operationId": "get_session_file_changes_api_v1_sessions__session_id__file_changes_get", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } }, { "in": "query", "name": "after_seq", "required": false, "schema": { "default": 0, "minimum": 0, "title": "After Seq", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_SessionFileChanges_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Get Session File Changes", "tags": [ "Sessions" ], "x-required-api-scope": "astrabox:read" } }, "/api/v1/sessions/{session_id}/files/delete": { "post": { "operationId": "delete_session_files_api_v1_sessions__session_id__files_delete_post", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteSessionFilesRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_SessionFilesDeleted_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Delete Session Files", "tags": [ "Session Files" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/sessions/{session_id}/files/download": { "get": { "operationId": "download_session_file_api_v1_sessions__session_id__files_download_get", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } }, { "in": "query", "name": "path", "required": true, "schema": { "title": "Path", "type": "string" } } ], "responses": { "200": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "Raw attachment bytes; Content-Disposition supplies the filename and Content-Length the byte count.", "headers": { "Content-Disposition": { "schema": { "type": "string" } }, "Content-Length": { "schema": { "type": "integer" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Download Session File", "tags": [ "Session Files" ], "x-required-api-scope": "astrabox:read" } }, "/api/v1/sessions/{session_id}/files/list": { "post": { "operationId": "list_session_files_api_v1_sessions__session_id__files_list_post", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ListSessionFilesRequest" }, { "type": "null" } ], "title": "Body" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_SessionFileListing_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "List Session Files", "tags": [ "Session Files" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/sessions/{session_id}/files/mkdir": { "post": { "operationId": "mkdir_session_files_api_v1_sessions__session_id__files_mkdir_post", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MkdirSessionFilesRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_SessionDirectoryCreated_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Mkdir Session Files", "tags": [ "Session Files" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/sessions/{session_id}/files/move": { "post": { "operationId": "move_session_files_api_v1_sessions__session_id__files_move_post", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveSessionFilesRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_SessionFileMoved_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Move Session Files", "tags": [ "Session Files" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/sessions/{session_id}/files/preview": { "post": { "operationId": "preview_session_file_api_v1_sessions__session_id__files_preview_post", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewSessionFileRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_SessionFilePreview_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Preview Session File", "tags": [ "Session Files" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/sessions/{session_id}/files/upload": { "post": { "operationId": "upload_session_files_api_v1_sessions__session_id__files_upload_post", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_session_files_api_v1_sessions__session_id__files_upload_post" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_SessionFileUploadResult_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Upload Session Files", "tags": [ "Session Files" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/sessions/{session_id}/history-blocks": { "get": { "description": "Read the conversation with each ended response's work folded away.\n\n``before`` is a ``next_cursor`` from an earlier page; omitting it starts at\nthe newest entries and pins the output position every later page reuses.", "operationId": "get_session_history_blocks_api_v1_sessions__session_id__history_blocks_get", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } }, { "description": "Opaque cursor for older history blocks.", "in": "query", "name": "before", "required": false, "schema": { "type": "string" } }, { "description": "History page size, capped at 50.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_SessionHistoryBlockPage_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Get Session History Blocks", "tags": [ "Sessions" ], "x-required-api-scope": "astrabox:read" } }, "/api/v1/sessions/{session_id}/history-blocks/{block_id}": { "get": { "description": "Reopen one folded ``data-process-block`` and return the parts it replaced.\n\n``cursor`` is the one the header carried, and is required: it pins the read\nto the output position of the page that folded the parts.", "operationId": "get_session_history_block_details_api_v1_sessions__session_id__history_blocks__block_id__get", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } }, { "in": "path", "name": "block_id", "required": true, "schema": { "title": "Block Id", "type": "string" } }, { "description": "Recorded process-block position from the header.", "in": "query", "name": "cursor", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_SessionHistoryBlockDetails_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Get Session History Block Details", "tags": [ "Sessions" ], "x-required-api-scope": "astrabox:read" } }, "/api/v1/sessions/{session_id}/inputs": { "post": { "description": "Accept a message for the conversation.", "operationId": "send_input_api_v1_sessions__session_id__inputs_post", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "properties": { "client_message_id": { "description": "Optional caller identifier for input deduplication.", "type": "string" }, "content": { "description": "Text or a nonempty text/image block list. The selected program must support every supplied block type.", "oneOf": [ { "type": "string" }, { "items": { "oneOf": [ { "additionalProperties": true, "properties": { "text": { "type": "string" }, "type": { "const": "text" } }, "required": [ "type", "text" ], "type": "object" }, { "additionalProperties": true, "properties": { "source": { "additionalProperties": true, "properties": { "data": { "contentEncoding": "base64", "minLength": 1, "type": "string" }, "media_type": { "enum": [ "image/png", "image/jpeg", "image/gif", "image/webp" ], "type": "string" }, "type": { "const": "base64" } }, "required": [ "type", "media_type", "data" ], "type": "object" }, "type": { "const": "image" } }, "required": [ "type", "source" ], "type": "object" } ] }, "minItems": 1, "type": "array" } ] } }, "required": [ "content" ], "title": "Payload", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_InputReceipt_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Send Input", "tags": [ "Turns" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/sessions/{session_id}/interactions/{interaction_id}/answer": { "post": { "operationId": "answer_interaction_api_v1_sessions__session_id__interactions__interaction_id__answer_post", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } }, { "in": "path", "name": "interaction_id", "required": true, "schema": { "title": "Interaction Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "properties": { "answer": { "additionalProperties": true, "description": "Use the pending interaction's presentation and declared options. Forms accept answers or decline; decisions and tool approvals require decision.", "properties": { "answers": { "description": "One answer per question, using its declared ID and selection/free-text rules.", "items": { "additionalProperties": true, "properties": { "free_text": { "type": "string" }, "option_label": { "type": "string" }, "option_labels": { "items": { "type": "string" }, "type": "array" }, "question_id": { "type": "string" } }, "required": [ "question_id" ], "type": "object" }, "minItems": 1, "type": "array" }, "comment": { "type": "string" }, "decision": { "description": "Tool approval: approve or reject. A decision presentation requires an exact declared option ID.", "type": "string" }, "decline": { "description": "Decline a form instead of submitting answers.", "type": "boolean" }, "permission_mode": { "description": "A native mode from the selected decision option's permission_mode_choices.", "type": "string" } }, "type": "object" } }, "required": [ "answer" ], "title": "Payload", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_InteractionAnswerReceipt_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Answer Interaction", "tags": [ "Turns" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/sessions/{session_id}/interrupt": { "post": { "operationId": "interrupt_session_api_v1_sessions__session_id__interrupt_post", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_InterruptReceipt_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Interrupt Session", "tags": [ "Turns" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/sessions/{session_id}/messages": { "get": { "operationId": "get_messages_api_v1_sessions__session_id__messages_get", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } }, { "description": "Opaque cursor for older messages.", "in": "query", "name": "before", "required": false, "schema": { "type": "string" } }, { "description": "Message page size, capped at 50.", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_SessionMessagePage_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Get Messages", "tags": [ "Sessions" ], "x-required-api-scope": "astrabox:read" } }, "/api/v1/sessions/{session_id}/messages/{message_id}/process-summary": { "post": { "description": "Write, or return, the label for one response's folded work.\n\nAnswers with the stored label when there already is one. ``retry=true``\nasks again for a label whose generation failed; a completed one is returned\nunchanged.", "operationId": "generate_session_process_summary_api_v1_sessions__session_id__messages__message_id__process_summary_post", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } }, { "in": "path", "name": "message_id", "required": true, "schema": { "title": "Message Id", "type": "string" } }, { "description": "Set to true to request regeneration after a recorded summary failure.", "in": "query", "name": "retry", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_ProcessSummaryState_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Generate Session Process Summary", "tags": [ "Sessions" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/sessions/{session_id}/permission-mode": { "post": { "operationId": "update_session_permission_mode_api_v1_sessions__session_id__permission_mode_post", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "properties": { "permission_mode": { "description": "One mode from the current runtime capability manifest.", "type": "string" } }, "required": [ "permission_mode" ], "title": "Payload", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_PermissionModeUpdate_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Update Session Permission Mode", "tags": [ "Sessions" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/sessions/{session_id}/read": { "post": { "operationId": "mark_session_read_api_v1_sessions__session_id__read_post", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_SessionRead_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Mark Session Read", "tags": [ "Sessions" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/sessions/{session_id}/recover": { "post": { "operationId": "recover_session_api_v1_sessions__session_id__recover_post", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_SessionRecord_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Recover Session", "tags": [ "Sessions" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/sessions/{session_id}/sandbox/terminate": { "post": { "operationId": "terminate_sandbox_api_v1_sessions__session_id__sandbox_terminate_post", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_SandboxTermination_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Terminate Sandbox", "tags": [ "Sessions" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/sessions/{session_id}/share": { "delete": { "operationId": "revoke_share_api_v1_sessions__session_id__share_delete", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_ShareRevoked_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Revoke Share", "tags": [ "Share" ], "x-required-api-scope": "astrabox:write" }, "get": { "operationId": "get_share_api_v1_sessions__session_id__share_get", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_ShareLink_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Get Share", "tags": [ "Share" ], "x-required-api-scope": "astrabox:read" }, "post": { "operationId": "create_share_api_v1_sessions__session_id__share_post", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "properties": { "allow_download": { "default": false, "type": "boolean" }, "expires_in_seconds": { "type": [ "integer", "null" ] } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_ShareLink_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Create Share", "tags": [ "Share" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/sessions/{session_id}/speech-input": { "get": { "operationId": "get_speech_input_options_api_v1_sessions__session_id__speech_input_get", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_SpeechInputOptions_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Get Speech Input Options", "tags": [ "Speech Input" ], "x-required-api-scope": "astrabox:read" }, "post": { "operationId": "transcribe_session_speech_api_v1_sessions__session_id__speech_input_post", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_transcribe_session_speech_api_v1_sessions__session_id__speech_input_post" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_SpeechInputTranscript_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Transcribe Session Speech", "tags": [ "Speech Input" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/sessions/{session_id}/stream": { "get": { "description": "The session's output after ``after_seq``, then live, through the end of one response.\n\nEach part is an AI SDK UI message chunk; ``data-resume-cursor`` parts carry\nthe position to reconnect from.", "operationId": "follow_stream_api_v1_sessions__session_id__stream_get", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } }, { "description": "Output cursor to resume after; negative or malformed values return INVALID_REQUEST.", "in": "query", "name": "after_seq", "required": false, "schema": { "default": 0, "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "AI SDK UI message chunks as SSE; resume with data-resume-cursor. One response per connection. See /docs/events-stream on the documentation site." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Follow Stream", "tags": [ "Turns" ], "x-required-api-scope": "astrabox:read" } }, "/api/v1/sessions/{session_id}/terminal/interrupt": { "post": { "description": "Stop the command the session's terminal runs; answers once the command has ended.", "operationId": "interrupt_terminal_api_v1_sessions__session_id__terminal_interrupt_post", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_TerminalInterruptResult_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Interrupt Terminal", "tags": [ "Turns" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/sessions/{session_id}/terminal/stream": { "get": { "description": "Follow a terminal command again: its recorded events after ``after_seq``, then live.\n\nThe stream ends with the command's ``exit``; each event carries its\n``seq``. Without ``command_id`` it follows the command the terminal runs\nnow and answers ``204`` when none runs.", "operationId": "follow_terminal_stream_api_v1_sessions__session_id__terminal_stream_get", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } }, { "description": "Recorded terminal command; omitted follows the running command.", "in": "query", "name": "command_id", "required": false, "schema": { "type": "string" } }, { "description": "Replay events after this terminal sequence.", "in": "query", "name": "after_seq", "required": false, "schema": { "default": -1, "type": "integer" } } ], "responses": { "200": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "Recorded terminal events after after_seq, then live." }, "204": { "description": "No command is running and no command_id was supplied." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Follow Terminal Stream", "tags": [ "Turns" ], "x-required-api-scope": "astrabox:read" }, "post": { "description": "Run one command in the session's terminal and stream its events as SSE.\n\nThe events are ``ack`` (carrying the ``command_id``), ``stdout``,\n``stderr``, ``cwd`` and a final ``exit``. The command runs on when the\nstream closes; ``GET`` on this path follows it again. WebSocket is\nintentionally avoided; the terminal uses HTTP SSE.", "operationId": "terminal_stream_api_v1_sessions__session_id__terminal_stream_post", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "properties": { "command": { "minLength": 1, "type": "string" }, "cwd": { "description": "Alternate working-directory field; working_directory takes precedence.", "type": "string" }, "working_directory": { "description": "Working directory inside this conversation's workspace.", "type": "string" } }, "required": [ "command" ], "title": "Payload", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "Terminal ack, stdout, stderr, cwd and exit events, followed by stream closure." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Terminal Stream", "tags": [ "Turns" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/sessions/{session_id}/user-action": { "get": { "operationId": "read_session_user_action_api_v1_sessions__session_id__user_action_get", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_SessionUserActionView_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Read Session User Action", "tags": [ "Session User Actions" ], "x-required-api-scope": "astrabox:read" }, "post": { "operationId": "perform_session_user_action_api_v1_sessions__session_id__user_action_post", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PerformUserAction" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_SessionUserActionView_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Perform Session User Action", "tags": [ "Session User Actions" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/sessions/{session_id}/webshell": { "get": { "operationId": "get_webshell_api_v1_sessions__session_id__webshell_get", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_WebshellAccess_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Get Webshell", "tags": [ "Sessions" ], "x-required-api-scope": "astrabox:read" } }, "/api/v1/share/{token}": { "get": { "operationId": "shared_session_api_v1_share__token__get", "parameters": [ { "in": "path", "name": "token", "required": true, "schema": { "title": "Token", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_SharedSession_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Shared Session", "tags": [ "Share" ] } }, "/api/v1/share/{token}/files/download": { "get": { "operationId": "shared_file_download_api_v1_share__token__files_download_get", "parameters": [ { "in": "path", "name": "token", "required": true, "schema": { "title": "Token", "type": "string" } }, { "in": "query", "name": "path", "required": true, "schema": { "title": "Path", "type": "string" } } ], "responses": { "200": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "Raw attachment bytes; Content-Disposition supplies the filename and Content-Length the byte count.", "headers": { "Content-Disposition": { "schema": { "type": "string" } }, "Content-Length": { "schema": { "type": "integer" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Shared File Download", "tags": [ "Share" ] } }, "/api/v1/share/{token}/files/list": { "get": { "operationId": "shared_files_list_api_v1_share__token__files_list_get", "parameters": [ { "in": "path", "name": "token", "required": true, "schema": { "title": "Token", "type": "string" } }, { "description": "Workspace directory to list.", "in": "query", "name": "path", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_SessionFileListing_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Shared Files List", "tags": [ "Share" ] } }, "/api/v1/share/{token}/history-blocks": { "get": { "operationId": "shared_history_blocks_api_v1_share__token__history_blocks_get", "parameters": [ { "in": "path", "name": "token", "required": true, "schema": { "title": "Token", "type": "string" } }, { "in": "query", "name": "before", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Before" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_SessionHistoryBlockPage_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Shared History Blocks", "tags": [ "Share" ] } }, "/api/v1/share/{token}/history-blocks/{block_id}": { "get": { "operationId": "shared_history_block_details_api_v1_share__token__history_blocks__block_id__get", "parameters": [ { "in": "path", "name": "token", "required": true, "schema": { "title": "Token", "type": "string" } }, { "in": "path", "name": "block_id", "required": true, "schema": { "title": "Block Id", "type": "string" } }, { "in": "query", "name": "cursor", "required": true, "schema": { "title": "Cursor", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_SessionHistoryBlockDetails_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Shared History Block Details", "tags": [ "Share" ] } }, "/api/v1/share/{token}/messages": { "get": { "operationId": "shared_messages_api_v1_share__token__messages_get", "parameters": [ { "in": "path", "name": "token", "required": true, "schema": { "title": "Token", "type": "string" } }, { "description": "Opaque cursor for older shared messages.", "in": "query", "name": "before", "required": false, "schema": { "type": "string" } }, { "description": "Message page size, capped at 50.", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_SharedMessagePage_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Shared Messages", "tags": [ "Share" ] } }, "/api/v1/transcript/{session_id}/append": { "post": { "operationId": "transcript_append_api_v1_transcript__session_id__append_post", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "properties": { "append_id": { "type": "string" }, "entries": { "items": { "additionalProperties": true, "description": "One native SessionStore entry, preserved verbatim.", "type": "object" }, "type": "array" }, "key": { "additionalProperties": true, "properties": { "project_key": { "type": "string" }, "session_id": { "type": "string" }, "subpath": { "type": "string" } }, "required": [ "project_key", "session_id" ], "type": "object" }, "payload_sha256": { "description": "Digest of the canonical key/entries batch.", "pattern": "^[0-9a-fA-F]{64}$", "type": "string" } }, "required": [ "key", "entries", "append_id", "payload_sha256" ], "title": "Payload", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_TranscriptAppendResult_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Transcript Append", "tags": [ "Transcript" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/transcript/{session_id}/list-sessions": { "post": { "operationId": "transcript_list_sessions_api_v1_transcript__session_id__list_sessions_post", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "properties": { "project_key": { "type": "string" } }, "required": [ "project_key" ], "title": "Payload", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_TranscriptSessionList_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Transcript List Sessions", "tags": [ "Transcript" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/transcript/{session_id}/list-subkeys": { "post": { "operationId": "transcript_list_subkeys_api_v1_transcript__session_id__list_subkeys_post", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "properties": { "key": { "additionalProperties": true, "properties": { "project_key": { "type": "string" }, "session_id": { "type": "string" }, "subpath": { "type": "string" } }, "required": [ "project_key", "session_id" ], "type": "object" } }, "required": [ "key" ], "title": "Payload", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_TranscriptSubkeyList_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Transcript List Subkeys", "tags": [ "Transcript" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/transcript/{session_id}/load": { "post": { "operationId": "transcript_load_api_v1_transcript__session_id__load_post", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "title": "Session Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "properties": { "key": { "additionalProperties": true, "properties": { "project_key": { "type": "string" }, "session_id": { "type": "string" }, "subpath": { "type": "string" } }, "required": [ "project_key", "session_id" ], "type": "object" } }, "required": [ "key" ], "title": "Payload", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_TranscriptLoadResult_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Transcript Load", "tags": [ "Transcript" ], "x-required-api-scope": "astrabox:write" } }, "/api/v1/user/current": { "get": { "operationId": "get_current_user_api_v1_user_current_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiEnvelope_CurrentUser_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "security": [ { "BearerAuth": [] }, { "BrowserSession": [] } ], "summary": "Get Current User", "tags": [ "User" ], "x-required-api-scope": "astrabox:read" } }, "/connector-hub/oauth/callback": { "get": { "description": "Query parameters and response belong to the connector hub OAuth flow; forwarded verbatim. The hub returns the browser to the console.", "operationId": "connector_hub_callback__connector_hub_oauth_callback_get", "parameters": [ { "in": "query", "name": "code", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "state", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "error", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "error_description", "required": false, "schema": { "type": "string" } } ], "responses": { "default": { "content": { "*/*": { "schema": { "type": "string" } } }, "description": "Connector hub response; may redirect with Location.", "headers": { "Location": { "schema": { "type": "string" } } } } }, "summary": "Receive connector OAuth callback", "tags": [ "Connectors" ] } }, "/healthz": { "get": { "description": "Liveness endpoint.\n\nReturns a static ``ok`` payload. Intentionally dependency-free (it does\nnot touch the database, Docker daemon, or any provider) so it answers even\nbefore the runtime is wired — it reports that the HTTP server is up, which\nis exactly what the container HEALTHCHECK and load balancers need.\n\nLiveness stays ``ok`` through a drain (see ``/readyz``): a draining\nreplica must not be killed by a liveness probe before it finishes its\nin-flight turns.", "operationId": "healthz_healthz_get", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "title": "Response Healthz Healthz Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Liveness probe", "tags": [ "meta" ] } }, "/metrics": { "get": { "operationId": "metrics__metrics_get", "parameters": [], "responses": { "200": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Prometheus text exposition. ASTRABOX_METRICS_TOKEN, when configured, requires its own bearer credential." }, "401": { "description": "Metrics bearer missing or invalid; no body." }, "404": { "description": "Metrics are disabled; no body." } }, "security": [ { "BearerAuth": [] }, {} ], "tags": [ "App" ] } }, "/readyz": { "get": { "description": "Readiness endpoint for rolling deploys.\n\n200 when this replica should receive new traffic; 503 during shutdown\nor after its core notification listener ends unexpectedly. In-flight\nturns are not killed by this probe. See ``astrabox/api/readiness.py``.", "operationId": "readyz_readyz_get", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "title": "Response Readyz Readyz Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request validation failed (INVALID_REQUEST)." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Request refused or execution failed. Inspect code and error for the reason; data carries operation-specific evidence. Transport status is authoritative." } }, "summary": "Readiness probe", "tags": [ "meta" ] } } } }