{ "openapi": "3.1.0", "info": { "title": "Pantheon Application Tools API", "description": "Pantheon API for tenant-defined application tools, immutable definitions,\ndurable blocking events, event-correlated generic resume, and execution lifecycle.\n", "version": "1.0.0" }, "paths": { "/v1/auth/signup": { "post": { "tags": [ "accounts" ], "summary": "Signup", "operationId": "signup_v1_auth_signup_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignupRequest" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/auth/login": { "post": { "tags": [ "accounts" ], "summary": "Login", "operationId": "login_v1_auth_login_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/auth/logout": { "post": { "tags": [ "accounts" ], "summary": "Logout", "operationId": "logout_v1_auth_logout_post", "responses": { "204": { "description": "Successful Response" } }, "security": [ { "BearerAuth": [] } ] } }, "/v1/auth/me": { "get": { "tags": [ "accounts" ], "summary": "Me", "operationId": "me_v1_auth_me_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeResponse" } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1/auth/keys": { "get": { "tags": [ "accounts" ], "summary": "List Keys", "operationId": "list_keys_v1_auth_keys_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyListResponse" } } } } }, "security": [ { "BearerAuth": [] } ] }, "post": { "tags": [ "accounts" ], "summary": "Create Key", "operationId": "create_key_v1_auth_keys_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyCreateRequest" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyCreateResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1/auth/keys/{key_id}": { "delete": { "tags": [ "accounts" ], "summary": "Revoke Key", "operationId": "revoke_key_v1_auth_keys__key_id__delete", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "key_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Key Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/auth/password/change": { "post": { "tags": [ "accounts" ], "summary": "Change Password", "operationId": "change_password_v1_auth_password_change_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordChangeRequest" } } }, "required": true }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1/auth/email/verify/request": { "post": { "tags": [ "accounts" ], "summary": "Request Verification", "operationId": "request_verification_v1_auth_email_verify_request_post", "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailSentResponse" } } } }, "401": { "description": "A valid account session is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountErrorEnvelope" } } } }, "409": { "description": "ALREADY_VERIFIED.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountErrorEnvelope" } } } }, "429": { "description": "RATE_LIMITED. Retry after error.retry_after seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountRateLimitErrorEnvelope" } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1/auth/email/verify/confirm": { "post": { "tags": [ "accounts" ], "summary": "Confirm Verification", "operationId": "confirm_verification_v1_auth_email_verify_confirm_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailTokenRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailVerifiedResponse" } } } }, "400": { "description": "TOKEN_INVALID, TOKEN_EXPIRED, or TOKEN_USED.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountErrorEnvelope" } } } }, "422": { "description": "Invalid request payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountErrorEnvelope" } } } } } } }, "/v1/auth/password/reset/request": { "post": { "tags": [ "accounts" ], "summary": "Request Password Reset", "operationId": "request_password_reset_v1_auth_password_reset_request_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailRequest" } } }, "required": true }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailSentResponse" } } } }, "422": { "description": "Invalid email address.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountErrorEnvelope" } } } }, "429": { "description": "RATE_LIMITED. Retry after error.retry_after seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountRateLimitErrorEnvelope" } } } } } } }, "/v1/auth/password/reset/confirm": { "post": { "tags": [ "accounts" ], "summary": "Confirm Password Reset", "operationId": "confirm_password_reset_v1_auth_password_reset_confirm_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResetConfirmRequest" } } }, "required": true }, "responses": { "204": { "description": "Successful Response" }, "400": { "description": "TOKEN_INVALID, TOKEN_EXPIRED, or TOKEN_USED.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountErrorEnvelope" } } } }, "422": { "description": "Invalid request payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountErrorEnvelope" } } } } } } }, "/v1/admin/users/{user_id}/password": { "post": { "tags": [ "admin-users", "admin" ], "summary": "Admin Reset Password", "operationId": "admin_reset_password_v1_admin_users__user_id__password_post", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminPasswordResetRequest" } } } }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Requires an admin key." } }, "/v1/admin/api-keys": { "get": { "tags": [ "admin-api-keys", "admin" ], "summary": "List Admin Api Keys", "operationId": "list_admin_api_keys_v1_admin_api_keys_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/AdminApiKeyResponse" }, "type": "array", "title": "Response List Admin Api Keys V1 Admin Api Keys Get" } } } } }, "security": [ { "BearerAuth": [] } ], "description": "Requires an admin key." }, "post": { "tags": [ "admin-api-keys", "admin" ], "summary": "Create Admin Api Key", "operationId": "create_admin_api_key_v1_admin_api_keys_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminApiKeyCreateRequest" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminApiKeyResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ], "description": "Requires an admin key." } }, "/v1/admin/api-keys/{key_id}": { "delete": { "tags": [ "admin-api-keys", "admin" ], "summary": "Delete Admin Api Key", "operationId": "delete_admin_api_key_v1_admin_api_keys__key_id__delete", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "key_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Key Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Requires an admin key." } }, "/v1/users/{user_id}/memory": { "get": { "tags": [ "agent-memory", "tenant-users" ], "summary": "Get User Memory", "description": "List what the agent has stored for one end user across their sessions. Agents keep long-lived notes in a memory store the model can read and edit during a conversation. Memory is scoped to one end user: to the tenant user when the session names one, otherwise to the single session. It is never shared across a workspace.", "operationId": "get_user_memory_v1_users__user_id__memory_get", "security": [ { "BearerAuth": [ "sessions:read" ] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemoryScopeResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "agent-memory", "tenant-users" ], "summary": "Delete User Memory", "description": "Erase everything the agent has stored for one end user. The entries are deleted, not hidden. The next session for that user starts from the stock memory template with nothing learned about them.", "operationId": "delete_user_memory_v1_users__user_id__memory_delete", "security": [ { "BearerAuth": [ "sessions:write" ] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemoryDeleteResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/sessions/{session_id}/memory": { "get": { "tags": [ "agent-memory", "sessions" ], "summary": "Get Session Memory", "description": "List the memory this session's agent reads and writes. A session created with a user_id reads that user's memory and the response says so; a session created without one reads only its own. Agents keep long-lived notes in a memory store the model can read and edit during a conversation. Memory is scoped to one end user: to the tenant user when the session names one, otherwise to the single session. It is never shared across a workspace.", "operationId": "get_session_memory_v1_sessions__session_id__memory_get", "security": [ { "BearerAuth": [ "sessions:read" ] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemoryScopeResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "agent-memory", "sessions" ], "summary": "Delete Session Memory", "description": "Erase the memory this session's agent reads and writes. For a session bound to a user_id that is the user's memory, which the matching GET reports before you call this.", "operationId": "delete_session_memory_v1_sessions__session_id__memory_delete", "security": [ { "BearerAuth": [ "sessions:read", "sessions:write" ] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemoryDeleteResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/agents": { "post": { "tags": [ "agents" ], "summary": "Create Agent", "description": "Create a tenant agent and its first immutable revision.", "operationId": "create_agent_v1_agents_post", "security": [ { "BearerAuth": [ "agents:write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAgentRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "agents" ], "summary": "List Agents", "description": "List active agents in the authenticated tenant.", "operationId": "list_agents_v1_agents_get", "security": [ { "BearerAuth": [ "agents:read" ] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Limit" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/agents/{agent_id}": { "get": { "tags": [ "agents" ], "summary": "Get Agent", "description": "Get an active tenant agent by its stable identifier.", "operationId": "get_agent_v1_agents__agent_id__get", "security": [ { "BearerAuth": [ "agents:read" ] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "agents" ], "summary": "Update Agent", "description": "Update an agent and create a new immutable revision.", "operationId": "update_agent_v1_agents__agent_id__put", "security": [ { "BearerAuth": [ "agents:write" ] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAgentRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "agents" ], "summary": "Delete Agent", "description": "Soft-delete an agent so it cannot be used for new sessions.", "operationId": "delete_agent_v1_agents__agent_id__delete", "security": [ { "BearerAuth": [ "agents:write" ] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/agents/slug/{slug}": { "get": { "tags": [ "agents" ], "summary": "Get Agent By Slug", "description": "Get an active tenant agent by its unique slug.", "operationId": "get_agent_by_slug_v1_agents_slug__slug__get", "security": [ { "BearerAuth": [ "agents:read" ] } ], "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "title": "Slug" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/assistant/conversations": { "post": { "tags": [ "assistant" ], "summary": "Create Conversation", "operationId": "create_conversation_v1_assistant_conversations_post", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conversation" } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "403": { "description": "SESSION_REQUIRED or required source permission unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "503": { "description": "BAMI_UNAVAILABLE or CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } } }, "x-bami-phase": 1 }, "get": { "tags": [ "assistant" ], "summary": "List Conversations", "operationId": "list_conversations_v1_assistant_conversations_get", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationPage" } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "403": { "description": "SESSION_REQUIRED or required source permission unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "400": { "description": "INVALID_CURSOR", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } } }, "x-bami-phase": 1 } }, "/v1/assistant/conversations/{conversation_id}": { "get": { "tags": [ "assistant" ], "summary": "Get Conversation", "operationId": "get_conversation_v1_assistant_conversations__conversation_id__get", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Conversation Id" } }, { "name": "messages_cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Messages Cursor" } }, { "name": "events_cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Events Cursor" } }, { "name": "graphs_cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Graphs Cursor" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationDetail" } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "403": { "description": "SESSION_REQUIRED or required source permission unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "400": { "description": "INVALID_CURSOR", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } } }, "x-bami-phase": 1 }, "delete": { "tags": [ "assistant" ], "summary": "Delete Conversation", "operationId": "delete_conversation_v1_assistant_conversations__conversation_id__delete", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Conversation Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "403": { "description": "SESSION_REQUIRED or required source permission unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "503": { "description": "BAMI_UNAVAILABLE or CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } } }, "x-bami-phase": 1 } }, "/v1/assistant/conversations/{conversation_id}/scope": { "post": { "tags": [ "assistant" ], "summary": "Switch Scope", "operationId": "switch_scope_v1_assistant_conversations__conversation_id__scope_post", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Conversation Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScopeSwitch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScopeResult" } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "403": { "description": "SESSION_REQUIRED or required source permission unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "503": { "description": "BAMI_UNAVAILABLE or CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "409": { "description": "SCOPE_GENERATION_CONFLICT", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } } }, "x-bami-phase": 1 } }, "/v1/assistant/conversations/{conversation_id}/messages": { "post": { "tags": [ "assistant" ], "summary": "Message", "operationId": "message_v1_assistant_conversations__conversation_id__messages_post", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Conversation Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageCreate" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageAccepted" } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "403": { "description": "SESSION_REQUIRED or required source permission unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "503": { "description": "BAMI_UNAVAILABLE or CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "409": { "description": "ASSISTANT_BUSY, SCOPE_GENERATION_CONFLICT or IDEMPOTENCY_CONFLICT", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED or BAMI_BUDGET_EXCEEDED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } }, "headers": { "Retry-After": { "description": "Seconds before retry; matches error.retry_after_seconds.", "schema": { "type": "integer", "minimum": 0 } } } } }, "x-bami-phase": 1 } }, "/v1/assistant/conversations/{conversation_id}/events": { "get": { "tags": [ "assistant" ], "summary": "List Events", "operationId": "list_events_v1_assistant_conversations__conversation_id__events_get", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Conversation Id" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "run_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Events" } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "403": { "description": "SESSION_REQUIRED or required source permission unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "400": { "description": "INVALID_CURSOR", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } } }, "x-bami-phase": 1 } }, "/v1/assistant/conversations/{conversation_id}/events/stream": { "get": { "tags": [ "assistant" ], "summary": "Stream", "operationId": "stream_v1_assistant_conversations__conversation_id__events_stream_get", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Conversation Id" } }, { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "run_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Run Id" } }, { "name": "Last-Event-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last-Event-Id" } } ], "responses": { "200": { "description": "Durable replay and resync", "content": { "text/event-stream": { "schema": { "type": "string" } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "403": { "description": "SESSION_REQUIRED or required source permission unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "400": { "description": "INVALID_CURSOR", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } } }, "x-bami-phase": 1 } }, "/v1/assistant/conversations/{conversation_id}/graphs/{graph_id}": { "get": { "tags": [ "assistant" ], "summary": "Graph", "operationId": "graph_v1_assistant_conversations__conversation_id__graphs__graph_id__get", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Conversation Id" } }, { "name": "graph_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Graph Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Graph" } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "403": { "description": "SESSION_REQUIRED or required source permission unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "400": { "description": "INVALID_CURSOR", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } } }, "x-bami-phase": 1 } }, "/v1/assistant/approvals": { "get": { "tags": [ "assistant" ], "summary": "List Approvals", "operationId": "list_approvals_v1_assistant_approvals_get", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Limit" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "pending", "rejected", "expired", "stale", "executed", "failed" ], "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "action", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "activate", "delete", "deprecate" ], "type": "string" }, { "type": "null" } ], "title": "Action" } }, { "name": "agent_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Agent Id" } }, { "name": "requester_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Requester Id" } }, { "name": "from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "From" } }, { "name": "to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "To" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovalPage" } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "403": { "description": "SESSION_REQUIRED or required source permission unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "400": { "description": "INVALID_CURSOR", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } } }, "x-bami-phase": 1 } }, "/v1/assistant/approvals/{approval_id}": { "get": { "tags": [ "assistant" ], "summary": "Get Approval", "operationId": "get_approval_v1_assistant_approvals__approval_id__get", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "approval_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Approval Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovalRecord" } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "403": { "description": "SESSION_REQUIRED or required source permission unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "400": { "description": "INVALID_CURSOR", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } } }, "x-bami-phase": 1 } }, "/v1/assistant/approvals/{approval_id}/decision": { "post": { "tags": [ "assistant" ], "summary": "Decide Approval", "operationId": "decide_approval_v1_assistant_approvals__approval_id__decision_post", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "approval_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Approval Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovalDecision" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovalRecord" } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "403": { "description": "SESSION_REQUIRED or required source permission unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "503": { "description": "BAMI_UNAVAILABLE or CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } } }, "x-bami-phase": 1 } }, "/v1/assistant/reply-evidence/{approval_id}": { "get": { "tags": [ "assistant" ], "summary": "Get Reply Evidence", "operationId": "get_reply_evidence_v1_assistant_reply_evidence__approval_id__get", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "approval_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Approval Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplyEvidenceApproval" } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "403": { "description": "SESSION_REQUIRED or required source permission unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "400": { "description": "INVALID_CURSOR", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } } }, "x-bami-phase": 1 } }, "/v1/assistant/reply-evidence/{approval_id}/decision": { "post": { "tags": [ "assistant" ], "summary": "Decide Reply Evidence", "description": "A person answers Bami's offer. Reads no message row and starts no turn.\n\nOn allow the response carries diagnosis_id: the client_message_id the follow-up\nquestion must use, and the only diagnosis this approval will ever authorize.", "operationId": "decide_reply_evidence_v1_assistant_reply_evidence__approval_id__decision_post", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "approval_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Approval Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplyEvidenceDecision" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplyEvidenceApproval" } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "403": { "description": "SESSION_REQUIRED or required source permission unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "503": { "description": "BAMI_UNAVAILABLE or CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } } }, "x-bami-phase": 1 } }, "/v1/assistant/status": { "get": { "tags": [ "assistant" ], "summary": "Status", "description": "Whether Bami is on offer here, whether this workspace switched it on, and who may.", "operationId": "status_v1_assistant_status_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssistantStatus" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "403": { "description": "SESSION_REQUIRED or required source permission unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "400": { "description": "INVALID_CURSOR", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } } }, "security": [ { "BearerAuth": [] } ], "x-bami-phase": 1 } }, "/v1/assistant/workspace-switch": { "put": { "tags": [ "assistant" ], "summary": "Workspace Switch", "description": "Owner or admin only: turn Bami on or off for the whole workspace.", "operationId": "workspace_switch_v1_assistant_workspace_switch_put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceSwitch" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssistantStatus" } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "403": { "description": "SESSION_REQUIRED or required source permission unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } } }, "security": [ { "BearerAuth": [] } ], "x-bami-phase": 1 } }, "/v1/assistant/preferences": { "get": { "tags": [ "assistant" ], "summary": "Preferences", "operationId": "preferences_v1_assistant_preferences_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Preference" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "403": { "description": "SESSION_REQUIRED or required source permission unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "400": { "description": "INVALID_CURSOR", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } } }, "security": [ { "BearerAuth": [] } ], "x-bami-phase": 1 }, "patch": { "tags": [ "assistant" ], "summary": "Update Preferences", "operationId": "update_preferences_v1_assistant_preferences_patch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Preference" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Preference" } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "403": { "description": "SESSION_REQUIRED or required source permission unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "503": { "description": "BAMI_UNAVAILABLE or CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } } }, "security": [ { "BearerAuth": [] } ], "x-bami-phase": 1 } }, "/v1/audit/records": { "get": { "tags": [ "audit" ], "summary": "List Audit Records", "description": "List audit trail records for the authenticated workspace.", "operationId": "list_audit_records_v1_audit_records_get", "security": [ { "BearerAuth": [ "audit:read" ] } ], "parameters": [ { "name": "session_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Session Id" } }, { "name": "run_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Run Id" } }, { "name": "action", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action" } }, { "name": "request_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AuditRecordRead" }, "title": "Response List Audit Records V1 Audit Records Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/deployments": { "post": { "tags": [ "deployments" ], "summary": "Create a deployment", "operationId": "createDeployment", "security": [ { "BearerAuth": [ "agents:write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDeploymentRequest" } } } }, "responses": { "201": { "description": "Deployment snapshot created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeploymentResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/AuthenticationRequired" }, "403": { "$ref": "#/components/responses/PermissionDenied" }, "404": { "$ref": "#/components/responses/ResourceNotFound" } }, "description": "Pin an immutable agent revision and its application-tool definitions." }, "get": { "tags": [ "deployments" ], "summary": "List deployments", "operationId": "listDeployments", "security": [ { "BearerAuth": [ "agents:read" ] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "agent_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agent Id" } } ], "responses": { "200": { "description": "Deployment page.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeploymentListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "401": { "$ref": "#/components/responses/AuthenticationRequired" }, "403": { "$ref": "#/components/responses/PermissionDenied" } }, "description": "List immutable deployments for the authenticated workspace." } }, "/v1/deployments/{deployment_id}": { "get": { "tags": [ "deployments" ], "summary": "Get a deployment", "operationId": "getDeployment", "security": [ { "BearerAuth": [ "agents:read" ] } ], "parameters": [ { "name": "deployment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Deployment Id" } } ], "responses": { "200": { "description": "Deployment snapshot.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeploymentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "401": { "$ref": "#/components/responses/AuthenticationRequired" }, "403": { "$ref": "#/components/responses/PermissionDenied" }, "404": { "$ref": "#/components/responses/ResourceNotFound" } }, "description": "Retrieve an immutable deployment snapshot." } }, "/v1/deployments/{deployment_id}/activate": { "post": { "tags": [ "deployments" ], "summary": "Activate Deployment", "operationId": "activate_deployment_v1_deployments__deployment_id__activate_post", "security": [ { "BearerAuth": [ "agents:write" ] } ], "parameters": [ { "name": "deployment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Deployment Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeploymentResponse" } } } }, "404": { "description": "Unknown deployment or deployment owned by another tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountErrorEnvelope" } } } }, "409": { "description": "Legacy snapshots cannot be activated; only published snapshots are eligible.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountErrorEnvelope" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/diagnostics/requests/{request_id}": { "get": { "tags": [ "diagnostics" ], "summary": "Request Lookup", "operationId": "request_lookup_v1_diagnostics_requests__request_id__get", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "request_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Request Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "audit_cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Audit Cursor" } }, { "name": "sessions_cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sessions Cursor" } }, { "name": "runs_cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Runs Cursor" } }, { "name": "events_cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Events Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticLookup" } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "403": { "description": "SESSION_REQUIRED or required source permission unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "400": { "description": "INVALID_CURSOR", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } } }, "x-bami-phase": 1 } }, "/v1/agents/{agent_id}/observability": { "get": { "tags": [ "diagnostics" ], "summary": "Observability", "operationId": "observability_v1_agents__agent_id__observability_get", "security": [ { "BearerAuth": [ "agents:read", "sessions:read" ] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } }, { "name": "deployment_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deployment Id" } }, { "name": "from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "From" } }, { "name": "to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "To" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Observability" } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "403": { "description": "SESSION_REQUIRED or required source permission unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "400": { "description": "INVALID_CURSOR", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } } }, "x-bami-phase": 1 } }, "/v1/admin/environments": { "post": { "tags": [ "admin-environments", "admin" ], "summary": "Create Environment", "operationId": "create_environment_v1_admin_environments_post", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEnvironmentRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Requires an admin key." }, "get": { "tags": [ "admin-environments", "admin" ], "summary": "List Environments Admin", "operationId": "list_environments_admin_v1_admin_environments_get", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Limit" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Requires an admin key." } }, "/v1/admin/environments/{env_id}": { "get": { "tags": [ "admin-environments", "admin" ], "summary": "Get Environment Admin", "operationId": "get_environment_admin_v1_admin_environments__env_id__get", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "env_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Env Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Requires an admin key." }, "put": { "tags": [ "admin-environments", "admin" ], "summary": "Update Environment", "operationId": "update_environment_v1_admin_environments__env_id__put", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "env_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Env Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEnvironmentRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Requires an admin key." }, "delete": { "tags": [ "admin-environments", "admin" ], "summary": "Delete Environment", "operationId": "delete_environment_v1_admin_environments__env_id__delete", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "env_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Env Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Requires an admin key." } }, "/v1/environments": { "get": { "tags": [ "environments" ], "summary": "List Environments", "operationId": "list_environments_v1_environments_get", "security": [ { "BearerAuth": [ "sessions:read" ] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Limit" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/environments/{env_id}": { "get": { "tags": [ "environments" ], "summary": "Get Environment", "operationId": "get_environment_v1_environments__env_id__get", "security": [ { "BearerAuth": [ "sessions:read" ] } ], "parameters": [ { "name": "env_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Env Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/sessions/{session_id}/events": { "post": { "tags": [ "events" ], "summary": "Append session events", "description": "Append customer input events to the persisted session timeline.", "operationId": "sendSessionEvents", "security": [ { "BearerAuth": [ "sessions:read", "events:write" ] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendEventsRequest" } } } }, "responses": { "200": { "description": "Events accepted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendEventsResponse" } } } }, "429": { "description": "Tenant rate limit reached.", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantRateLimitEnvelope" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "401": { "$ref": "#/components/responses/AuthenticationRequired" }, "403": { "$ref": "#/components/responses/PermissionDenied" }, "404": { "$ref": "#/components/responses/ResourceNotFound" } } }, "get": { "tags": [ "events" ], "summary": "List session events", "operationId": "listSessionEvents", "security": [ { "BearerAuth": [ "sessions:read", "events:read" ] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } }, { "name": "request_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^(asc|desc)$", "default": "asc", "title": "Order" } }, { "name": "types", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated event types", "title": "Types" }, "description": "Comma-separated event types" }, { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Opaque event cursor", "title": "After" }, "description": "Event ID cursor. Events strictly after this cursor are returned." }, { "name": "run_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by run ID, accepting compact or dashed UUIDs.", "title": "Run Id" }, "description": "Filter by run ID, accepting compact or dashed UUIDs." } ], "responses": { "200": { "description": "Persisted events ordered by sequence.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "400": { "description": "Invalid cursor for session.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "$ref": "#/components/responses/AuthenticationRequired" }, "403": { "$ref": "#/components/responses/PermissionDenied" }, "404": { "$ref": "#/components/responses/ResourceNotFound" } }, "description": "List persisted session events ordered by session sequence with cursor replay." } }, "/v1/sessions/{session_id}/events/stream": { "get": { "tags": [ "events" ], "summary": "Stream session events", "description": "SSE stream of session events. Replays persisted events strictly after Last-Event-ID. With event_deltas=true, live ephemeral events are interleaved without an SSE id line; they are not persisted and not replayable. If subscription or barrier startup fails, the connection stays open and polls persisted events with ids, without sending stream.resync. X-Pantheon-Live-Events is unavailable on that degraded response and live otherwise (including when deltas were not requested). If live delivery fails mid-stream, one stream.resync event with session_id and a string run_id is sent without an id, then the connection closes. Reconnect with the last durable SSE id. A malformed run_id filter returns HTTP 400 with code invalid_run_id before streaming.", "operationId": "streamSessionEvents", "security": [ { "BearerAuth": [ "sessions:read", "events:read" ] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } }, { "name": "event_deltas", "in": "query", "required": false, "schema": { "type": "boolean", "description": "When true, interleave live ephemeral events without an SSE id line. Ephemeral events are not persisted and not replayable. If live startup fails, the connection stays open with persisted events only and X-Pantheon-Live-Events: unavailable; otherwise the header is live. If live delivery fails mid-stream, one stream.resync event with session_id and run_id is sent without an id, then the connection closes.", "default": false, "title": "Event Deltas" }, "description": "When true, interleave live ephemeral events without an SSE id line. Ephemeral events are not persisted and not replayable. If live startup fails, the connection stays open with persisted events only and X-Pantheon-Live-Events: unavailable; otherwise the header is live. If live delivery fails mid-stream, one stream.resync event with session_id and run_id is sent without an id, then the connection closes." }, { "name": "run_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by run ID, accepting compact or dashed UUIDs.", "title": "Run Id" }, "description": "Filter by run ID, accepting compact or dashed UUIDs." }, { "name": "Last-Event-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last-Event-Id" } } ], "responses": { "200": { "description": "Durable SSE event stream.", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "400": { "$ref": "#/components/responses/InvalidRequest" }, "401": { "$ref": "#/components/responses/AuthenticationRequired" }, "403": { "$ref": "#/components/responses/PermissionDenied" }, "404": { "$ref": "#/components/responses/ResourceNotFound" } } } }, "/health/components": { "get": { "tags": [ "health" ], "summary": "Component health", "description": "Public liveness of api, database, worker, and sandbox provider.\n\nCached for 15 seconds. Omits hostnames, secrets, and stack traces.", "operationId": "get_component_health_health_components_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComponentHealthResponse" } } } } } } }, "/v1/sessions/{session_id}/messages": { "get": { "tags": [ "messages" ], "summary": "List Messages", "operationId": "list_messages_v1_sessions__session_id__messages_get", "security": [ { "BearerAuth": [ "sessions:read", "runs:read" ] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 200, "title": "Limit" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^(asc|desc)$", "default": "asc", "title": "Order" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/models": { "get": { "tags": [ "models" ], "summary": "List Models", "description": "List the LLM models available for agents and runs (public).", "operationId": "list_models_v1_models_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelsListResponse" } } } } } } }, "/v1/sessions/{session_id}/runs/{run_id}/resume": { "post": { "tags": [ "runs" ], "summary": "Resume a run", "operationId": "resumeRun", "security": [ { "BearerAuth": [ "sessions:read", "runs:resume" ] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } }, { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "title": "Idempotency-Key" } }, { "$ref": "#/components/parameters/RequestIdHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/app__modules__resume__resume_schema__ResumeRequest" } } } }, "responses": { "202": { "description": "Results accepted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResumeAccepted" } } } }, "429": { "description": "Tenant rate limit reached.", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantRateLimitEnvelope" } } } }, "422": { "description": "Tool result schema validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "400": { "$ref": "#/components/responses/InvalidRequest" }, "401": { "$ref": "#/components/responses/AuthenticationRequired" }, "403": { "$ref": "#/components/responses/PermissionDenied" }, "404": { "$ref": "#/components/responses/ResourceNotFound" }, "409": { "description": "Idempotency conflict, event already resolved, event expired, or run not resumable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "$ref": "#/components/responses/RuntimeResumeUnavailable" } }, "description": "Submit correlated tool results or confirmations to resume a paused run." } }, "/v1/sessions/{session_id}/runs": { "post": { "tags": [ "runs" ], "summary": "Start a run", "description": "Start an asynchronous run in the specified session.\n\nRequires at least one user.message event with non-whitespace text. Invalid input returns 422 invalid_request before creating a run. Use the resume endpoint for waiting runs.", "operationId": "createRun", "security": [ { "BearerAuth": [ "sessions:read", "runs:create" ] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "server_url", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Server Url" } }, { "$ref": "#/components/parameters/IdempotencyKeyHeader" }, { "$ref": "#/components/parameters/RequestIdHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRunRequest" } } } }, "responses": { "200": { "description": "Run created and queued.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunResponse" } } } }, "409": { "description": "Session is busy with an active run, or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionBusyErrorEnvelope" } } } }, "429": { "description": "Tenant rate limit reached.", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantRateLimitEnvelope" } } } }, "422": { "description": "Invalid run input. events must contain at least one user.message with non-whitespace text. Missing events, empty events, or a prompt only in an unknown field such as input are rejected before a run is created.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "invalid_request" ] }, "message": { "type": "string" }, "request_id": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } } } } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequest" }, "401": { "$ref": "#/components/responses/AuthenticationRequired" }, "403": { "$ref": "#/components/responses/PermissionDenied" }, "404": { "$ref": "#/components/responses/ResourceNotFound" }, "503": { "$ref": "#/components/responses/RuntimeResumeUnavailable" } } } }, "/v1/sessions/{session_id}/runs/{run_id}/stream": { "get": { "tags": [ "runs" ], "summary": "Stream run events", "description": "Stream real-time Server-Sent Events (SSE) for a run with replay support via Last-Event-ID.", "operationId": "streamRun", "security": [ { "BearerAuth": [ "sessions:read", "events:read" ] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } }, { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "server_url", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Server Url" } }, { "name": "Last-Event-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last-Event-Id" }, "description": "Resume event replay strictly after this event ID." } ], "responses": { "200": { "description": "SSE event stream.", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "401": { "$ref": "#/components/responses/AuthenticationRequired" }, "403": { "$ref": "#/components/responses/PermissionDenied" }, "404": { "$ref": "#/components/responses/ResourceNotFound" } } } }, "/v1/sessions/{session_id}/runs/wait": { "post": { "tags": [ "runs" ], "summary": "Start a run and wait", "description": "Start a run and wait for its current execution phase to finish.\n\nRequires at least one user.message event with non-whitespace text. Invalid input returns 422 invalid_request before creating a run. Use the resume endpoint for waiting runs.", "operationId": "waitRun", "security": [ { "BearerAuth": [ "sessions:read", "runs:create" ] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "server_url", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Server Url" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRunRequest" } } } }, "responses": { "200": { "description": "Current run response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunResponse" } } } }, "409": { "description": "Session is busy with an active run.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionBusyErrorEnvelope" } } } }, "429": { "description": "Tenant rate limit reached.", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantRateLimitEnvelope" } } } }, "422": { "description": "Invalid run input. events must contain at least one user.message with non-whitespace text. Missing events, empty events, or a prompt only in an unknown field such as input are rejected before a run is created.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "invalid_request" ] }, "message": { "type": "string" }, "request_id": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } } } } } } } } }, "401": { "$ref": "#/components/responses/AuthenticationRequired" }, "403": { "$ref": "#/components/responses/PermissionDenied" }, "404": { "$ref": "#/components/responses/ResourceNotFound" }, "503": { "$ref": "#/components/responses/RuntimeResumeUnavailable" } } } }, "/v1/sessions/{session_id}/runs/{run_id}/stop": { "post": { "tags": [ "runs" ], "summary": "Stop a run", "operationId": "stopRun", "security": [ { "BearerAuth": [ "sessions:read", "runs:resume" ] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } }, { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "server_url", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Server Url" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StopRunRequest", "default": {} } } } }, "responses": { "200": { "description": "Run cancellation accepted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StopRunResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "401": { "$ref": "#/components/responses/AuthenticationRequired" }, "403": { "$ref": "#/components/responses/PermissionDenied" }, "404": { "$ref": "#/components/responses/ResourceNotFound" } }, "description": "Request cancellation of an active run." } }, "/v1/sessions/{session_id}/runs/{run_id}": { "get": { "tags": [ "runs" ], "summary": "Get Run", "description": "Fetch a run's recorded status and details.", "operationId": "get_run_v1_sessions__session_id__runs__run_id__get", "security": [ { "BearerAuth": [ "sessions:read", "runs:read" ] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } }, { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "server_url", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Server Url" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunDetailResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/sessions/{session_id}/runs/{run_id}/cancel": { "post": { "tags": [ "runs" ], "summary": "Cancel a run", "description": "Cancel an active or waiting run, releasing the session busy state.", "operationId": "cancelRun", "security": [ { "BearerAuth": [ "sessions:read", "runs:resume" ] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } }, { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "server_url", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Server Url" } }, { "$ref": "#/components/parameters/RequestIdHeader" } ], "responses": { "202": { "description": "Run cancelled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunDetailResponse" } } } }, "409": { "description": "Run is not cancellable because it is already terminal.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunNotCancellableErrorEnvelope" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "401": { "$ref": "#/components/responses/AuthenticationRequired" }, "403": { "$ref": "#/components/responses/PermissionDenied" }, "404": { "$ref": "#/components/responses/ResourceNotFound" } } } }, "/v1/sessions/{session_id}/sandbox": { "post": { "tags": [ "sandbox" ], "summary": "Provision Sandbox", "description": "Provision a sandbox for a session.\n\nCreates a Daytona sandbox with 30-minute TTL and a host workspace.\nIdempotent , returns existing sandbox if already provisioned.", "operationId": "provision_sandbox_v1_sessions__session_id__sandbox_post", "security": [ { "BearerAuth": [ "sessions:read", "sessions:write" ] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "server_url", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Server Url" } } ], "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "sandbox" ], "summary": "Destroy Sandbox", "description": "Destroy the sandbox for a session and clean up workspace.", "operationId": "destroy_sandbox_v1_sessions__session_id__sandbox_delete", "security": [ { "BearerAuth": [ "sessions:read", "sessions:write" ] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "server_url", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Server Url" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/sessions/{session_id}/sandbox/sync": { "post": { "tags": [ "sandbox" ], "summary": "Sync Sandbox", "description": "Sync files between host workspace and sandbox.\n\n- direction=\"to\": host → sandbox (upload workspace files)\n- direction=\"from\": sandbox → host (download sandbox files)", "operationId": "sync_sandbox_v1_sessions__session_id__sandbox_sync_post", "security": [ { "BearerAuth": [ "sessions:read", "sessions:write" ] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "server_url", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Server Url" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncRequest", "default": { "direction": "to" } } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/sessions/{session_id}/sandbox/extend-ttl": { "post": { "tags": [ "sandbox" ], "summary": "Extend Sandbox Ttl", "description": "Extend the sandbox TTL, resetting the countdown.", "operationId": "extend_sandbox_ttl_v1_sessions__session_id__sandbox_extend_ttl_post", "security": [ { "BearerAuth": [ "sessions:read", "sessions:write" ] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "server_url", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Server Url" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtendTtlRequest", "default": { "minutes": 10 } } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtendTtlResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/sessions/{session_id}/files/upload": { "post": { "tags": [ "sandbox" ], "summary": "Upload File", "description": "Upload a file to the session workspace and sandbox.", "operationId": "upload_file_v1_sessions__session_id__files_upload_post", "security": [ { "BearerAuth": [ "sessions:read", "sessions:write" ] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "server_url", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Server Url" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_file_v1_sessions__session_id__files_upload_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/sessions/{session_id}/files/{path}": { "get": { "tags": [ "sandbox" ], "summary": "Download File", "description": "Download a file from the session workspace.", "operationId": "download_file_v1_sessions__session_id__files__path__get", "security": [ { "BearerAuth": [ "sessions:read" ] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } }, { "name": "path", "in": "path", "required": true, "schema": { "type": "string", "title": "Path" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "server_url", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Server Url" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/sessions/{session_id}/files": { "get": { "tags": [ "sandbox" ], "summary": "List Files", "description": "List all files in the session workspace.", "operationId": "list_files_v1_sessions__session_id__files_get", "security": [ { "BearerAuth": [ "sessions:read" ] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "server_url", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Server Url" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/secrets": { "get": { "tags": [ "secrets" ], "summary": "List Secrets", "operationId": "list_secrets_v1_secrets_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretListResponse" } } } } }, "security": [ { "BearerAuth": [ "secrets:read" ] } ] }, "post": { "tags": [ "secrets" ], "summary": "Create Secret", "description": "Store a credential for this workspace.\n\nThe value is encrypted at rest and is never returned by any route. Name a\nsecret on a session to deliver it into that session's sandbox, and read the\nwarning on the value field before you choose which credential to store.", "operationId": "create_secret_v1_secrets_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSecretRequest" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [ "secrets:write" ] } ] } }, "/v1/secrets/{name}": { "get": { "tags": [ "secrets" ], "summary": "Get Secret", "operationId": "get_secret_v1_secrets__name__get", "security": [ { "BearerAuth": [ "secrets:read" ] } ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "secrets" ], "summary": "Update Secret", "description": "Rotate the value, edit the description, or both.\n\nThe id and the name survive a rotation, so a session that already names this\nsecret picks up the new value the next time its sandbox is provisioned.", "operationId": "update_secret_v1_secrets__name__put", "security": [ { "BearerAuth": [ "secrets:write" ] } ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSecretRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "secrets" ], "summary": "Delete Secret", "description": "Forget the credential.\n\nThis removes Pantheon's copy. It does not revoke anything at the provider\nthat issued the credential, and a sandbox already running still holds the\nvalue it was given. Revoke at the source as well.", "operationId": "delete_secret_v1_secrets__name__delete", "security": [ { "BearerAuth": [ "secrets:write" ] } ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/sessions": { "post": { "tags": [ "sessions" ], "summary": "Create Session", "description": "Create a session pinned to an immutable agent deployment snapshot.", "operationId": "create_session_v1_sessions_post", "security": [ { "BearerAuth": [ "sessions:write" ] } ], "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "server_url", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Server Url" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSessionRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } } }, "429": { "description": "Tenant rate limit reached.", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantRateLimitEnvelope" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "sessions" ], "summary": "List Sessions", "description": "List tenant sessions with optional user, agent, and status filters.", "operationId": "list_sessions_v1_sessions_get", "security": [ { "BearerAuth": [ "sessions:read" ] } ], "parameters": [ { "name": "user_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id" } }, { "name": "agent_slug", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agent Slug" } }, { "name": "statuses", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated statuses", "title": "Statuses" }, "description": "Comma-separated statuses" }, { "name": "request_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Limit" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "server_url", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Server Url" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/sessions/{session_id}": { "get": { "tags": [ "sessions" ], "summary": "Get Session", "description": "Get one session and its pinned deployment and sandbox state.", "operationId": "get_session_v1_sessions__session_id__get", "security": [ { "BearerAuth": [ "sessions:read" ] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "server_url", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Server Url" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "sessions" ], "summary": "Update Session", "description": "Update mutable session settings without changing its pinned deployment.", "operationId": "update_session_v1_sessions__session_id__post", "security": [ { "BearerAuth": [ "sessions:read", "sessions:write" ] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "server_url", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Server Url" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSessionRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "sessions" ], "summary": "Delete Session", "description": "Soft-delete a session and release its active sandbox resources.", "operationId": "delete_session_v1_sessions__session_id__delete", "security": [ { "BearerAuth": [ "sessions:read", "sessions:write" ] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "server_url", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Server Url" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/sessions/{session_id}/archive": { "post": { "tags": [ "sessions" ], "summary": "Archive Session", "description": "Archive a session and release its active sandbox resources.", "operationId": "archive_session_v1_sessions__session_id__archive_post", "security": [ { "BearerAuth": [ "sessions:read", "sessions:write" ] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "server_url", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Server Url" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionArchiveResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/skills": { "get": { "tags": [ "tenant-skills" ], "summary": "List Tenant Skills", "operationId": "list_tenant_skills_v1_skills_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillListResponse" } } } } }, "security": [ { "BearerAuth": [ "agents:read" ] } ] }, "post": { "tags": [ "tenant-skills" ], "summary": "Create Tenant Skill", "operationId": "create_tenant_skill_v1_skills_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSkillRequest" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillCreateResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [ "agents:write" ] } ] } }, "/v1/skills/{name}": { "get": { "tags": [ "tenant-skills" ], "summary": "Get Tenant Skill", "operationId": "get_tenant_skill_v1_skills__name__get", "security": [ { "BearerAuth": [ "agents:read" ] } ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "tenant-skills" ], "summary": "Update Tenant Skill", "operationId": "update_tenant_skill_v1_skills__name__put", "security": [ { "BearerAuth": [ "agents:write" ] } ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSkillRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "tenant-skills" ], "summary": "Delete Tenant Skill", "operationId": "delete_tenant_skill_v1_skills__name__delete", "security": [ { "BearerAuth": [ "agents:write" ] } ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/skills/import": { "post": { "tags": [ "tenant-skills" ], "summary": "Import Tenant Skill Md", "operationId": "import_tenant_skill_md_v1_skills_import_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillImportRequest" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillImportResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [ "agents:write" ] } ] } }, "/v1/skills/validate": { "post": { "tags": [ "tenant-skills" ], "summary": "Validate Skill", "operationId": "validate_skill_v1_skills_validate_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillValidateRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillValidateResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [ "agents:read" ] } ] } }, "/v1/skills/upload": { "post": { "tags": [ "tenant-skills" ], "summary": "Import Tenant Skill File", "operationId": "import_tenant_skill_file_v1_skills_upload_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_import_tenant_skill_file_v1_skills_upload_post" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillImportResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [ "agents:write" ] } ] } }, "/v1/skills/{name}/download": { "get": { "tags": [ "tenant-skills" ], "summary": "Download Tenant Skill", "operationId": "download_tenant_skill_v1_skills__name__download_get", "security": [ { "BearerAuth": [ "agents:read" ] } ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/skills/{name}/files/content": { "get": { "tags": [ "tenant-skills" ], "summary": "Get Tenant Skill File Content", "operationId": "get_tenant_skill_file_content_v1_skills__name__files_content_get", "security": [ { "BearerAuth": [ "agents:read" ] } ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } }, { "name": "path", "in": "query", "required": true, "schema": { "type": "string", "title": "Path" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/skills/{name}/files": { "post": { "tags": [ "tenant-skills" ], "summary": "Upload Tenant Skill File", "operationId": "upload_tenant_skill_file_v1_skills__name__files_post", "security": [ { "BearerAuth": [ "agents:write" ] } ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_tenant_skill_file_v1_skills__name__files_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillFileUploadResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/admin/tenants/{tenant_id}/skills": { "post": { "tags": [ "admin-org-skills", "admin" ], "summary": "Create Org Skill", "operationId": "create_org_skill_v1_admin_tenants__tenant_id__skills_post", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tenant Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSkillRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillCreateResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Requires an admin key." } }, "/v1/admin/skills/builtin": { "post": { "tags": [ "admin-skills", "admin" ], "summary": "Create Builtin Skill", "operationId": "create_builtin_skill_v1_admin_skills_builtin_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSkillRequest" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillCreateResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ], "description": "Requires an admin key." } }, "/v1/sessions/{session_id}/skills/catalog": { "get": { "tags": [ "session-skills" ], "summary": "Get Skill Catalog", "operationId": "get_skill_catalog_v1_sessions__session_id__skills_catalog_get", "security": [ { "BearerAuth": [ "sessions:read" ] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillCatalogResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/sessions/{session_id}/skills/enabled": { "put": { "tags": [ "session-skills" ], "summary": "Set Enabled Skills", "operationId": "set_enabled_skills_v1_sessions__session_id__skills_enabled_put", "security": [ { "BearerAuth": [ "sessions:read", "sessions:write" ] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillEnableRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillEnableResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/sessions/{session_id}/artifacts": { "get": { "tags": [ "artifacts" ], "summary": "List Artifacts", "operationId": "list_artifacts_v1_sessions__session_id__artifacts_get", "security": [ { "BearerAuth": [ "sessions:read" ] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/sessions/{session_id}/artifacts/{artifact_id}": { "get": { "tags": [ "artifacts" ], "summary": "Get Artifact", "operationId": "get_artifact_v1_sessions__session_id__artifacts__artifact_id__get", "security": [ { "BearerAuth": [ "sessions:read" ] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } }, { "name": "artifact_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Artifact Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "artifacts" ], "summary": "Delete Artifact", "operationId": "delete_artifact_v1_sessions__session_id__artifacts__artifact_id__delete", "security": [ { "BearerAuth": [ "sessions:read", "sessions:write" ] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } }, { "name": "artifact_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Artifact Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactDeleteResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/sessions/{session_id}/artifacts/{artifact_id}/download": { "get": { "tags": [ "artifacts" ], "summary": "Download Artifact", "operationId": "download_artifact_v1_sessions__session_id__artifacts__artifact_id__download_get", "security": [ { "BearerAuth": [ "sessions:read" ] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } }, { "name": "artifact_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Artifact Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/sessions/{session_id}/artifacts/{artifact_id}/files/{path}": { "get": { "tags": [ "artifacts" ], "summary": "Serve Artifact Subfile", "operationId": "serve_artifact_subfile_v1_sessions__session_id__artifacts__artifact_id__files__path__get", "security": [ { "BearerAuth": [ "sessions:read" ] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } }, { "name": "artifact_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Artifact Id" } }, { "name": "path", "in": "path", "required": true, "schema": { "type": "string", "title": "Path" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/api-keys": { "get": { "tags": [ "tenant-api-keys" ], "summary": "List Tenant Api Keys", "operationId": "list_tenant_api_keys_v1_api_keys_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/TenantApiKeyResponse" }, "type": "array", "title": "Response List Tenant Api Keys V1 Api Keys Get" } } } } }, "security": [ { "BearerAuth": [] } ] }, "post": { "tags": [ "tenant-api-keys" ], "summary": "Create Tenant Api Key", "description": "Mint a new tenant API key for the current tenant.\n\nThe raw key (`pk_...`) is returned in the `raw_key` field **exactly once**\n, copy it now. Only a SHA-256 hash is stored at rest.", "operationId": "create_tenant_api_key_v1_api_keys_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantApiKeyCreateRequest" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantApiKeyResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1/api-keys/{key_id}": { "delete": { "tags": [ "tenant-api-keys" ], "summary": "Delete Tenant Api Key", "operationId": "delete_tenant_api_key_v1_api_keys__key_id__delete", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "key_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Key Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/admin/tenants/{tenant_id}/api-keys": { "post": { "tags": [ "admin-tenant-api-keys", "admin" ], "summary": "Admin Create Tenant Api Key", "description": "Requires an admin key. Mint a tenant API key for a tenant (super-admin).\n\nThe raw key (`pk_...`) is returned in the `raw_key` field **exactly once**\n, copy it now. Only a SHA-256 hash is stored at rest. Authorize the /docs\nUI with this key to test the tenant `/v1/*` endpoints.", "operationId": "admin_create_tenant_api_key_v1_admin_tenants__tenant_id__api_keys_post", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tenant Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantApiKeyCreateRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantApiKeyResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "admin-tenant-api-keys", "admin" ], "summary": "Admin List Tenant Api Keys", "operationId": "admin_list_tenant_api_keys_v1_admin_tenants__tenant_id__api_keys_get", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tenant Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TenantApiKeyResponse" }, "title": "Response Admin List Tenant Api Keys V1 Admin Tenants Tenant Id Api Keys Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Requires an admin key." } }, "/v1/admin/tenants/{tenant_id}/api-keys/{key_id}": { "delete": { "tags": [ "admin-tenant-api-keys", "admin" ], "summary": "Admin Delete Tenant Api Key", "operationId": "admin_delete_tenant_api_key_v1_admin_tenants__tenant_id__api_keys__key_id__delete", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tenant Id" } }, { "name": "key_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Key Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Requires an admin key." } }, "/v1/users": { "post": { "tags": [ "tenant-users" ], "summary": "Create User", "operationId": "create_user_v1_users_post", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTenantUserRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantUserResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "tenant-users" ], "summary": "List Users", "operationId": "list_users_v1_users_get", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Limit" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantUserListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/users/{user_id}": { "get": { "tags": [ "tenant-users" ], "summary": "Get User", "operationId": "get_user_v1_users__user_id__get", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantUserResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "tenant-users" ], "summary": "Update User", "operationId": "update_user_v1_users__user_id__put", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTenantUserRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantUserResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "tenant-users" ], "summary": "Delete User", "operationId": "delete_user_v1_users__user_id__delete", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/admin/users": { "get": { "tags": [ "admin-users", "admin" ], "summary": "Admin List Users", "operationId": "admin_list_users_v1_admin_users_get", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "tenant_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Limit" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantUserListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Requires an admin key." } }, "/v1/admin/users/{user_id}": { "get": { "tags": [ "admin-users", "admin" ], "summary": "Admin Get User", "operationId": "admin_get_user_v1_admin_users__user_id__get", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantUserResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Requires an admin key." }, "put": { "tags": [ "admin-users", "admin" ], "summary": "Admin Update User", "operationId": "admin_update_user_v1_admin_users__user_id__put", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTenantUserRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantUserResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Requires an admin key." } }, "/v1/admin/tenants": { "post": { "tags": [ "tenants", "admin" ], "summary": "Create Tenant", "operationId": "create_tenant_v1_admin_tenants_post", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTenantRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Requires an admin key." }, "get": { "tags": [ "tenants", "admin" ], "summary": "List Tenants", "operationId": "list_tenants_v1_admin_tenants_get", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Limit" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Requires an admin key." } }, "/v1/admin/tenants/{tenant_id}": { "get": { "tags": [ "tenants", "admin" ], "summary": "Get Tenant", "operationId": "get_tenant_v1_admin_tenants__tenant_id__get", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tenant Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Requires an admin key." }, "put": { "tags": [ "tenants", "admin" ], "summary": "Update Tenant", "operationId": "update_tenant_v1_admin_tenants__tenant_id__put", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tenant Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTenantRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Requires an admin key." }, "patch": { "tags": [ "tenants", "admin" ], "summary": "Update Tenant", "operationId": "update_tenant_v1_admin_tenants__tenant_id__patch", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tenant Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTenantRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Requires an admin key." }, "delete": { "tags": [ "tenants", "admin" ], "summary": "Delete Tenant", "operationId": "delete_tenant_v1_admin_tenants__tenant_id__delete", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tenant Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Requires an admin key." } }, "/v1/workspace/receipts": { "get": { "tags": [ "workspace" ], "summary": "Workspace Receipts", "description": "Customer visible receipts for operator actions on this workspace (suspension, resumption, key revocation, limit changes, Bami enablement), newest first.", "operationId": "workspace_receipts_v1_workspace_receipts_get", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "kind", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" }, "maxItems": 20 }, { "type": "null" } ], "title": "Kind" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceiptPage" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/tests": { "post": { "tags": [ "tests" ], "summary": "Create Test", "operationId": "create_test_v1_tests_post", "security": [ { "BearerAuth": [ "sessions:write", "runs:create" ] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 64, "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestCreate" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Receipt" } } } }, "422": { "description": "INVALID_REQUEST, TEST_INELIGIBLE or INVALID_TOOL_STUB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "403": { "description": "SESSION_REQUIRED or required source permission unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "503": { "description": "BAMI_UNAVAILABLE or CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "409": { "description": "ASSISTANT_BUSY, SCOPE_GENERATION_CONFLICT or IDEMPOTENCY_CONFLICT", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED or BAMI_BUDGET_EXCEEDED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } }, "headers": { "Retry-After": { "description": "Seconds before retry; matches error.retry_after_seconds.", "schema": { "type": "integer", "minimum": 0 } } } } }, "x-bami-phase": 1 } }, "/v1/tests/{test_id}": { "get": { "tags": [ "tests" ], "summary": "Get Test", "operationId": "get_test_v1_tests__test_id__get", "security": [ { "BearerAuth": [ "sessions:read", "runs:read" ] } ], "parameters": [ { "name": "test_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Test Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Receipt" } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "403": { "description": "SESSION_REQUIRED or required source permission unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } }, "400": { "description": "INVALID_CURSOR", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BamiErrorEnvelope" } } } } }, "x-bami-phase": 1 } }, "/v1/tools": { "post": { "tags": [ "tools" ], "summary": "Create a tool", "operationId": "createTool", "security": [ { "BearerAuth": [ "tools:write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateToolRequest" } } } }, "responses": { "201": { "description": "Tool and version 1 definition created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolResponse" } } } }, "422": { "description": "Invalid tool definition. Confirmation 'always' returns invalid_request with details at /body/confirmation. Only 'never' and 'policy' are supported in this release; gate the call in your application.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "400": { "$ref": "#/components/responses/InvalidRequest" }, "401": { "$ref": "#/components/responses/AuthenticationRequired" }, "403": { "$ref": "#/components/responses/PermissionDenied" }, "409": { "description": "Tool name already exists. Look up the tool using GET /v1/tools?name=.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolNameConflictEnvelope" }, "example": { "error": { "code": "idempotency_conflict", "message": "Tool name already exists", "details": [ { "path": "/body/name", "reason": "Tool name already exists", "tool_id": "tool_existing", "latest_version": 2 } ] } } } } } }, "description": "Create a stable tenant-scoped tool and its initial version 1 definition.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKeyHeader" }, { "$ref": "#/components/parameters/RequestIdHeader" } ] }, "get": { "tags": [ "tools" ], "summary": "List tools", "description": "List tools. Use the exact name filter to look a tool up by name before creating it.", "operationId": "listTools", "security": [ { "BearerAuth": [ "tools:read" ] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Limit" }, "description": "Maximum number of tools to return (1-100)." }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by exact tool name.", "title": "Name" }, "description": "Filter by exact tool name." }, { "name": "after", "in": "query", "description": "Cursor for pagination (tool ID).", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A list of tools with next cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "401": { "$ref": "#/components/responses/AuthenticationRequired" }, "403": { "$ref": "#/components/responses/PermissionDenied" } } } }, "/v1/tools/{tool_id}": { "get": { "tags": [ "tools" ], "summary": "Get tool by ID", "operationId": "getTool", "security": [ { "BearerAuth": [ "tools:read" ] } ], "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tool Id" } } ], "responses": { "200": { "description": "Tool metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "401": { "$ref": "#/components/responses/AuthenticationRequired" }, "403": { "$ref": "#/components/responses/PermissionDenied" }, "404": { "$ref": "#/components/responses/ResourceNotFound" } }, "description": "Retrieve stable tool metadata by ID." } }, "/v1/tools/{tool_id}/versions": { "post": { "tags": [ "tools" ], "summary": "Create new tool definition version", "operationId": "createToolVersion", "security": [ { "BearerAuth": [ "tools:write" ] } ], "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tool Id" } }, { "$ref": "#/components/parameters/IdempotencyKeyHeader" }, { "$ref": "#/components/parameters/RequestIdHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateToolVersionRequest" } } } }, "responses": { "201": { "description": "Tool definition version created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolDefinitionResponse" } } } }, "422": { "description": "Invalid tool definition. Confirmation 'always' returns invalid_request with details at /body/confirmation. Only 'never' and 'policy' are supported in this release; gate the call in your application.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "400": { "$ref": "#/components/responses/InvalidRequest" }, "401": { "$ref": "#/components/responses/AuthenticationRequired" }, "403": { "$ref": "#/components/responses/PermissionDenied" }, "404": { "$ref": "#/components/responses/ResourceNotFound" }, "409": { "$ref": "#/components/responses/IdempotencyConflict" } }, "description": "Append an immutable new definition version for an existing tool." }, "get": { "tags": [ "tools" ], "summary": "List tool definition versions", "operationId": "listToolVersions", "security": [ { "BearerAuth": [ "tools:read" ] } ], "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tool Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of tool definition versions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolDefinitionListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "401": { "$ref": "#/components/responses/AuthenticationRequired" }, "403": { "$ref": "#/components/responses/PermissionDenied" }, "404": { "$ref": "#/components/responses/ResourceNotFound" } }, "description": "List all immutable definition versions for a tool." } }, "/v1/tools/{tool_id}/versions/{version}": { "get": { "tags": [ "tools" ], "summary": "Get specific tool definition version", "operationId": "getToolVersion", "security": [ { "BearerAuth": [ "tools:read" ] } ], "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tool Id" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "integer", "title": "Version" } } ], "responses": { "200": { "description": "Tool definition detail.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolDefinitionResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "401": { "$ref": "#/components/responses/AuthenticationRequired" }, "403": { "$ref": "#/components/responses/PermissionDenied" }, "404": { "$ref": "#/components/responses/ResourceNotFound" } }, "description": "Retrieve a specific immutable version of a tool definition." } }, "/v1/tools/{tool_id}/versions/{version}/deprecate": { "post": { "tags": [ "tools" ], "summary": "Deprecate a tool definition version", "operationId": "deprecateToolVersion", "security": [ { "BearerAuth": [ "tools:write" ] } ], "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tool Id" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "integer", "title": "Version" } } ], "responses": { "200": { "description": "Tool definition marked as deprecated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolDefinitionResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "401": { "$ref": "#/components/responses/AuthenticationRequired" }, "403": { "$ref": "#/components/responses/PermissionDenied" }, "404": { "$ref": "#/components/responses/ResourceNotFound" } }, "description": "Deprecate a definition version to prevent new deployment bindings." } }, "/v1/usage": { "get": { "tags": [ "usage" ], "summary": "Get Usage", "description": "Usage for the caller's tenant. Defaults to 30 days; maximum 92 days.", "operationId": "get_usage_v1_usage_get", "security": [ { "BearerAuth": [ "usage:read" ] } ], "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Inclusive UTC date.", "title": "From" }, "description": "Inclusive UTC date." }, { "name": "to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Inclusive UTC date.", "title": "To" }, "description": "Inclusive UTC date." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/app__modules__usage__usage_schema__UsageResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/admin/tenants/{tenant_id}/usage": { "get": { "tags": [ "usage", "admin" ], "summary": "Get Admin Usage", "operationId": "get_admin_usage_v1_admin_tenants__tenant_id__usage_get", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Tenant Id" } }, { "name": "from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "From" } }, { "name": "to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "To" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/app__modules__usage__usage_schema__UsageResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Requires an admin key." } }, "/v1/workspaces": { "get": { "tags": [ "workspaces" ], "summary": "List Workspaces", "operationId": "list_workspaces_v1_workspaces_get", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "include", "in": "query", "required": false, "schema": { "anyOf": [ { "const": "deleted", "type": "string" }, { "type": "null" } ], "description": "Pass `deleted` to also list the workspaces you deleted and can still restore, each with `deleted_at` and `purge_after`.", "title": "Include" }, "description": "Pass `deleted` to also list the workspaces you deleted and can still restore, each with `deleted_at` and `purge_after`." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceListResponse" } } } }, "401": { "description": "A valid account session is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountErrorEnvelope" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "workspaces" ], "summary": "Create Workspace", "operationId": "create_workspace_v1_workspaces_post", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceCreateRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceCreateResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "401": { "description": "A valid account session is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountErrorEnvelope" } } } }, "409": { "description": "Workspace limit reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountErrorEnvelope" } } } }, "429": { "description": "RATE_LIMITED. Retry after error.retry_after seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountRateLimitErrorEnvelope" } } } } } } }, "/v1/workspaces/{workspace_id}": { "patch": { "tags": [ "workspaces" ], "summary": "Rename Workspace", "description": "Owner or admin only. The name is trimmed and must differ, ignoring case, from every other live workspace of the same account. The slug does not change.", "operationId": "rename_workspace_v1_workspaces__workspace_id__patch", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workspace Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceRenameRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceChangeResponse" } } } }, "401": { "description": "A valid account session is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountErrorEnvelope" } } } }, "403": { "description": "WORKSPACE_FORBIDDEN. Only an owner or admin can rename.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountErrorEnvelope" } } } }, "404": { "description": "WORKSPACE_NOT_FOUND. Not your workspace, or it is deleted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountErrorEnvelope" } } } }, "409": { "description": "WORKSPACE_NAME_TAKEN. Another live workspace of yours has that name.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountErrorEnvelope" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "workspaces" ], "summary": "Delete Workspace", "description": "Owner only. A soft delete: sets `deleted_at` and `purge_after` (now + 30 days). From then on the workspace's API keys get 401 WORKSPACE_DELETED, a session in it gets 409 WORKSPACE_DELETED on everything except `/v1/workspaces` and `/v1/auth`, its agents and runs stop, and it leaves the picker. Restore it with `POST /v1/workspaces/{id}/restore` until `purge_after`; the daily purge job then deletes it and all its data for good.", "operationId": "delete_workspace_v1_workspaces__workspace_id__delete", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workspace Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceChangeResponse" } } } }, "401": { "description": "A valid account session is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountErrorEnvelope" } } } }, "403": { "description": "WORKSPACE_FORBIDDEN. Only the owner can delete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountErrorEnvelope" } } } }, "404": { "description": "WORKSPACE_NOT_FOUND. Not your workspace, or already deleted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountErrorEnvelope" } } } }, "409": { "description": "LAST_WORKSPACE. You cannot delete your last live workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountErrorEnvelope" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/workspaces/{workspace_id}/restore": { "post": { "tags": [ "workspaces" ], "summary": "Restore Workspace", "description": "Owner only, while now < `purge_after`. Brings keys, agents and runs back as they were. Refused when another live workspace of yours has taken the name, or when you already own the maximum number of workspaces.", "operationId": "restore_workspace_v1_workspaces__workspace_id__restore_post", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workspace Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceChangeResponse" } } } }, "401": { "description": "A valid account session is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountErrorEnvelope" } } } }, "403": { "description": "WORKSPACE_FORBIDDEN. Only the owner can restore.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountErrorEnvelope" } } } }, "404": { "description": "WORKSPACE_NOT_FOUND. Not your workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountErrorEnvelope" } } } }, "409": { "description": "WORKSPACE_NOT_DELETED, WORKSPACE_NAME_TAKEN or WORKSPACE_LIMIT_REACHED.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountErrorEnvelope" } } } }, "410": { "description": "WORKSPACE_PURGED. The 30 days have passed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountErrorEnvelope" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/workspaces/{workspace_id}/switch": { "post": { "tags": [ "workspaces" ], "summary": "Switch Workspace", "operationId": "switch_workspace_v1_workspaces__workspace_id__switch_post", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workspace Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceSwitchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "401": { "description": "A valid account session is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountErrorEnvelope" } } } }, "404": { "description": "WORKSPACE_NOT_FOUND.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountErrorEnvelope" } } } } } } }, "/health": { "get": { "summary": "Healthcheck", "operationId": "healthcheck_health_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Response Healthcheck Health Get" } } } } } } }, "/": { "get": { "summary": "Root Healthcheck", "operationId": "root_healthcheck__get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Response Root Healthcheck Get" } } } } } } }, "/v1/admin/bami/settings": { "get": { "tags": [ "Bami admin", "admin" ], "summary": "Settings", "operationId": "settings_v1_admin_bami_settings_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalSettingsResponse" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED or CSRF_FAILED", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } } }, "description": "Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] }, "patch": { "tags": [ "Bami admin", "admin" ], "summary": "Update Settings", "operationId": "update_settings_v1_admin_bami_settings_patch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalUpdate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalSettingsResponse" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED or CSRF_FAILED", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } } }, "description": "Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session.", "parameters": [ { "name": "Origin", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/bami/tenants/{id}/settings": { "get": { "tags": [ "Bami admin", "admin" ], "summary": "Tenant Settings", "operationId": "tenant_settings_v1_admin_bami_tenants__id__settings_get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsResponse" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED or CSRF_FAILED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] }, "patch": { "tags": [ "Bami admin", "admin" ], "summary": "Update Tenant", "operationId": "update_tenant_v1_admin_bami_tenants__id__settings_patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "Origin", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsResponse" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED or CSRF_FAILED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/bami/kill": { "post": { "tags": [ "Bami admin", "admin" ], "summary": "Kill", "operationId": "kill_v1_admin_bami_kill_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KillRequest" } } }, "required": true }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KillReceipt" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED or CSRF_FAILED", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } } }, "description": "Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session.", "parameters": [ { "name": "Origin", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/bami/releases": { "get": { "tags": [ "Bami admin", "admin" ], "summary": "Releases", "operationId": "releases_v1_admin_bami_releases_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleasePage" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED or CSRF_FAILED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] }, "post": { "tags": [ "Bami admin", "admin" ], "summary": "Release", "operationId": "release_v1_admin_bami_releases_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseCreated" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED or CSRF_FAILED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session.", "parameters": [ { "name": "Origin", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/bami/rollouts": { "post": { "tags": [ "Bami admin", "admin" ], "summary": "Rollout", "operationId": "rollout_v1_admin_bami_rollouts_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RolloutCreate" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Rollout" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED or CSRF_FAILED", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } } }, "description": "Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session.", "parameters": [ { "name": "Origin", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/bami/rollouts/{id}/rollback": { "post": { "tags": [ "Bami admin", "admin" ], "summary": "Rollback", "operationId": "rollback_v1_admin_bami_rollouts__id__rollback_post", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Id" } }, { "name": "Origin", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mutation" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Rollout" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED or CSRF_FAILED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/bami/metrics": { "get": { "tags": [ "Bami admin", "admin" ], "summary": "Metrics", "operationId": "metrics_v1_admin_bami_metrics_get", "parameters": [ { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time", "title": "From" } }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time", "title": "To" } }, { "name": "release_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Release Id" } }, { "name": "window", "in": "query", "required": false, "schema": { "enum": [ "hour", "day" ], "type": "string", "default": "hour", "title": "Window" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricResponse" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED or CSRF_FAILED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/bami/audit": { "get": { "tags": [ "Bami admin", "admin" ], "summary": "Audit Records", "operationId": "audit_records_v1_admin_bami_audit_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "actor_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Actor Id" } }, { "name": "action", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action" } }, { "name": "resource_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resource Id" } }, { "name": "from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "From" } }, { "name": "to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "To" } }, { "name": "outcome", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "applied", "rejected" ], "type": "string" }, { "type": "null" } ], "title": "Outcome" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/app__modules__bami_admin__bami_admin_schema__AuditPage" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED or CSRF_FAILED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/bami/support-access": { "post": { "tags": [ "Bami admin", "admin" ], "summary": "Support Access", "operationId": "support_access_v1_admin_bami_support_access_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GrantCreate" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportGrant" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED or CSRF_FAILED", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } } }, "description": "Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session.", "parameters": [ { "name": "Origin", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/bami/support-access/{id}": { "delete": { "tags": [ "Bami admin", "admin" ], "summary": "Revoke Support", "operationId": "revoke_support_v1_admin_bami_support_access__id__delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Id" } }, { "name": "Origin", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mutation" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportGrant" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED or CSRF_FAILED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/bami/conversations/{id}": { "get": { "tags": [ "Bami admin", "admin" ], "summary": "Conversation", "operationId": "conversation_v1_admin_bami_conversations__id__get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Id" } }, { "name": "grant_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 64, "title": "Grant Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "messages_cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Messages Cursor" } }, { "name": "events_cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Events Cursor" } }, { "name": "graphs_cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Graphs Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationDetail" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED or CSRF_FAILED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/bami/model": { "get": { "tags": [ "Bami model", "admin" ], "summary": "Overview", "operationId": "overview_v1_admin_bami_model_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelOverview" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/bami/model/qualifications": { "post": { "tags": [ "Bami model", "admin" ], "summary": "Start Qualification", "operationId": "start_qualification_v1_admin_bami_model_qualifications_post", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[!-~]{1,64}$", "description": "Client chosen key; the same key and body replay the recorded outcome.", "title": "Idempotency-Key" }, "description": "Client chosen key; the same key and body replay the recorded outcome." }, { "name": "Origin", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QualificationStart" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QualificationJob" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/bami/model/qualifications/{id}": { "get": { "tags": [ "Bami model", "admin" ], "summary": "Qualification", "operationId": "qualification_v1_admin_bami_model_qualifications__id__get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 64, "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QualificationJob" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/bami/model/qualifications/{id}/enable": { "post": { "tags": [ "Bami model", "admin" ], "summary": "Enable", "operationId": "enable_v1_admin_bami_model_qualifications__id__enable_post", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 64, "title": "Id" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[!-~]{1,64}$", "description": "Client chosen key; the same key and body replay the recorded outcome.", "title": "Idempotency-Key" }, "description": "Client chosen key; the same key and body replay the recorded outcome." }, { "name": "Origin", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnableRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnableResult" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/bami/auth/login": { "post": { "tags": [ "Bami admin auth", "admin" ], "summary": "Login", "operationId": "login_v1_admin_bami_auth_login_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Login" } } }, "required": true }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Challenge" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED or CSRF_FAILED", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } } }, "description": "Password or MFA challenge exchange; requires the dashboard Origin. Password or MFA challenge exchange; requires the dashboard Origin. Password or MFA challenge exchange; requires the dashboard Origin. Password or MFA challenge exchange; requires the dashboard Origin.", "security": [] } }, "/v1/admin/bami/auth/mfa": { "post": { "tags": [ "Bami admin auth", "admin" ], "summary": "Mfa", "operationId": "mfa_v1_admin_bami_auth_mfa_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MFA" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsoleAdminSession" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED or CSRF_FAILED", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } } }, "description": "Password or MFA challenge exchange; requires the dashboard Origin. Password or MFA challenge exchange; requires the dashboard Origin. Password or MFA challenge exchange; requires the dashboard Origin. Password or MFA challenge exchange; requires the dashboard Origin.", "security": [] } }, "/v1/admin/bami/auth/session": { "get": { "tags": [ "Bami admin auth", "admin" ], "summary": "Session", "operationId": "session_v1_admin_bami_auth_session_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsoleAdminSession" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED or CSRF_FAILED", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } } }, "description": "Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] }, "delete": { "tags": [ "Bami admin auth", "admin" ], "summary": "Logout", "operationId": "logout_v1_admin_bami_auth_session_delete", "responses": { "204": { "description": "Successful Response" }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED or CSRF_FAILED", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } } }, "description": "Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session. Requires a named enrolled MFA admin session.", "parameters": [ { "name": "Origin", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/console/containment-reviews": { "get": { "tags": [ "Operator console", "admin" ], "summary": "Containment Reviews", "operationId": "containment_reviews_v1_admin_console_containment_reviews_get", "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "enum": [ "open", "overdue", "disposed", "all" ], "type": "string", "default": "open", "title": "Status" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewPage" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/console/containment-reviews/{review_id}": { "post": { "tags": [ "Operator console", "admin" ], "summary": "Dispose Review", "operationId": "dispose_review_v1_admin_console_containment_reviews__review_id__post", "parameters": [ { "name": "review_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 64, "title": "Review Id" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[!-~]{1,64}$", "description": "Client chosen key; the same key and body replay the recorded outcome.", "title": "Idempotency-Key" }, "description": "Client chosen key; the same key and body replay the recorded outcome." }, { "name": "Origin", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DispositionRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DispositionResponse" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/console/staff/{user_id}/emergency-revoke": { "post": { "tags": [ "Operator console", "admin" ], "summary": "Emergency Revoke", "operationId": "emergency_revoke_v1_admin_console_staff__user_id__emergency_revoke_post", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "User Id" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[!-~]{1,64}$", "description": "Client chosen key; the same key and body replay the recorded outcome.", "title": "Idempotency-Key" }, "description": "Client chosen key; the same key and body replay the recorded outcome." }, { "name": "Origin", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmergencyRevokeRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmergencyRevokeResponse" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/console/operations/{idempotency_key}": { "get": { "tags": [ "Operator console", "admin" ], "summary": "Operation", "operationId": "operation_v1_admin_console_operations__idempotency_key__get", "parameters": [ { "name": "idempotency_key", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 64, "title": "Idempotency Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationOut" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/console/tenants": { "get": { "tags": [ "Operator console", "admin" ], "summary": "Tenants", "operationId": "tenants_v1_admin_console_tenants_get", "parameters": [ { "name": "classification", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "enum": [ "customer", "internal", "test", "demo", "unclassified" ], "type": "string" } }, { "type": "null" } ], "title": "Classification" } }, { "name": "stage", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "signed_up", "verified", "agent_created", "run_attempted", "run_succeeded" ], "type": "string" }, { "type": "null" } ], "title": "Stage" } }, { "name": "needs_attention", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "enum": [ "failures_no_success_24h", "unverified_48h", "no_agent_24h", "no_run_72h", "containment_review_overdue" ], "type": "string" } }, { "type": "null" } ], "title": "Needs Attention" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "title": "Q" } }, { "name": "created_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created From" } }, { "name": "created_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created To" } }, { "name": "include_internal", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Include Internal" } }, { "name": "order", "in": "query", "required": false, "schema": { "enum": [ "activity", "created" ], "type": "string", "default": "activity", "title": "Order" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantPage" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/console/tenants/{tenant_id}": { "get": { "tags": [ "Operator console", "admin" ], "summary": "Tenant Detail", "operationId": "tenant_detail_v1_admin_console_tenants__tenant_id__get", "parameters": [ { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Tenant Id" } }, { "name": "period", "in": "query", "required": false, "schema": { "enum": [ "24h", "7d" ], "type": "string", "default": "24h", "title": "Period" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantDetail" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/console/tenants/{tenant_id}/classification": { "patch": { "tags": [ "Operator console", "admin" ], "summary": "Classify Tenant", "operationId": "classify_tenant_v1_admin_console_tenants__tenant_id__classification_patch", "parameters": [ { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Tenant Id" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[!-~]{1,64}$", "description": "Client chosen key; the same key and body replay the recorded outcome.", "title": "Idempotency-Key" }, "description": "Client chosen key; the same key and body replay the recorded outcome." }, { "name": "Origin", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassificationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassificationResponse" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/console/usage": { "get": { "tags": [ "Operator console", "admin" ], "summary": "Usage", "operationId": "usage_v1_admin_console_usage_get", "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "From" } }, { "name": "to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "To" } }, { "name": "tenant_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Tenant Id" } }, { "name": "model", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "title": "Model" } }, { "name": "payer", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "platform", "tenant_verification", "tenant_builder" ], "type": "string" }, { "type": "null" } ], "title": "Payer" } }, { "name": "provenance", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "provider_reported", "recorded_unverified", "estimated", "mixed", "unavailable" ], "type": "string" }, { "type": "null" } ], "title": "Provenance" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/app__modules__operator_console__console_schema__UsageResponse" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/console/usage/export": { "get": { "tags": [ "Operator console", "admin" ], "summary": "Usage Export", "description": "Requires a named enrolled MFA admin session. CSV of exactly the aggregate GET O/usage returns for the same filters.", "operationId": "usage_export_v1_admin_console_usage_export_get", "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "From" } }, { "name": "to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "To" } }, { "name": "tenant_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Tenant Id" } }, { "name": "model", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "title": "Model" } }, { "name": "payer", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "platform", "tenant_verification", "tenant_builder" ], "type": "string" }, { "type": "null" } ], "title": "Payer" } }, { "name": "provenance", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "provider_reported", "recorded_unverified", "estimated", "mixed", "unavailable" ], "type": "string" }, { "type": "null" } ], "title": "Provenance" } } ], "responses": { "200": { "description": "The visible usage aggregate", "content": { "text/csv": {} } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/console/audit": { "get": { "tags": [ "Operator console", "admin" ], "summary": "Audit", "operationId": "audit_v1_admin_console_audit_get", "parameters": [ { "name": "tenant_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Tenant Id" } }, { "name": "actor_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Actor Id" } }, { "name": "action", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "Action" } }, { "name": "resource_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "Resource Type" } }, { "name": "resource_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "Resource Id" } }, { "name": "request_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "title": "Request Id" } }, { "name": "grant_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "Grant Id" } }, { "name": "outcome", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "applied", "rejected", "allowed", "denied" ], "type": "string" }, { "type": "null" } ], "title": "Outcome" } }, { "name": "kind", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "control_change", "metadata_read", "content_read", "authentication" ], "type": "string" }, { "type": "null" } ], "title": "Kind" } }, { "name": "from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "From" } }, { "name": "to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "To" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/app__modules__operator_console__console_schema__AuditPage" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/console/tenants/{tenant_id}/suspend": { "post": { "tags": [ "Operator console", "admin" ], "summary": "Suspend Tenant", "operationId": "suspend_tenant_v1_admin_console_tenants__tenant_id__suspend_post", "parameters": [ { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Tenant Id" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[!-~]{1,64}$", "description": "Client chosen key; the same key and body replay the recorded outcome.", "title": "Idempotency-Key" }, "description": "Client chosen key; the same key and body replay the recorded outcome." }, { "name": "Origin", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuspendRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlResponse" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/console/tenants/{tenant_id}/resume": { "post": { "tags": [ "Operator console", "admin" ], "summary": "Resume Tenant", "operationId": "resume_tenant_v1_admin_console_tenants__tenant_id__resume_post", "parameters": [ { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Tenant Id" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[!-~]{1,64}$", "description": "Client chosen key; the same key and body replay the recorded outcome.", "title": "Idempotency-Key" }, "description": "Client chosen key; the same key and body replay the recorded outcome." }, { "name": "Origin", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/app__modules__operator_console__console_schema__ResumeRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlResponse" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/console/tenants/{tenant_id}/limits": { "patch": { "tags": [ "Operator console", "admin" ], "summary": "Update Limits", "operationId": "update_limits_v1_admin_console_tenants__tenant_id__limits_patch", "parameters": [ { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Tenant Id" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[!-~]{1,64}$", "description": "Client chosen key; the same key and body replay the recorded outcome.", "title": "Idempotency-Key" }, "description": "Client chosen key; the same key and body replay the recorded outcome." }, { "name": "Origin", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LimitsRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlResponse" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/console/tenants/{tenant_id}/keys": { "get": { "tags": [ "Operator console", "admin" ], "summary": "Tenant Keys", "operationId": "tenant_keys_v1_admin_console_tenants__tenant_id__keys_get", "parameters": [ { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Tenant Id" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "active", "expired", "revoked" ], "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyPage" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/console/tenants/{tenant_id}/keys/{key_id}/revoke": { "post": { "tags": [ "Operator console", "admin" ], "summary": "Revoke Key", "operationId": "revoke_key_v1_admin_console_tenants__tenant_id__keys__key_id__revoke_post", "parameters": [ { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Tenant Id" } }, { "name": "key_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Key Id" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[!-~]{1,64}$", "description": "Client chosen key; the same key and body replay the recorded outcome.", "title": "Idempotency-Key" }, "description": "Client chosen key; the same key and body replay the recorded outcome." }, { "name": "Origin", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mutation" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyRevokeResponse" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/console/users": { "get": { "tags": [ "Operator console", "admin" ], "summary": "Users", "operationId": "users_v1_admin_console_users_get", "parameters": [ { "name": "tenant_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Tenant Id" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "title": "Q" } }, { "name": "role", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "Role" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "active", "inactive" ], "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "verified", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Verified" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPage" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/console/users/{user_id}": { "get": { "tags": [ "Operator console", "admin" ], "summary": "User Detail", "operationId": "user_detail_v1_admin_console_users__user_id__get", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "User Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDetail" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/console/roles": { "get": { "tags": [ "Operator console", "admin" ], "summary": "Roles", "operationId": "roles_v1_admin_console_roles_get", "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "enum": [ "active", "revoked", "all" ], "type": "string", "default": "active", "title": "Status" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StaffPage" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/console/roles/{user_id}": { "put": { "tags": [ "Operator console", "admin" ], "summary": "Set Role", "operationId": "set_role_v1_admin_console_roles__user_id__put", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "User Id" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[!-~]{1,64}$", "description": "Client chosen key; the same key and body replay the recorded outcome.", "title": "Idempotency-Key" }, "description": "Client chosen key; the same key and body replay the recorded outcome." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StaffResponse" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] }, "delete": { "tags": [ "Operator console", "admin" ], "summary": "Revoke Role", "operationId": "revoke_role_v1_admin_console_roles__user_id__delete", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "User Id" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[!-~]{1,64}$", "description": "Client chosen key; the same key and body replay the recorded outcome.", "title": "Idempotency-Key" }, "description": "Client chosen key; the same key and body replay the recorded outcome." }, { "name": "Origin", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleRevokeRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StaffResponse" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/console/approvals": { "post": { "tags": [ "Operator console", "admin" ], "summary": "Create Approval", "operationId": "create_approval_v1_admin_console_approvals_post", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[!-~]{1,64}$", "description": "Client chosen key; the same key and body replay the recorded outcome.", "title": "Idempotency-Key" }, "description": "Client chosen key; the same key and body replay the recorded outcome." }, { "name": "Origin", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovalRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovalResponse" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/console/attention": { "get": { "tags": [ "Operator console", "admin" ], "summary": "Attention", "operationId": "attention_v1_admin_console_attention_get", "parameters": [ { "name": "state", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "open", "acknowledged", "resolved" ], "type": "string" }, { "const": "all", "type": "string" } ], "default": "open", "title": "State" } }, { "name": "severity", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "critical", "warning", "info" ], "type": "string" }, { "type": "null" } ], "title": "Severity" } }, { "name": "signal", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "WORKER_HEARTBEAT_STALE", "PROVIDER_ERROR_RATE", "NOTIFICATION_DELIVERY_FAILED", "BUDGET_WARNING", "BUDGET_EXHAUSTED", "WORKSPACE_FAILURE_STREAK", "CONTAINMENT_REVIEW_OVERDUE", "SUPPORT_NOTICE_BLOCKED" ], "type": "string" }, { "type": "null" } ], "title": "Signal" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttentionPage" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/console/attention/{item_id}/acknowledge": { "post": { "tags": [ "Operator console", "admin" ], "summary": "Acknowledge Attention", "operationId": "acknowledge_attention_v1_admin_console_attention__item_id__acknowledge_post", "parameters": [ { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 64, "title": "Item Id" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[!-~]{1,64}$", "description": "Client chosen key; the same key and body replay the recorded outcome.", "title": "Idempotency-Key" }, "description": "Client chosen key; the same key and body replay the recorded outcome." }, { "name": "Origin", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mutation" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttentionMutationResponse" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/console/attention/{item_id}/resolve": { "post": { "tags": [ "Operator console", "admin" ], "summary": "Resolve Attention", "operationId": "resolve_attention_v1_admin_console_attention__item_id__resolve_post", "parameters": [ { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 64, "title": "Item Id" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[!-~]{1,64}$", "description": "Client chosen key; the same key and body replay the recorded outcome.", "title": "Idempotency-Key" }, "description": "Client chosen key; the same key and body replay the recorded outcome." }, { "name": "Origin", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mutation" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttentionMutationResponse" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/console/health": { "get": { "tags": [ "Operator console", "admin" ], "summary": "Health", "operationId": "health_v1_admin_console_health_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthResponse" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "items": { "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "type": "object", "required": [ "path", "reason" ] }, "type": "array" }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } }, "type": "object", "required": [ "code", "message", "request_id", "details" ] } }, "type": "object", "required": [ "error" ] } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/console/incidents": { "get": { "tags": [ "Operator console", "admin" ], "summary": "Incidents", "operationId": "incidents_v1_admin_console_incidents_get", "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "open", "monitoring", "resolved" ], "type": "string" }, { "enum": [ "active", "all" ], "type": "string" } ], "default": "active", "title": "Status" } }, { "name": "component", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "Component" } }, { "name": "severity", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "critical", "warning", "info" ], "type": "string" }, { "type": "null" } ], "title": "Severity" } }, { "name": "from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "From" } }, { "name": "to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "To" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncidentPage" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/console/agents": { "get": { "tags": [ "Operator console", "admin" ], "summary": "Agents", "operationId": "agents_v1_admin_console_agents_get", "parameters": [ { "name": "tenant_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Tenant Id" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 32 }, { "type": "null" } ], "title": "Status" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentPage" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/console/deployments": { "get": { "tags": [ "Operator console", "admin" ], "summary": "Deployments", "operationId": "deployments_v1_admin_console_deployments_get", "parameters": [ { "name": "tenant_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Tenant Id" } }, { "name": "agent_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Agent Id" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 32 }, { "type": "null" } ], "title": "Status" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeploymentPage" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/console/sessions": { "get": { "tags": [ "Operator console", "admin" ], "summary": "Sessions", "operationId": "sessions_v1_admin_console_sessions_get", "parameters": [ { "name": "tenant_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Tenant Id" } }, { "name": "agent_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Agent Id" } }, { "name": "deployment_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "Deployment Id" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 32 }, { "type": "null" } ], "title": "Status" } }, { "name": "kind", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 32 }, { "type": "null" } ], "title": "Kind" } }, { "name": "from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "From" } }, { "name": "to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "To" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionPage" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/console/runs": { "get": { "tags": [ "Operator console", "admin" ], "summary": "Runs", "operationId": "runs_v1_admin_console_runs_get", "parameters": [ { "name": "tenant_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Tenant Id" } }, { "name": "session_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Session Id" } }, { "name": "agent_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Agent Id" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 32 }, { "type": "null" } ], "title": "Status" } }, { "name": "from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "From" } }, { "name": "to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "To" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunPage" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/console/requests/{request_id}": { "get": { "tags": [ "Operator console", "admin" ], "summary": "Request Correlation", "operationId": "request_correlation_v1_admin_console_requests__request_id__get", "parameters": [ { "name": "request_id", "in": "path", "required": true, "schema": { "type": "string", "maxLength": 128, "title": "Request Id" } }, { "name": "tenant_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "description": "Required: request ids are only unique per workspace", "title": "Tenant Id" }, "description": "Required: request ids are only unique per workspace" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "sessions_cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sessions Cursor" } }, { "name": "runs_cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Runs Cursor" } }, { "name": "events_cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Events Cursor" } }, { "name": "audit_cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Audit Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestCorrelation" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/console/notification-settings": { "get": { "tags": [ "Operator console", "admin" ], "summary": "Notification Settings", "operationId": "notification_settings_v1_admin_console_notification_settings_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationSettingsOut" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] }, "patch": { "tags": [ "Operator console", "admin" ], "summary": "Update Notification Settings", "operationId": "update_notification_settings_v1_admin_console_notification_settings_patch", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[!-~]{1,64}$", "description": "Client chosen key; the same key and body replay the recorded outcome.", "title": "Idempotency-Key" }, "description": "Client chosen key; the same key and body replay the recorded outcome." }, { "name": "Origin", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationSettingsPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationSettingsResponse" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/console/data-requests": { "get": { "tags": [ "Operator console", "admin" ], "summary": "Data Requests", "operationId": "data_requests_v1_admin_console_data_requests_get", "parameters": [ { "name": "tenant_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Tenant Id" } }, { "name": "kind", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "access", "erasure", "portability" ], "type": "string" }, { "type": "null" } ], "title": "Kind" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "received", "in_progress", "awaiting_external", "completed", "rejected" ], "type": "string" }, { "const": "open", "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequestPage" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] }, "post": { "tags": [ "Operator console", "admin" ], "summary": "Create Data Request", "operationId": "create_data_request_v1_admin_console_data_requests_post", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[!-~]{1,64}$", "description": "Client chosen key; the same key and body replay the recorded outcome.", "title": "Idempotency-Key" }, "description": "Client chosen key; the same key and body replay the recorded outcome." }, { "name": "Origin", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequestCreate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequestResponse" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } }, "/v1/admin/console/data-requests/{request_id}": { "patch": { "tags": [ "Operator console", "admin" ], "summary": "Update Data Request", "operationId": "update_data_request_v1_admin_console_data_requests__request_id__patch", "parameters": [ { "name": "request_id", "in": "path", "required": true, "schema": { "type": "string", "maxLength": 64, "title": "Request Id" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[!-~]{1,64}$", "description": "Client chosen key; the same key and body replay the recorded outcome.", "title": "Idempotency-Key" }, "description": "Client chosen key; the same key and body replay the recorded outcome." }, { "name": "Origin", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequestPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequestResponse" } } } }, "401": { "description": "UNAUTHORIZED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "403": { "description": "ADMIN_SESSION_REQUIRED, MFA_REQUIRED, CSRF_FAILED or ROLE_FORBIDDEN", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "404": { "description": "NOT_FOUND", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "409": { "description": "REVISION_CONFLICT", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "422": { "description": "INVALID_REQUEST", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "429": { "description": "BAMI_LIMIT_EXCEEDED", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } }, "503": { "description": "CONTROL_UNAVAILABLE", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "path", "reason" ], "properties": { "path": { "type": "string" }, "reason": { "type": "string" } } } }, "current_revision": { "type": "integer" }, "retry_after_seconds": { "type": "integer" } } } } } } } } }, "description": "Requires a named enrolled MFA admin session.", "security": [ { "BamiAdminSession": [] } ] } } }, "components": { "schemas": { "AcceptedEvent": { "properties": { "id": { "type": "string", "title": "Id" }, "type": { "type": "string", "title": "Type" }, "in_reply_to_event_id": { "type": "string", "title": "In Reply To Event Id" }, "sequence": { "type": "integer", "title": "Sequence" } }, "type": "object", "required": [ "id", "type", "in_reply_to_event_id", "sequence" ], "title": "AcceptedEvent" }, "AccountErrorBody": { "properties": { "code": { "type": "string", "title": "Code" }, "message": { "type": "string", "title": "Message" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request Id" }, "details": { "anyOf": [ { "items": { "$ref": "#/components/schemas/AccountErrorDetail" }, "type": "array" }, { "type": "null" } ], "title": "Details" } }, "type": "object", "required": [ "code", "message" ], "title": "AccountErrorBody" }, "AccountErrorDetail": { "properties": { "path": { "type": "string", "title": "Path" }, "reason": { "type": "string", "title": "Reason" } }, "type": "object", "required": [ "path", "reason" ], "title": "AccountErrorDetail" }, "AccountErrorEnvelope": { "properties": { "error": { "$ref": "#/components/schemas/AccountErrorBody" } }, "type": "object", "required": [ "error" ], "title": "AccountErrorEnvelope" }, "AccountRateLimitErrorBody": { "properties": { "code": { "type": "string", "title": "Code" }, "message": { "type": "string", "title": "Message" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request Id" }, "details": { "anyOf": [ { "items": { "$ref": "#/components/schemas/AccountErrorDetail" }, "type": "array" }, { "type": "null" } ], "title": "Details" }, "retry_after": { "type": "integer", "minimum": 1.0, "title": "Retry After", "description": "Seconds until another attempt is allowed." } }, "type": "object", "required": [ "code", "message", "retry_after" ], "title": "AccountRateLimitErrorBody" }, "AccountRateLimitErrorEnvelope": { "properties": { "error": { "$ref": "#/components/schemas/AccountRateLimitErrorBody" } }, "type": "object", "required": [ "error" ], "title": "AccountRateLimitErrorEnvelope" }, "ActionData": { "properties": { "action": { "type": "string", "enum": [ "verification_target_corrected", "test_created", "activate_proposed", "delete_proposed", "deprecate_proposed", "approval_decided", "activate_executed", "delete_executed", "deprecate_executed", "action_refused", "reply_evidence_offered", "reply_evidence_decided", "reply_evidence_read", "reply_evidence_refused" ], "title": "Action" }, "receipt_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Receipt Id" }, "target_id": { "type": "string", "title": "Target Id" }, "before": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Before" }, "after": { "additionalProperties": true, "type": "object", "title": "After" }, "outcome": { "type": "string", "title": "Outcome" } }, "additionalProperties": false, "type": "object", "required": [ "action", "receipt_id", "target_id", "before", "after", "outcome" ], "title": "ActionData" }, "ActionEvent": { "properties": { "id": { "type": "string", "title": "Id" }, "sequence": { "type": "integer", "minimum": 1.0, "title": "Sequence" }, "conversation_id": { "type": "string", "title": "Conversation Id" }, "run_id": { "type": "string", "format": "uuid", "title": "Run Id" }, "request_id": { "type": "string", "title": "Request Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "late": { "type": "boolean", "title": "Late" }, "usable_as_evidence": { "type": "boolean", "title": "Usable As Evidence" }, "type": { "type": "string", "const": "assistant.action", "title": "Type" }, "data": { "$ref": "#/components/schemas/ActionData" } }, "additionalProperties": false, "type": "object", "required": [ "id", "sequence", "conversation_id", "run_id", "request_id", "created_at", "late", "usable_as_evidence", "type", "data" ], "title": "ActionEvent" }, "Activation": { "properties": { "stage": { "type": "string", "enum": [ "signed_up", "verified", "agent_created", "run_attempted", "run_succeeded" ], "title": "Stage" }, "signed_up_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Signed Up At" }, "verified_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Verified At" }, "first_agent_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "First Agent At" }, "first_agent_unknown": { "type": "boolean", "title": "First Agent Unknown" }, "first_run_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "First Run At" }, "first_run_unknown": { "type": "boolean", "title": "First Run Unknown" }, "first_success_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "First Success At" }, "first_success_unknown": { "type": "boolean", "title": "First Success Unknown" }, "active_last_7d": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Active Last 7D" }, "unavailable_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unavailable Reason" } }, "additionalProperties": false, "type": "object", "required": [ "stage", "signed_up_at", "verified_at", "first_agent_at", "first_agent_unknown", "first_run_at", "first_run_unknown", "first_success_at", "first_success_unknown", "active_last_7d", "unavailable_reason" ], "title": "Activation" }, "AdminApiKeyCreateRequest": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "permissions": { "items": { "type": "string" }, "type": "array", "title": "Permissions" }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Expires At" } }, "type": "object", "title": "AdminApiKeyCreateRequest" }, "AdminApiKeyResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "permissions": { "items": { "type": "string" }, "type": "array", "title": "Permissions" }, "key_preview": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Key Preview" }, "raw_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Raw Key" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Expires At" } }, "type": "object", "required": [ "id" ], "title": "AdminApiKeyResponse" }, "AdminPasswordResetRequest": { "properties": { "password": { "type": "string", "maxLength": 128, "minLength": 10, "title": "Password" } }, "type": "object", "required": [ "password" ], "title": "AdminPasswordResetRequest" }, "AgentListResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/AgentResponse" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "AgentListResponse" }, "AgentPage": { "properties": { "data": { "items": { "$ref": "#/components/schemas/AgentSummary" }, "type": "array", "title": "Data" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "observed_at": { "type": "string", "format": "date-time", "title": "Observed At" }, "coverage": { "$ref": "#/components/schemas/app__modules__operator_console__console_schema__Coverage" } }, "additionalProperties": false, "type": "object", "required": [ "data", "next_cursor", "observed_at", "coverage" ], "title": "AgentPage" }, "AgentResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "slug": { "type": "string", "title": "Slug" }, "model": { "type": "string", "title": "Model" }, "system_prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "System Prompt" }, "tools": { "items": { "type": "string" }, "type": "array", "title": "Tools", "description": "Which of Pantheon's built-in tools this agent may use. The list is an allowlist over exactly these names and it is enforced at run time: web_search, web_fetch, publish_artifact, list_session_artifacts. One of these that is not listed is not attached, and a call to it is refused before it runs and recorded on the run as tool.refused. This list does not govern the sandbox. While requires_sandbox is true the agent also has a shell (execute) and the file tools, and the sandbox can reach the network, so an agent that declares no web tools can still fetch a URL from the shell. Set requires_sandbox to false to remove all of that. Writing this field opts an agent created before enforcement into it; agents created after it are governed from their first revision." }, "tool_requirements": { "items": { "$ref": "#/components/schemas/ToolRequirement" }, "type": "array", "title": "Tool Requirements" }, "skills": { "items": { "type": "string" }, "type": "array", "title": "Skills" }, "environment_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Environment Id" }, "requires_sandbox": { "type": "boolean", "title": "Requires Sandbox", "description": "Whether sessions for this agent require a provisioned sandbox. When false, sandbox tools and file operations are unavailable.", "default": true }, "tool_policy": { "$ref": "#/components/schemas/ToolPolicy", "description": "Read-only. How this agent's tools list is applied. 'declared' means the list is enforced. 'unrestricted' means the agent predates enforcement and still receives every built-in tool; set tools to govern it." }, "metadata": { "additionalProperties": true, "type": "object", "title": "Metadata" }, "status": { "type": "string", "title": "Status", "default": "active" }, "version": { "type": "integer", "title": "Version", "default": 1 }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "required": [ "id", "name", "slug", "model" ], "title": "AgentResponse" }, "AgentSummary": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "tenant_id": { "type": "string", "format": "uuid", "title": "Tenant Id" }, "workspace_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Name", "description": "The workspace's display name, resolved server side. Null for a deleted or otherwise unresolvable tenant; the caller falls back to the id." }, "version": { "type": "integer", "title": "Version" }, "model": { "type": "string", "title": "Model" }, "environment_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Environment Id" }, "status": { "type": "string", "title": "Status" }, "requires_sandbox": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Requires Sandbox", "description": "Whether the agent requires a sandbox; null means it follows its deployment." }, "deployment_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Deployment Count" }, "session_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Session Count" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "deleted_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Deleted At" } }, "additionalProperties": false, "type": "object", "required": [ "id", "tenant_id", "workspace_name", "version", "model", "environment_id", "status", "requires_sandbox", "deployment_count", "session_count", "created_at", "updated_at", "deleted_at" ], "title": "AgentSummary" }, "ApiComponent": { "properties": { "status": { "type": "string", "const": "ok", "title": "Status" } }, "type": "object", "required": [ "status" ], "title": "ApiComponent" }, "ApprovalDecision": { "properties": { "decision": { "type": "string", "enum": [ "allow", "deny" ], "title": "Decision" }, "payload_hash": { "type": "string", "maxLength": 64, "minLength": 64, "title": "Payload Hash" }, "reason": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ], "title": "Reason" } }, "additionalProperties": false, "type": "object", "required": [ "decision", "payload_hash" ], "title": "ApprovalDecision" }, "ApprovalOut": { "properties": { "id": { "type": "string", "title": "Id" }, "action": { "type": "string", "enum": [ "tenant.resume", "tenant.limits.update", "staff.role.update", "staff.role.revoke" ], "title": "Action" }, "resource_type": { "type": "string", "enum": [ "tenant", "admin_enrollment" ], "title": "Resource Type" }, "resource_id": { "type": "string", "title": "Resource Id" }, "workspace_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Workspace Id" }, "values_hash": { "type": "string", "title": "Values Hash" }, "approver_id": { "type": "string", "format": "uuid", "title": "Approver Id" }, "approver_label": { "type": "string", "title": "Approver Label" }, "revision": { "type": "integer", "minimum": 0.0, "title": "Revision" }, "expires_at": { "type": "string", "format": "date-time", "title": "Expires At" }, "used_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Used At" }, "used_by_audit_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Used By Audit Id" }, "audit_id": { "type": "string", "title": "Audit Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "additionalProperties": false, "type": "object", "required": [ "id", "action", "resource_type", "resource_id", "workspace_id", "values_hash", "approver_id", "approver_label", "revision", "expires_at", "used_at", "used_by_audit_id", "audit_id", "created_at" ], "title": "ApprovalOut" }, "ApprovalPage": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ApprovalRecord" }, "type": "array", "title": "Data" }, "next_page": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next Page" }, "total": { "type": "integer", "title": "Total" } }, "additionalProperties": false, "type": "object", "required": [ "data", "next_page", "total" ], "title": "ApprovalPage" }, "ApprovalRecord": { "properties": { "id": { "type": "string", "title": "Id", "description": "Public blocking event ID" }, "workspace_id": { "type": "string", "format": "uuid", "title": "Workspace Id" }, "conversation_id": { "type": "string", "title": "Conversation Id" }, "requester_id": { "type": "string", "format": "uuid", "title": "Requester Id" }, "run_id": { "type": "string", "format": "uuid", "title": "Run Id" }, "request_id": { "type": "string", "title": "Request Id" }, "scope_generation": { "type": "integer", "title": "Scope Generation" }, "action": { "type": "string", "enum": [ "activate", "delete", "deprecate" ], "title": "Action" }, "agent_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Agent Id" }, "targets": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Targets" }, "frozen_payload": { "additionalProperties": true, "type": "object", "title": "Frozen Payload" }, "payload_hash": { "type": "string", "title": "Payload Hash" }, "state_hash": { "type": "string", "title": "State Hash" }, "checkpoint_id": { "type": "string", "title": "Checkpoint Id" }, "pending_input_id": { "type": "string", "title": "Pending Input Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "expires_at": { "type": "string", "format": "date-time", "title": "Expires At" }, "policy": { "additionalProperties": true, "type": "object", "title": "Policy" }, "decision": { "anyOf": [ { "type": "string", "enum": [ "allow", "deny" ] }, { "type": "null" } ], "title": "Decision" }, "decider_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Decider Id" }, "decided_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Decided At" }, "decision_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Decision Reason" }, "executor_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Executor Id" }, "outcome": { "type": "string", "enum": [ "pending", "rejected", "expired", "stale", "executed", "failed" ], "title": "Outcome" }, "execution_receipt_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Execution Receipt Id" }, "executed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Executed At" }, "refusal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Refusal Code" }, "refusal_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Refusal Reason" }, "refused_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Refused At" }, "executable": { "type": "boolean", "title": "Executable", "default": false }, "executable_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Executable Reason" } }, "additionalProperties": false, "type": "object", "required": [ "id", "workspace_id", "conversation_id", "requester_id", "run_id", "request_id", "scope_generation", "action", "agent_id", "targets", "frozen_payload", "payload_hash", "state_hash", "checkpoint_id", "pending_input_id", "created_at", "expires_at", "policy", "decision", "decider_id", "decided_at", "decision_reason", "executor_id", "outcome", "execution_receipt_id", "executed_at", "refusal_code", "refusal_reason", "refused_at" ], "title": "ApprovalRecord", "description": "Contract v5 frozen preview approval. The id is the blocking event ID." }, "ApprovalRequest": { "properties": { "reason": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Reason" }, "expected_revision": { "type": "integer", "minimum": 0.0, "title": "Expected Revision" }, "action": { "type": "string", "enum": [ "tenant.resume", "tenant.limits.update", "staff.role.update", "staff.role.revoke" ], "title": "Action" }, "resource_type": { "type": "string", "enum": [ "tenant", "admin_enrollment" ], "title": "Resource Type" }, "resource_id": { "type": "string", "maxLength": 64, "minLength": 1, "title": "Resource Id" }, "values_hash": { "type": "string", "pattern": "^[0-9a-f]{64}$", "title": "Values Hash" } }, "additionalProperties": false, "type": "object", "required": [ "reason", "expected_revision", "action", "resource_type", "resource_id", "values_hash" ], "title": "ApprovalRequest" }, "ApprovalResponse": { "properties": { "approval": { "$ref": "#/components/schemas/ApprovalOut" }, "audit_id": { "type": "string", "title": "Audit Id" }, "revision": { "type": "integer", "minimum": 0.0, "title": "Revision" } }, "additionalProperties": false, "type": "object", "required": [ "approval", "audit_id", "revision" ], "title": "ApprovalResponse" }, "ArtifactDeleteResponse": { "properties": { "status": { "type": "string", "title": "Status", "default": "deleted" } }, "type": "object", "title": "ArtifactDeleteResponse" }, "ArtifactListResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ArtifactResponse" }, "type": "array", "title": "Data" } }, "type": "object", "title": "ArtifactListResponse" }, "ArtifactResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" }, "session_id": { "type": "string", "title": "Session Id" }, "run_id": { "type": "string", "title": "Run Id" }, "name": { "type": "string", "title": "Name" }, "filename": { "type": "string", "title": "Filename" }, "artifact_type": { "type": "string", "title": "Artifact Type" }, "description": { "type": "string", "nullable": true }, "s3_prefix": { "type": "string", "title": "S3 Prefix" }, "is_directory": { "type": "boolean", "title": "Is Directory", "default": false }, "entry_point": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entry Point" }, "file_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "File Count" }, "size": { "type": "integer", "title": "Size", "default": 0 }, "content_type": { "type": "string", "title": "Content Type", "default": "application/octet-stream" }, "files": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Files" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" } }, "type": "object", "required": [ "id", "session_id", "run_id", "name", "filename", "artifact_type", "s3_prefix" ], "title": "ArtifactResponse" }, "AssistantStatus": { "properties": { "available": { "type": "boolean", "title": "Available" }, "workspace_switch": { "type": "string", "enum": [ "undecided", "on", "off" ], "title": "Workspace Switch" }, "can_manage": { "type": "boolean", "title": "Can Manage" } }, "additionalProperties": false, "type": "object", "required": [ "available", "workspace_switch", "can_manage" ], "title": "AssistantStatus" }, "Attempt": { "properties": { "id": { "type": "string", "title": "Id" }, "node_id": { "type": "string", "title": "Node Id" }, "call_id": { "type": "string", "title": "Call Id" }, "attempt_number": { "type": "integer", "minimum": 1.0, "title": "Attempt Number" }, "arguments": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Arguments" }, "original_redacted_output": { "anyOf": [ {}, { "type": "null" } ], "title": "Original Redacted Output" }, "arguments_content_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Arguments Content Id" }, "output_content_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Output Content Id" }, "source_reference": { "$ref": "#/components/schemas/SourceReference" }, "coverage": { "$ref": "#/components/schemas/openapi__bami_foundation__Coverage" }, "admission_order": { "type": "integer", "title": "Admission Order" }, "start_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Start Order" }, "completion_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Completion Order" }, "admitted_at": { "type": "string", "format": "date-time", "title": "Admitted At" }, "started_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Started At" }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At" }, "status": { "type": "string", "enum": [ "queued", "running", "completed", "failed", "skipped", "cancelled", "timed_out" ], "title": "Status" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "late": { "type": "boolean", "title": "Late" }, "usable_as_evidence": { "type": "boolean", "title": "Usable As Evidence" } }, "additionalProperties": false, "type": "object", "required": [ "id", "node_id", "call_id", "attempt_number", "arguments", "original_redacted_output", "arguments_content_id", "output_content_id", "source_reference", "coverage", "admission_order", "start_order", "completion_order", "admitted_at", "started_at", "completed_at", "status", "reason", "late", "usable_as_evidence" ], "title": "Attempt" }, "AttentionCounts": { "properties": { "open": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Open" }, "acknowledged": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Acknowledged" }, "unavailable_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unavailable Reason" } }, "additionalProperties": false, "type": "object", "required": [ "open", "acknowledged", "unavailable_reason" ], "title": "AttentionCounts" }, "AttentionItemOut": { "properties": { "id": { "type": "string", "title": "Id" }, "signal": { "type": "string", "enum": [ "WORKER_HEARTBEAT_STALE", "PROVIDER_ERROR_RATE", "NOTIFICATION_DELIVERY_FAILED", "BUDGET_WARNING", "BUDGET_EXHAUSTED", "WORKSPACE_FAILURE_STREAK", "CONTAINMENT_REVIEW_OVERDUE", "SUPPORT_NOTICE_BLOCKED" ], "title": "Signal" }, "severity": { "type": "string", "enum": [ "critical", "warning", "info" ], "title": "Severity" }, "owner_role": { "type": "string", "const": "operator", "title": "Owner Role" }, "workspace_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Workspace Id" }, "workspace_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Label" }, "component": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Component" }, "subject_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subject Id" }, "symptom": { "type": "string", "title": "Symptom" }, "evidence_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evidence Ref" }, "state": { "type": "string", "enum": [ "open", "acknowledged", "resolved" ], "title": "State" }, "source_status": { "type": "string", "enum": [ "fresh", "stale" ], "title": "Source Status" }, "freshness_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Freshness Seconds" }, "clearing_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Clearing Seconds" }, "first_seen_at": { "type": "string", "format": "date-time", "title": "First Seen At" }, "last_seen_at": { "type": "string", "format": "date-time", "title": "Last Seen At" }, "last_evaluated_at": { "type": "string", "format": "date-time", "title": "Last Evaluated At" }, "notified_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Notified At" }, "notification": { "$ref": "#/components/schemas/NotificationSummary" }, "acknowledged_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Acknowledged At" }, "acknowledged_by": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Acknowledged By" }, "acknowledged_by_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Acknowledged By Label" }, "acknowledgement_audit_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Acknowledgement Audit Id" }, "resolved_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Resolved At" }, "resolved_by": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Resolved By" }, "resolved_by_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resolved By Label" }, "resolution": { "anyOf": [ { "type": "string", "enum": [ "cleared", "manual" ] }, { "type": "null" } ], "title": "Resolution" }, "resolution_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resolution Reason" }, "resolution_audit_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resolution Audit Id" }, "incident_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Incident Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "additionalProperties": false, "type": "object", "required": [ "id", "signal", "severity", "owner_role", "workspace_id", "workspace_label", "component", "subject_id", "symptom", "evidence_ref", "state", "source_status", "freshness_seconds", "clearing_seconds", "first_seen_at", "last_seen_at", "last_evaluated_at", "notified_at", "notification", "acknowledged_at", "acknowledged_by", "acknowledged_by_label", "acknowledgement_audit_id", "resolved_at", "resolved_by", "resolved_by_label", "resolution", "resolution_reason", "resolution_audit_id", "incident_id", "created_at" ], "title": "AttentionItemOut" }, "AttentionMutationResponse": { "properties": { "item": { "$ref": "#/components/schemas/AttentionItemOut" }, "audit_id": { "type": "string", "title": "Audit Id" }, "revision": { "type": "integer", "minimum": 0.0, "title": "Revision" } }, "additionalProperties": false, "type": "object", "required": [ "item", "audit_id", "revision" ], "title": "AttentionMutationResponse" }, "AttentionPage": { "properties": { "data": { "items": { "$ref": "#/components/schemas/AttentionItemOut" }, "type": "array", "title": "Data" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "observed_at": { "type": "string", "format": "date-time", "title": "Observed At" }, "coverage": { "$ref": "#/components/schemas/app__modules__operator_console__console_schema__Coverage" }, "monitoring": { "$ref": "#/components/schemas/Monitoring" } }, "additionalProperties": false, "type": "object", "required": [ "data", "next_cursor", "observed_at", "coverage", "monitoring" ], "title": "AttentionPage" }, "AuditRecord": { "properties": { "id": { "type": "string", "title": "Id" }, "kind": { "type": "string", "enum": [ "control_change", "metadata_read", "content_read", "authentication" ], "title": "Kind" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "actor_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Actor Id" }, "actor_label": { "type": "string", "title": "Actor Label" }, "verb": { "type": "string", "title": "Verb" }, "target_type": { "type": "string", "title": "Target Type" }, "target_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Id" }, "target_label": { "type": "string", "title": "Target Label" }, "workspace_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Workspace Id" }, "outcome": { "type": "string", "enum": [ "applied", "rejected", "allowed", "denied" ], "title": "Outcome" }, "reason_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason Code" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request Id" }, "grant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Grant Id" }, "receipt_id": { "type": "string", "title": "Receipt Id" }, "differences": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Difference" }, "type": "array" }, { "type": "null" } ], "title": "Differences" }, "containment_review_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Containment Review Id" }, "selected_fields": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Selected Fields" } }, "additionalProperties": false, "type": "object", "required": [ "id", "kind", "created_at", "actor_id", "actor_label", "verb", "target_type", "target_id", "target_label", "workspace_id", "outcome", "reason_code", "request_id", "grant_id", "receipt_id", "differences", "containment_review_id", "selected_fields" ], "title": "AuditRecord" }, "AuditRecordRead": { "properties": { "id": { "type": "string", "title": "Id" }, "workspace_id": { "type": "string", "title": "Workspace Id" }, "actor_id": { "type": "string", "title": "Actor Id" }, "action": { "type": "string", "title": "Action" }, "resource_type": { "type": "string", "title": "Resource Type" }, "resource_id": { "type": "string", "title": "Resource Id" }, "session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Session Id" }, "run_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Run Id" }, "event_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Event Id" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request Id" }, "ip_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ip Address" }, "details": { "additionalProperties": true, "type": "object", "title": "Details" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "workspace_id", "actor_id", "action", "resource_type", "resource_id", "created_at" ], "title": "AuditRecordRead" }, "AuthResponse": { "properties": { "user": { "$ref": "#/components/schemas/UserSummary" }, "tenant": { "$ref": "#/components/schemas/TenantSummary" }, "session": { "$ref": "#/components/schemas/app__modules__accounts__account_schema__SessionSummary" } }, "type": "object", "required": [ "user", "tenant", "session" ], "title": "AuthResponse" }, "Availability": { "properties": { "available": { "type": "boolean", "title": "Available" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "content_retention_days": { "type": "integer", "maximum": 90.0, "minimum": 1.0, "title": "Content Retention Days" }, "disclosure": { "type": "string", "title": "Disclosure" } }, "additionalProperties": false, "type": "object", "required": [ "available", "reason", "content_retention_days", "disclosure" ], "title": "Availability" }, "BamiState": { "properties": { "effective_enabled": { "type": "boolean", "title": "Effective Enabled" }, "tenant_override": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Tenant Override" }, "global_enabled": { "type": "boolean", "title": "Global Enabled" }, "precedence": { "type": "string", "enum": [ "global_denial", "tenant_override", "global_default" ], "title": "Precedence" }, "release_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Release Id" }, "revision": { "type": "integer", "minimum": 0.0, "title": "Revision" } }, "additionalProperties": false, "type": "object", "required": [ "effective_enabled", "tenant_override", "global_enabled", "precedence", "release_id", "revision" ], "title": "BamiState" }, "Body_import_tenant_skill_file_v1_skills_upload_post": { "properties": { "file": { "type": "string", "format": "binary", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_import_tenant_skill_file_v1_skills_upload_post" }, "Body_upload_file_v1_sessions__session_id__files_upload_post": { "properties": { "file": { "type": "string", "format": "binary", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_upload_file_v1_sessions__session_id__files_upload_post" }, "Body_upload_tenant_skill_file_v1_skills__name__files_post": { "properties": { "file": { "type": "string", "format": "binary", "title": "File" }, "file_type": { "type": "string", "title": "File Type", "default": "script" } }, "type": "object", "required": [ "file" ], "title": "Body_upload_tenant_skill_file_v1_skills__name__files_post" }, "Budget": { "properties": { "configured": { "type": "boolean", "title": "Configured" }, "daily_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Daily Tokens" }, "daily_usd": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Daily Usd" }, "label": { "anyOf": [ { "type": "string", "const": "Not configured" }, { "type": "null" } ], "title": "Label" } }, "additionalProperties": false, "type": "object", "required": [ "configured", "daily_tokens", "daily_usd", "label" ], "title": "Budget" }, "CancelledData": { "properties": { "graph_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Graph Id" }, "receipt_id": { "type": "string", "title": "Receipt Id" }, "reason": { "type": "string", "enum": [ "cancelled by operator", "cancelled by scope switch", "cancelled by deletion", "cancelled by permission loss" ], "title": "Reason" }, "scope_generation": { "type": "integer", "title": "Scope Generation" }, "unfinished_node_ids": { "items": { "type": "string" }, "type": "array", "title": "Unfinished Node Ids" }, "reservations_released": { "type": "boolean", "title": "Reservations Released" } }, "additionalProperties": false, "type": "object", "required": [ "graph_id", "receipt_id", "reason", "scope_generation", "unfinished_node_ids", "reservations_released" ], "title": "CancelledData" }, "CancelledEvent": { "properties": { "id": { "type": "string", "title": "Id" }, "sequence": { "type": "integer", "minimum": 1.0, "title": "Sequence" }, "conversation_id": { "type": "string", "title": "Conversation Id" }, "run_id": { "type": "string", "format": "uuid", "title": "Run Id" }, "request_id": { "type": "string", "title": "Request Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "late": { "type": "boolean", "title": "Late" }, "usable_as_evidence": { "type": "boolean", "title": "Usable As Evidence" }, "type": { "type": "string", "const": "assistant.cancelled", "title": "Type" }, "data": { "$ref": "#/components/schemas/CancelledData" } }, "additionalProperties": false, "type": "object", "required": [ "id", "sequence", "conversation_id", "run_id", "request_id", "created_at", "late", "usable_as_evidence", "type", "data" ], "title": "CancelledEvent" }, "Challenge": { "properties": { "challenge_id": { "type": "string", "title": "Challenge Id" }, "expires_at": { "type": "string", "format": "date-time", "title": "Expires At" }, "mfa_required": { "type": "boolean", "const": true, "title": "Mfa Required" } }, "additionalProperties": false, "type": "object", "required": [ "challenge_id", "expires_at", "mfa_required" ], "title": "Challenge" }, "CheckerData": { "properties": { "graph_id": { "type": "string", "title": "Graph Id" }, "decision": { "$ref": "#/components/schemas/CheckerDecision" } }, "additionalProperties": false, "type": "object", "required": [ "graph_id", "decision" ], "title": "CheckerData" }, "CheckerDecision": { "properties": { "id": { "type": "string", "title": "Id" }, "attempt_id": { "type": "string", "title": "Attempt Id" }, "source_id": { "type": "string", "title": "Source Id" }, "status": { "type": "string", "enum": [ "accepted", "rejected" ], "title": "Status" }, "check_kind": { "type": "string", "enum": [ "deterministic", "model" ], "title": "Check Kind" }, "category": { "type": "string", "enum": [ "usable", "empty", "malformed", "off_target", "timed_out", "reply_empty", "off_topic", "contradiction", "reply_language_mismatch", "low_confidence" ], "title": "Category" }, "reason": { "type": "string", "title": "Reason" }, "conflicting_source_ids": { "items": { "type": "string" }, "type": "array", "title": "Conflicting Source Ids" }, "report_reference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Report Reference" }, "model_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Version" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "additionalProperties": false, "type": "object", "required": [ "id", "attempt_id", "source_id", "status", "check_kind", "category", "reason", "conflicting_source_ids", "report_reference", "model_version", "created_at" ], "title": "CheckerDecision" }, "CheckerEvent": { "properties": { "id": { "type": "string", "title": "Id" }, "sequence": { "type": "integer", "minimum": 1.0, "title": "Sequence" }, "conversation_id": { "type": "string", "title": "Conversation Id" }, "run_id": { "type": "string", "format": "uuid", "title": "Run Id" }, "request_id": { "type": "string", "title": "Request Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "late": { "type": "boolean", "title": "Late" }, "usable_as_evidence": { "type": "boolean", "title": "Usable As Evidence" }, "type": { "type": "string", "const": "assistant.checker", "title": "Type" }, "data": { "$ref": "#/components/schemas/CheckerData" } }, "additionalProperties": false, "type": "object", "required": [ "id", "sequence", "conversation_id", "run_id", "request_id", "created_at", "late", "usable_as_evidence", "type", "data" ], "title": "CheckerEvent" }, "ClassificationRequest": { "properties": { "reason": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Reason" }, "expected_revision": { "type": "integer", "minimum": 0.0, "title": "Expected Revision" }, "classification": { "type": "string", "enum": [ "customer", "internal", "test", "demo", "unclassified" ], "title": "Classification" } }, "additionalProperties": false, "type": "object", "required": [ "reason", "expected_revision", "classification" ], "title": "ClassificationRequest" }, "ClassificationResponse": { "properties": { "detail": { "$ref": "#/components/schemas/TenantDetail" }, "audit_id": { "type": "string", "title": "Audit Id" }, "revision": { "type": "integer", "minimum": 0.0, "title": "Revision" } }, "additionalProperties": false, "type": "object", "required": [ "detail", "audit_id", "revision" ], "title": "ClassificationResponse" }, "ClassificationState": { "properties": { "value": { "type": "string", "enum": [ "customer", "internal", "test", "demo", "unclassified" ], "title": "Value" }, "suggestion": { "anyOf": [ { "type": "string", "enum": [ "customer", "internal", "test", "demo", "unclassified" ] }, { "type": "null" } ], "title": "Suggestion" }, "suggestion_source": { "anyOf": [ { "type": "string", "enum": [ "smoke_harness", "demo_tenant_list", "alethi_domain", "migration_walkthrough" ] }, { "type": "null" } ], "title": "Suggestion Source" }, "confirmed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Confirmed At" } }, "additionalProperties": false, "type": "object", "required": [ "value", "suggestion", "suggestion_source", "confirmed_at" ], "title": "ClassificationState" }, "ClassificationSummary": { "properties": { "customer": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Customer" }, "internal": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Internal" }, "test": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Test" }, "demo": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Demo" }, "unclassified": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Unclassified" } }, "additionalProperties": false, "type": "object", "required": [ "customer", "internal", "test", "demo", "unclassified" ], "title": "ClassificationSummary", "description": "Confirmed classification counts; null (never zero) when the tenants source failed." }, "CompletedData": { "properties": { "graph_id": { "type": "string", "title": "Graph Id" }, "receipt_ids": { "items": { "type": "string" }, "type": "array", "title": "Receipt Ids" }, "outcome": { "type": "string", "enum": [ "diagnosed", "inconclusive", "passed", "failed", "waiting" ], "title": "Outcome" }, "summary_content_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Summary Content Id" }, "accepted_source_ids": { "items": { "type": "string" }, "type": "array", "title": "Accepted Source Ids" } }, "additionalProperties": false, "type": "object", "required": [ "graph_id", "receipt_ids", "outcome", "summary_content_id", "accepted_source_ids" ], "title": "CompletedData" }, "CompletedEvent": { "properties": { "id": { "type": "string", "title": "Id" }, "sequence": { "type": "integer", "minimum": 1.0, "title": "Sequence" }, "conversation_id": { "type": "string", "title": "Conversation Id" }, "run_id": { "type": "string", "format": "uuid", "title": "Run Id" }, "request_id": { "type": "string", "title": "Request Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "late": { "type": "boolean", "title": "Late" }, "usable_as_evidence": { "type": "boolean", "title": "Usable As Evidence" }, "type": { "type": "string", "const": "assistant.completed", "title": "Type" }, "data": { "$ref": "#/components/schemas/CompletedData" } }, "additionalProperties": false, "type": "object", "required": [ "id", "sequence", "conversation_id", "run_id", "request_id", "created_at", "late", "usable_as_evidence", "type", "data" ], "title": "CompletedEvent" }, "ComponentHealthResponse": { "properties": { "status": { "type": "string", "enum": [ "ok", "degraded", "down" ], "title": "Status" }, "checked_at": { "type": "string", "title": "Checked At" }, "release": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Release" }, "components": { "$ref": "#/components/schemas/Components", "description": "Per-component status. Never includes hostnames, secrets, or stack traces." }, "incidents": { "$ref": "#/components/schemas/IncidentFeed", "description": "Operator console incidents with customer safe summaries only." } }, "type": "object", "required": [ "status", "checked_at", "components" ], "title": "ComponentHealthResponse" }, "Components": { "properties": { "api": { "$ref": "#/components/schemas/ApiComponent" }, "database": { "$ref": "#/components/schemas/LatencyComponent" }, "worker": { "$ref": "#/components/schemas/WorkerComponent" }, "sandbox_provider": { "$ref": "#/components/schemas/LatencyComponent" } }, "type": "object", "required": [ "api", "database", "worker", "sandbox_provider" ], "title": "Components" }, "ConfigurationAudit": { "properties": { "id": { "type": "string", "title": "Id" }, "actor_id": { "type": "string", "format": "uuid", "title": "Actor Id" }, "action": { "type": "string", "title": "Action" }, "resource_type": { "type": "string", "title": "Resource Type" }, "resource_id": { "type": "string", "title": "Resource Id" }, "reason": { "type": "string", "title": "Reason" }, "expected_revision": { "type": "integer", "minimum": 0.0, "title": "Expected Revision" }, "observed_revision": { "type": "integer", "minimum": 0.0, "title": "Observed Revision" }, "previous_values": { "additionalProperties": true, "type": "object", "title": "Previous Values" }, "new_values": { "additionalProperties": true, "type": "object", "title": "New Values" }, "outcome": { "type": "string", "enum": [ "applied", "rejected" ], "title": "Outcome" }, "request_id": { "type": "string", "title": "Request Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "expires_at": { "type": "string", "format": "date-time", "title": "Expires At" } }, "additionalProperties": false, "type": "object", "required": [ "id", "actor_id", "action", "resource_type", "resource_id", "reason", "expected_revision", "observed_revision", "previous_values", "new_values", "outcome", "request_id", "created_at", "expires_at" ], "title": "ConfigurationAudit" }, "ConsoleAdminSession": { "properties": { "id": { "type": "string", "title": "Id" }, "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, "mfa_verified_at": { "type": "string", "format": "date-time", "title": "Mfa Verified At" }, "expires_at": { "type": "string", "format": "date-time", "title": "Expires At" }, "csrf_token": { "type": "string", "title": "Csrf Token" }, "role": { "type": "string", "enum": [ "operator", "support" ], "title": "Role" }, "containment": { "$ref": "#/components/schemas/ContainmentStatus" } }, "additionalProperties": false, "type": "object", "required": [ "id", "user_id", "mfa_verified_at", "expires_at", "csrf_token", "role", "containment" ], "title": "ConsoleAdminSession", "description": "Phase one AdminSession plus the console role and containment banner fields." }, "ContainmentReviewOut": { "properties": { "id": { "type": "string", "title": "Id" }, "action": { "type": "string", "enum": [ "bami.kill", "bami.tenant_disable", "bami.global_disable", "bami.limit_decrease", "tenant.suspend", "tenant.limit_decrease", "key.revoke" ], "title": "Action" }, "action_audit_id": { "type": "string", "title": "Action Audit Id" }, "workspace_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Workspace Id" }, "workspace_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Name", "description": "The workspace's display name, resolved server side. Null for a deleted or otherwise unresolvable tenant, or a platform-level review; the caller falls back to the id." }, "actor_id": { "type": "string", "format": "uuid", "title": "Actor Id" }, "actor_label": { "type": "string", "title": "Actor Label" }, "reviewer_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Reviewer Id" }, "reviewer_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reviewer Label" }, "mode": { "type": "string", "enum": [ "review", "solo_self_approval" ], "title": "Mode" }, "status": { "type": "string", "enum": [ "open", "overdue", "disposed" ], "title": "Status" }, "due_at": { "type": "string", "format": "date-time", "title": "Due At" }, "escalated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Escalated At" }, "disposition": { "anyOf": [ { "type": "string", "enum": [ "upheld", "reversed", "noted" ] }, { "type": "null" } ], "title": "Disposition" }, "disposition_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Disposition Reason" }, "disposed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Disposed At" }, "disposed_by": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Disposed By" }, "disposition_audit_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Disposition Audit Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "additionalProperties": false, "type": "object", "required": [ "id", "action", "action_audit_id", "workspace_id", "workspace_name", "actor_id", "actor_label", "reviewer_id", "reviewer_label", "mode", "status", "due_at", "escalated_at", "disposition", "disposition_reason", "disposed_at", "disposed_by", "disposition_audit_id", "created_at" ], "title": "ContainmentReviewOut" }, "ContainmentStatus": { "properties": { "open_review_count": { "type": "integer", "minimum": 0.0, "title": "Open Review Count" }, "overdue_review_count": { "type": "integer", "minimum": 0.0, "title": "Overdue Review Count" }, "solo_containment_blocked": { "type": "boolean", "title": "Solo Containment Blocked" }, "banner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Banner" } }, "additionalProperties": false, "type": "object", "required": [ "open_review_count", "overdue_review_count", "solo_containment_blocked", "banner" ], "title": "ContainmentStatus" }, "ControlResponse": { "properties": { "detail": { "$ref": "#/components/schemas/TenantDetail" }, "receipt_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Receipt Id" }, "audit_id": { "type": "string", "title": "Audit Id" }, "revision": { "type": "integer", "minimum": 0.0, "title": "Revision" } }, "additionalProperties": false, "type": "object", "required": [ "detail", "receipt_id", "audit_id", "revision" ], "title": "ControlResponse" }, "Conversation": { "properties": { "id": { "type": "string", "title": "Id" }, "workspace_id": { "type": "string", "format": "uuid", "title": "Workspace Id" }, "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, "session_id": { "type": "string", "format": "uuid", "title": "Session Id" }, "scope": { "$ref": "#/components/schemas/Scope" }, "scope_generation": { "type": "integer", "minimum": 0.0, "title": "Scope Generation" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "active_run_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Active Run Id" }, "release_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Release Id" }, "model_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Version" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "deleted_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Deleted At" }, "expires_at": { "type": "string", "format": "date-time", "title": "Expires At" }, "cancellation_receipt_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cancellation Receipt Id" }, "availability": { "$ref": "#/components/schemas/Availability" } }, "additionalProperties": false, "type": "object", "required": [ "id", "workspace_id", "user_id", "session_id", "scope", "scope_generation", "title", "active_run_id", "release_id", "model_version", "created_at", "updated_at", "deleted_at", "expires_at", "cancellation_receipt_id", "availability" ], "title": "Conversation" }, "ConversationCreate": { "properties": { "title": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "title": "Title" }, "scope": { "$ref": "#/components/schemas/Scope" } }, "additionalProperties": false, "type": "object", "required": [ "scope" ], "title": "ConversationCreate" }, "ConversationDetail": { "properties": { "conversation": { "$ref": "#/components/schemas/Conversation" }, "messages": { "$ref": "#/components/schemas/MessagePage" }, "events": { "$ref": "#/components/schemas/Events" }, "graphs": { "$ref": "#/components/schemas/GraphPage" } }, "additionalProperties": false, "type": "object", "required": [ "conversation", "messages", "events", "graphs" ], "title": "ConversationDetail" }, "ConversationPage": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Conversation" }, "type": "array", "title": "Data" }, "next_page": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next Page" }, "total": { "type": "integer", "title": "Total" } }, "additionalProperties": false, "type": "object", "required": [ "data", "next_page", "total" ], "title": "ConversationPage" }, "Cost": { "properties": { "period": { "$ref": "#/components/schemas/Period" }, "lines": { "items": { "$ref": "#/components/schemas/CostLine" }, "type": "array", "title": "Lines" }, "coverage": { "$ref": "#/components/schemas/CostCoverage" }, "billing_label": { "type": "string", "const": "Free builder preview", "title": "Billing Label" } }, "additionalProperties": false, "type": "object", "required": [ "period", "lines", "coverage", "billing_label" ], "title": "Cost" }, "CostCoverage": { "properties": { "complete": { "type": "integer", "minimum": 0.0, "title": "Complete" }, "partial": { "type": "integer", "minimum": 0.0, "title": "Partial" }, "missing": { "type": "integer", "minimum": 0.0, "title": "Missing" } }, "additionalProperties": false, "type": "object", "required": [ "complete", "partial", "missing" ], "title": "CostCoverage" }, "CostLine": { "properties": { "payer": { "type": "string", "enum": [ "platform", "tenant_verification", "tenant_builder" ], "title": "Payer" }, "usd": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usd" }, "provenance": { "type": "string", "enum": [ "provider_reported", "recorded_unverified", "estimated", "mixed", "unavailable" ], "title": "Provenance" }, "run_count": { "type": "integer", "minimum": 0.0, "title": "Run Count" }, "unavailable_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unavailable Reason" } }, "additionalProperties": false, "type": "object", "required": [ "payer", "usd", "provenance", "run_count", "unavailable_reason" ], "title": "CostLine" }, "Counts": { "properties": { "users": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Users" }, "keys_active": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Keys Active" }, "keys_expired": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Keys Expired" }, "keys_revoked": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Keys Revoked" }, "agents": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Agents" }, "deployments": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Deployments" }, "sessions": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sessions" }, "runs": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Runs" }, "unavailable_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unavailable Reason" } }, "additionalProperties": false, "type": "object", "required": [ "users", "keys_active", "keys_expired", "keys_revoked", "agents", "deployments", "sessions", "runs", "unavailable_reason" ], "title": "Counts" }, "CreateAgentRequest": { "properties": { "name": { "type": "string", "title": "Name" }, "slug": { "type": "string", "title": "Slug" }, "model": { "type": "string", "title": "Model", "default": "deepseek/deepseek-v4-flash:nitro" }, "system_prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "System Prompt" }, "tools": { "items": { "type": "string" }, "type": "array", "title": "Tools", "description": "Which of Pantheon's built-in tools this agent may use. The list is an allowlist over exactly these names and it is enforced at run time: web_search, web_fetch, publish_artifact, list_session_artifacts. One of these that is not listed is not attached, and a call to it is refused before it runs and recorded on the run as tool.refused. This list does not govern the sandbox. While requires_sandbox is true the agent also has a shell (execute) and the file tools, and the sandbox can reach the network, so an agent that declares no web tools can still fetch a URL from the shell. Set requires_sandbox to false to remove all of that. Writing this field opts an agent created before enforcement into it; agents created after it are governed from their first revision." }, "tool_requirements": { "items": { "$ref": "#/components/schemas/ToolRequirement" }, "type": "array", "title": "Tool Requirements" }, "skills": { "items": { "type": "string" }, "type": "array", "title": "Skills" }, "environment_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Environment Id" }, "requires_sandbox": { "type": "boolean", "title": "Requires Sandbox", "description": "Whether sessions for this agent require a provisioned sandbox. When false, sandbox tools and file operations are unavailable.", "default": true }, "metadata": { "additionalProperties": true, "type": "object", "title": "Metadata" } }, "type": "object", "required": [ "name", "slug" ], "title": "CreateAgentRequest", "examples": [ { "model": "deepseek/deepseek-v4-flash:nitro", "name": "Research Assistant", "skills": [], "slug": "research", "system_prompt": "You are a concise, helpful research assistant.", "tools": [ "web_search", "sandbox_bash" ] } ] }, "CreateDeploymentRequest": { "properties": { "agent_id": { "type": "string", "title": "Agent Id" }, "agent_version": { "anyOf": [ { "type": "integer", "minimum": 1.0 }, { "type": "null" } ], "title": "Agent Version" }, "tool_definition_ids": { "items": { "type": "string" }, "type": "array", "maxItems": 64, "title": "Tool Definition Ids" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" }, "environment_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Environment Id" }, "application_tool_response_deadline_seconds": { "type": "integer", "maximum": 86400.0, "minimum": 30.0, "title": "Application Tool Response Deadline Seconds" } }, "additionalProperties": false, "type": "object", "required": [ "agent_id" ], "title": "CreateDeploymentRequest" }, "CreateEnvironmentRequest": { "properties": { "name": { "type": "string", "title": "Name" }, "provider": { "type": "string", "title": "Provider", "default": "daytona" }, "config": { "$ref": "#/components/schemas/EnvironmentConfig" } }, "type": "object", "required": [ "name" ], "title": "CreateEnvironmentRequest", "examples": [ { "config": { "image": "daytonaio/workspace:latest", "target": "eu" }, "name": "python-default", "provider": "daytona" } ] }, "CreateRunRequest": { "properties": { "events": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Events", "description": "At least one user.message event with non-whitespace text is required." }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" } }, "type": "object", "title": "CreateRunRequest", "examples": [ { "events": [ { "content": [ { "text": "Say hello in one sentence.", "type": "text" } ], "type": "user.message" } ] } ] }, "CreateSecretRequest": { "properties": { "name": { "type": "string", "title": "Name", "description": "Unique within your workspace, and the default environment variable name inside the sandbox.", "examples": [ "ZOHO_OAUTH_TOKEN" ] }, "value": { "type": "string", "title": "Value", "description": "The credential. Written once and never returned: no route in this API reads it back, and list and read answer with the name, the fingerprint and who set it. The agent has a shell in its own sandbox, so it can read its own environment and its own files and print this value into its own output. Pantheon keeps the value out of every prompt, event, log and record it controls, and it cannot stop an agent from disclosing a credential it was deliberately given. Store narrow, short lived credentials only, scoped to what the agent must do, and revoke them at the source when the work ends." }, "description": { "type": "string", "maxLength": 500, "title": "Description", "description": "What this credential is for. Never put the value here.", "default": "" } }, "type": "object", "required": [ "name", "value" ], "title": "CreateSecretRequest", "examples": [ { "description": "Zoho Mail, mail.messages.READ only, expires in 1 hour", "name": "ZOHO_OAUTH_TOKEN", "value": "1000.abc..." } ] }, "CreateSessionRequest": { "properties": { "agent_slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agent Slug" }, "deployment_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deployment Id" }, "prefer_latest_agent_version": { "type": "boolean", "title": "Prefer Latest Agent Version", "description": "For agent_slug sessions with unpublished agent changes, create or reuse a legacy snapshot for the latest agent version instead of using the newest published deployment. An explicitly activated deployment takes precedence over this option.", "default": false }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id" }, "environment_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Environment Id" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "metadata": { "additionalProperties": true, "type": "object", "title": "Metadata" }, "secrets": { "items": { "$ref": "#/components/schemas/SessionSecretBinding" }, "type": "array", "title": "Secrets", "description": "Workspace secrets this session's sandbox receives, by name. Each one arrives as an environment variable, as a file, or both, in this session's sandbox and in no other. The agent has a shell in its own sandbox, so it can read its own environment and its own files and print this value into its own output. Pantheon keeps the value out of every prompt, event, log and record it controls, and it cannot stop an agent from disclosing a credential it was deliberately given. Store narrow, short lived credentials only, scoped to what the agent must do, and revoke them at the source when the work ends." }, "env": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Env", "description": "Plain environment variables for this session's sandbox. These are stored as written and returned by GET /v1/sessions, so they are for settings, not credentials: a directory a tool reads its token from, a host name, a mode flag. Put the credential itself in a workspace secret and name it under secrets." } }, "type": "object", "title": "CreateSessionRequest", "examples": [ { "agent_slug": "research", "title": "First session" } ] }, "CreateSkillRequest": { "properties": { "name": { "type": "string", "maxLength": 64, "pattern": "^[a-z0-9-]+$", "title": "Name" }, "description": { "type": "string", "maxLength": 1024, "title": "Description" }, "content": { "type": "string", "title": "Content" }, "license": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "License" }, "compatibility": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Compatibility" }, "allowed_tools": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Allowed Tools" }, "metadata": { "additionalProperties": true, "type": "object", "title": "Metadata" } }, "type": "object", "required": [ "name", "description", "content" ], "title": "CreateSkillRequest" }, "CreateTenantRequest": { "properties": { "name": { "type": "string", "title": "Name" }, "slug": { "type": "string", "title": "Slug" }, "metadata": { "additionalProperties": true, "type": "object", "title": "Metadata", "default": {} } }, "type": "object", "required": [ "name", "slug" ], "title": "CreateTenantRequest", "examples": [ { "metadata": { "plan": "pro" }, "name": "Acme Corp", "slug": "acme" } ] }, "CreateTenantUserRequest": { "properties": { "name": { "type": "string", "title": "Name" }, "email": { "type": "string", "title": "Email" }, "role": { "type": "string", "title": "Role", "default": "member" }, "metadata": { "additionalProperties": true, "type": "object", "title": "Metadata" } }, "type": "object", "required": [ "name", "email" ], "title": "CreateTenantUserRequest" }, "CreateToolRequest": { "properties": { "description": { "type": "string", "maxLength": 4000, "minLength": 1, "title": "Description" }, "executor": { "type": "string", "const": "application", "title": "Executor", "default": "application" }, "input_schema": { "additionalProperties": true, "type": "object", "title": "Input Schema" }, "output_schema": { "additionalProperties": true, "type": "object", "title": "Output Schema" }, "side_effect": { "type": "string", "enum": [ "none", "workspace_write", "external_write" ], "title": "Side Effect", "default": "none" }, "confirmation": { "type": "string", "enum": [ "never", "policy" ], "title": "Confirmation", "description": "Only 'never' and 'policy' are supported in this release; gate the call in your application.", "default": "never" }, "name": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$", "title": "Name" }, "display_name": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Display Name" } }, "additionalProperties": false, "type": "object", "required": [ "description", "input_schema", "output_schema", "name", "display_name" ], "title": "CreateToolRequest" }, "CreateToolVersionRequest": { "properties": { "description": { "type": "string", "maxLength": 4000, "minLength": 1, "title": "Description" }, "executor": { "type": "string", "const": "application", "title": "Executor", "default": "application" }, "input_schema": { "additionalProperties": true, "type": "object", "title": "Input Schema" }, "output_schema": { "additionalProperties": true, "type": "object", "title": "Output Schema" }, "side_effect": { "type": "string", "enum": [ "none", "workspace_write", "external_write" ], "title": "Side Effect", "default": "none" }, "confirmation": { "type": "string", "enum": [ "never", "policy" ], "title": "Confirmation", "description": "Only 'never' and 'policy' are supported in this release; gate the call in your application.", "default": "never" } }, "additionalProperties": false, "type": "object", "required": [ "description", "input_schema", "output_schema" ], "title": "CreateToolVersionRequest" }, "CurrentModel": { "properties": { "enabled": { "type": "boolean", "title": "Enabled" }, "model_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Version" }, "release_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Release Id" }, "evaluation_passed": { "type": "boolean", "title": "Evaluation Passed" }, "stage": { "type": "string", "enum": [ "off", "internal", "preview", "general" ], "title": "Stage" } }, "additionalProperties": false, "type": "object", "required": [ "enabled", "model_version", "release_id", "evaluation_passed", "stage" ], "title": "CurrentModel" }, "DataRequestCreate": { "properties": { "reason": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Reason" }, "expected_revision": { "type": "integer", "minimum": 0.0, "title": "Expected Revision" }, "workspace_id": { "type": "string", "format": "uuid", "title": "Workspace Id" }, "kind": { "type": "string", "enum": [ "access", "erasure", "portability" ], "title": "Kind" }, "requester_user_id": { "type": "string", "format": "uuid", "title": "Requester User Id" }, "scope": { "items": { "type": "string" }, "type": "array", "maxItems": 50, "title": "Scope" }, "owner_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Owner Id" } }, "additionalProperties": false, "type": "object", "required": [ "reason", "expected_revision", "workspace_id", "kind", "requester_user_id" ], "title": "DataRequestCreate" }, "DataRequestOut": { "properties": { "id": { "type": "string", "title": "Id" }, "workspace_id": { "type": "string", "format": "uuid", "title": "Workspace Id" }, "workspace_label": { "type": "string", "title": "Workspace Label" }, "kind": { "type": "string", "enum": [ "access", "erasure", "portability" ], "title": "Kind" }, "status": { "type": "string", "enum": [ "received", "in_progress", "awaiting_external", "completed", "rejected" ], "title": "Status" }, "requester_user_id": { "type": "string", "format": "uuid", "title": "Requester User Id" }, "requester_verified_at": { "type": "string", "format": "date-time", "title": "Requester Verified At" }, "scope": { "items": { "type": "string" }, "type": "array", "title": "Scope" }, "owner_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Owner Id" }, "owner_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner Label" }, "received_at": { "type": "string", "format": "date-time", "title": "Received At" }, "deadline_at": { "type": "string", "format": "date-time", "title": "Deadline At" }, "overdue": { "type": "boolean", "title": "Overdue" }, "steps": { "items": { "$ref": "#/components/schemas/DataRequestStep" }, "type": "array", "title": "Steps" }, "outstanding_steps": { "items": { "type": "string" }, "type": "array", "title": "Outstanding Steps" }, "receipt_ids": { "items": { "type": "string" }, "type": "array", "title": "Receipt Ids" }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At" }, "created_by_audit_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By Audit Id" }, "updated_by_audit_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated By Audit Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" } }, "additionalProperties": false, "type": "object", "required": [ "id", "workspace_id", "workspace_label", "kind", "status", "requester_user_id", "requester_verified_at", "scope", "owner_id", "owner_label", "received_at", "deadline_at", "overdue", "steps", "outstanding_steps", "receipt_ids", "completed_at", "created_by_audit_id", "updated_by_audit_id", "created_at", "updated_at" ], "title": "DataRequestOut" }, "DataRequestPage": { "properties": { "data": { "items": { "$ref": "#/components/schemas/DataRequestOut" }, "type": "array", "title": "Data" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "observed_at": { "type": "string", "format": "date-time", "title": "Observed At" }, "coverage": { "$ref": "#/components/schemas/app__modules__operator_console__console_schema__Coverage" } }, "additionalProperties": false, "type": "object", "required": [ "data", "next_cursor", "observed_at", "coverage" ], "title": "DataRequestPage" }, "DataRequestPatch": { "properties": { "reason": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Reason" }, "expected_revision": { "type": "integer", "minimum": 0.0, "title": "Expected Revision" }, "status": { "anyOf": [ { "type": "string", "enum": [ "received", "in_progress", "awaiting_external", "completed", "rejected" ] }, { "type": "null" } ], "title": "Status" }, "owner_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Owner Id" }, "step": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "Step" }, "receipt": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Receipt" } }, "additionalProperties": false, "type": "object", "required": [ "reason", "expected_revision" ], "title": "DataRequestPatch" }, "DataRequestResponse": { "properties": { "request": { "$ref": "#/components/schemas/DataRequestOut" }, "audit_id": { "type": "string", "title": "Audit Id" }, "revision": { "type": "integer", "minimum": 0.0, "title": "Revision" } }, "additionalProperties": false, "type": "object", "required": [ "request", "audit_id", "revision" ], "title": "DataRequestResponse" }, "DataRequestStep": { "properties": { "step": { "type": "string", "title": "Step" }, "description": { "type": "string", "title": "Description" }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At" }, "receipt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Receipt" }, "performed_by_server": { "type": "boolean", "title": "Performed By Server", "description": "True when this server carried the step out and produced the receipt itself. False means the step is evidenced outside Pantheon and the receipt is the operator's record of it, which the server did not verify." } }, "additionalProperties": false, "type": "object", "required": [ "step", "description", "completed_at", "receipt", "performed_by_server" ], "title": "DataRequestStep" }, "DatePeriod": { "properties": { "from": { "type": "string", "format": "date", "title": "From" }, "to": { "type": "string", "format": "date", "title": "To" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "title": "DatePeriod" }, "DeltaData": { "properties": { "text": { "type": "string", "title": "Text" }, "scope_generation": { "type": "integer", "title": "Scope Generation" } }, "additionalProperties": false, "type": "object", "required": [ "text", "scope_generation" ], "title": "DeltaData" }, "DeltaEvent": { "properties": { "conversation_id": { "type": "string", "title": "Conversation Id" }, "run_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Run Id" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "type": { "type": "string", "const": "assistant.delta", "title": "Type" }, "data": { "$ref": "#/components/schemas/DeltaData" } }, "additionalProperties": false, "type": "object", "required": [ "conversation_id", "run_id", "request_id", "created_at", "type", "data" ], "title": "DeltaEvent" }, "DeploymentListResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/DeploymentResponse" }, "type": "array", "title": "Data" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "type": "object", "required": [ "data" ], "title": "DeploymentListResponse" }, "DeploymentPage": { "properties": { "data": { "items": { "$ref": "#/components/schemas/DeploymentSummary" }, "type": "array", "title": "Data" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "observed_at": { "type": "string", "format": "date-time", "title": "Observed At" }, "coverage": { "$ref": "#/components/schemas/app__modules__operator_console__console_schema__Coverage" } }, "additionalProperties": false, "type": "object", "required": [ "data", "next_cursor", "observed_at", "coverage" ], "title": "DeploymentPage" }, "DeploymentResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "agent_id": { "type": "string", "title": "Agent Id" }, "agent_revision_id": { "type": "string", "title": "Agent Revision Id" }, "agent_version": { "type": "integer", "title": "Agent Version" }, "model": { "type": "string", "title": "Model" }, "environment_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Environment Id" }, "requires_sandbox": { "type": "boolean", "title": "Requires Sandbox", "description": "Whether sessions created from this deployment require a provisioned sandbox." }, "application_tool_response_deadline_seconds": { "type": "integer", "title": "Application Tool Response Deadline Seconds" }, "prompt_policy_version": { "type": "string", "title": "Prompt Policy Version" }, "prompt_policy_hash": { "type": "string", "title": "Prompt Policy Hash" }, "content_hash": { "type": "string", "title": "Content Hash" }, "source": { "type": "string", "title": "Source" }, "status": { "type": "string", "title": "Status" }, "active": { "type": "boolean", "title": "Active" }, "tool_bindings": { "items": { "$ref": "#/components/schemas/DeploymentToolBindingResponse" }, "type": "array", "title": "Tool Bindings" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "agent_id", "agent_revision_id", "agent_version", "model", "requires_sandbox", "application_tool_response_deadline_seconds", "prompt_policy_version", "prompt_policy_hash", "content_hash", "source", "status", "active", "created_at" ], "title": "DeploymentResponse" }, "DeploymentSummary": { "properties": { "id": { "type": "string", "title": "Id" }, "tenant_id": { "type": "string", "format": "uuid", "title": "Tenant Id" }, "workspace_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Name", "description": "The workspace's display name, resolved server side. Null for a deleted or otherwise unresolvable tenant; the caller falls back to the id." }, "agent_id": { "type": "string", "format": "uuid", "title": "Agent Id" }, "agent_revision_id": { "type": "string", "title": "Agent Revision Id" }, "model": { "type": "string", "title": "Model" }, "environment_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Environment Id" }, "requires_sandbox": { "type": "boolean", "title": "Requires Sandbox", "description": "Whether this deployment snapshot runs with a sandbox." }, "source": { "type": "string", "title": "Source" }, "status": { "type": "string", "title": "Status" }, "prompt_policy_version": { "type": "string", "title": "Prompt Policy Version" }, "binding_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Binding Count" }, "session_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Session Count" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "additionalProperties": false, "type": "object", "required": [ "id", "tenant_id", "workspace_name", "agent_id", "agent_revision_id", "model", "environment_id", "requires_sandbox", "source", "status", "prompt_policy_version", "binding_count", "session_count", "created_at" ], "title": "DeploymentSummary" }, "DeploymentToolBindingResponse": { "properties": { "tool_definition_id": { "type": "string", "title": "Tool Definition Id" }, "tool_id": { "type": "string", "title": "Tool Id" }, "name": { "type": "string", "title": "Name" }, "version": { "type": "integer", "title": "Version" }, "content_hash": { "type": "string", "title": "Content Hash" }, "description": { "type": "string", "title": "Description" }, "executor": { "type": "string", "title": "Executor" }, "input_schema": { "additionalProperties": true, "type": "object", "title": "Input Schema" }, "output_schema": { "additionalProperties": true, "type": "object", "title": "Output Schema" }, "side_effect": { "type": "string", "title": "Side Effect" }, "confirmation": { "type": "string", "title": "Confirmation" } }, "type": "object", "required": [ "tool_definition_id", "tool_id", "name", "version", "content_hash", "description", "executor", "input_schema", "output_schema", "side_effect", "confirmation" ], "title": "DeploymentToolBindingResponse" }, "DiagnosticCoverage": { "properties": { "audit": { "$ref": "#/components/schemas/openapi__bami_foundation__Coverage" }, "sessions": { "$ref": "#/components/schemas/openapi__bami_foundation__Coverage" }, "runs": { "$ref": "#/components/schemas/openapi__bami_foundation__Coverage" }, "events": { "$ref": "#/components/schemas/openapi__bami_foundation__Coverage" } }, "additionalProperties": false, "type": "object", "required": [ "audit", "sessions", "runs", "events" ], "title": "DiagnosticCoverage" }, "DiagnosticCursors": { "properties": { "audit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Audit" }, "sessions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sessions" }, "runs": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Runs" }, "events": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Events" } }, "additionalProperties": false, "type": "object", "required": [ "audit", "sessions", "runs", "events" ], "title": "DiagnosticCursors" }, "DiagnosticLookup": { "properties": { "target": { "anyOf": [ { "$ref": "#/components/schemas/Scope" }, { "type": "null" } ] }, "audit": { "items": { "$ref": "#/components/schemas/AuditRecordRead" }, "type": "array", "title": "Audit" }, "sessions": { "items": { "$ref": "#/components/schemas/SessionResponse" }, "type": "array", "title": "Sessions" }, "runs": { "items": { "$ref": "#/components/schemas/RunResponse" }, "type": "array", "title": "Runs" }, "events": { "items": { "$ref": "#/components/schemas/EventResponse" }, "type": "array", "title": "Events" }, "coverage": { "$ref": "#/components/schemas/DiagnosticCoverage" }, "next_cursors": { "$ref": "#/components/schemas/DiagnosticCursors" } }, "additionalProperties": false, "type": "object", "required": [ "target", "audit", "sessions", "runs", "events", "coverage", "next_cursors" ], "title": "DiagnosticLookup" }, "Difference": { "properties": { "field": { "type": "string", "title": "Field" }, "before": { "anyOf": [ {}, { "type": "null" } ], "title": "Before" }, "after": { "anyOf": [ {}, { "type": "null" } ], "title": "After" } }, "additionalProperties": false, "type": "object", "required": [ "field", "before", "after" ], "title": "Difference" }, "DispositionRequest": { "properties": { "reason": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Reason" }, "expected_revision": { "type": "integer", "minimum": 0.0, "title": "Expected Revision" }, "disposition": { "type": "string", "enum": [ "upheld", "reversed", "noted" ], "title": "Disposition" } }, "additionalProperties": false, "type": "object", "required": [ "reason", "expected_revision", "disposition" ], "title": "DispositionRequest" }, "DispositionResponse": { "properties": { "review": { "$ref": "#/components/schemas/ContainmentReviewOut" }, "audit_id": { "type": "string", "title": "Audit Id" }, "revision": { "type": "integer", "minimum": 0.0, "title": "Revision" } }, "additionalProperties": false, "type": "object", "required": [ "review", "audit_id", "revision" ], "title": "DispositionResponse" }, "EmailRequest": { "properties": { "email": { "type": "string", "maxLength": 254, "format": "email", "title": "Email" } }, "type": "object", "required": [ "email" ], "title": "EmailRequest" }, "EmailSentResponse": { "properties": { "status": { "type": "string", "title": "Status", "default": "sent" } }, "type": "object", "title": "EmailSentResponse" }, "EmailTokenRequest": { "properties": { "token": { "type": "string", "title": "Token" } }, "type": "object", "required": [ "token" ], "title": "EmailTokenRequest" }, "EmailVerifiedResponse": { "properties": { "email_verified_at": { "type": "string", "format": "date-time", "title": "Email Verified At" } }, "type": "object", "required": [ "email_verified_at" ], "title": "EmailVerifiedResponse" }, "EmergencyRevokeRequest": { "properties": { "reason": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Reason" }, "expected_revision": { "type": "integer", "minimum": 0.0, "title": "Expected Revision" }, "totp_code": { "type": "string", "pattern": "^\\d{6}$", "title": "Totp Code" } }, "additionalProperties": false, "type": "object", "required": [ "reason", "expected_revision", "totp_code" ], "title": "EmergencyRevokeRequest" }, "EmergencyRevokeResponse": { "properties": { "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, "enrollment_id": { "type": "string", "title": "Enrollment Id" }, "revoked_at": { "type": "string", "format": "date-time", "title": "Revoked At" }, "sessions_revoked": { "type": "integer", "minimum": 0.0, "title": "Sessions Revoked" }, "challenges_consumed": { "type": "integer", "minimum": 0.0, "title": "Challenges Consumed" }, "grants_revoked": { "type": "integer", "minimum": 0.0, "title": "Grants Revoked" }, "reviews_reassigned": { "type": "integer", "minimum": 0.0, "title": "Reviews Reassigned" }, "notifications_queued": { "type": "integer", "minimum": 0.0, "title": "Notifications Queued" }, "audit_id": { "type": "string", "title": "Audit Id" }, "revision": { "type": "integer", "minimum": 0.0, "title": "Revision" } }, "additionalProperties": false, "type": "object", "required": [ "user_id", "enrollment_id", "revoked_at", "sessions_revoked", "challenges_consumed", "grants_revoked", "reviews_reassigned", "notifications_queued", "audit_id", "revision" ], "title": "EmergencyRevokeResponse" }, "EnableRequest": { "properties": { "reason": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Reason" }, "expected_revision": { "type": "integer", "minimum": 0.0, "title": "Expected Revision" }, "stage": { "type": "string", "enum": [ "internal", "preview", "general" ], "title": "Stage" }, "tenant_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Tenant Ids" }, "confirmation": { "type": "string", "maxLength": 300, "title": "Confirmation" } }, "additionalProperties": false, "type": "object", "required": [ "reason", "expected_revision", "stage", "tenant_ids", "confirmation" ], "title": "EnableRequest" }, "EnableResult": { "properties": { "revision": { "type": "integer", "title": "Revision" }, "release_id": { "type": "string", "title": "Release Id" }, "stage": { "type": "string", "enum": [ "internal", "preview", "general" ], "title": "Stage" }, "job": { "$ref": "#/components/schemas/QualificationJob" } }, "additionalProperties": false, "type": "object", "required": [ "revision", "release_id", "stage", "job" ], "title": "EnableResult" }, "EnvironmentConfig": { "properties": { "language": { "type": "string", "title": "Language", "description": "Runtime preinstalled in the sandbox.", "default": "python" }, "env_vars": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Env Vars", "description": "Environment variables set inside the sandbox." }, "auto_stop_interval": { "type": "integer", "minimum": 0.0, "title": "Auto Stop Interval", "description": "Minutes of inactivity before the sandbox is stopped.", "default": 30 }, "auto_delete_interval": { "type": "integer", "minimum": -1.0, "title": "Auto Delete Interval", "description": "Minutes after stopping before the sandbox is deleted.", "default": 120 }, "requires_sandbox": { "type": "boolean", "title": "Requires Sandbox", "description": "Whether agents using this environment require a provisioned sandbox.", "default": true } }, "type": "object", "title": "EnvironmentConfig", "description": "What selecting this environment changes about a session.\n\nEvery field here reaches the sandbox provider or the session policy. Fields\nthat named an image, a CPU count, a memory or disk size, or a region used to\nsit here and were never read by anything, so they have been removed rather\nthan left looking like controls." }, "EnvironmentListResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/EnvironmentResponse" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "EnvironmentListResponse" }, "EnvironmentResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "provider": { "type": "string", "title": "Provider" }, "config": { "additionalProperties": true, "type": "object", "title": "Config" }, "status": { "type": "string", "title": "Status", "default": "ready" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "required": [ "id", "name", "provider" ], "title": "EnvironmentResponse" }, "EvaluationReceipt-Input": { "properties": { "dataset_id": { "type": "string", "title": "Dataset Id" }, "dataset_hash": { "type": "string", "title": "Dataset Hash" }, "model_version": { "type": "string", "title": "Model Version" }, "checker_implementation_hash": { "type": "string", "title": "Checker Implementation Hash" }, "case_count": { "type": "integer", "minimum": 40.0, "title": "Case Count" }, "bad_cases": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Bad Cases" }, "good_cases": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Good Cases" }, "false_acceptances": { "type": "integer", "minimum": 0.0, "title": "False Acceptances" }, "false_rejections": { "type": "integer", "minimum": 0.0, "title": "False Rejections" }, "false_acceptance_rate": { "type": "number", "title": "False Acceptance Rate" }, "false_rejection_rate": { "type": "number", "title": "False Rejection Rate" }, "max_false_acceptance_rate": { "type": "number", "title": "Max False Acceptance Rate", "default": 0.05 }, "max_false_rejection_rate": { "type": "number", "title": "Max False Rejection Rate", "default": 0.1 }, "source_latency_ms": { "additionalProperties": { "type": "number" }, "type": "object", "title": "Source Latency Ms" }, "turn_latency_ms": { "additionalProperties": { "type": "number" }, "type": "object", "title": "Turn Latency Ms" }, "input_tokens": { "type": "integer", "title": "Input Tokens" }, "output_tokens": { "type": "integer", "title": "Output Tokens" }, "estimated_usd": { "anyOf": [ { "type": "number" }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" } ], "title": "Estimated Usd" }, "includes_parallel_checks": { "type": "boolean", "title": "Includes Parallel Checks" }, "includes_retries": { "type": "boolean", "title": "Includes Retries" }, "includes_synthesis": { "type": "boolean", "title": "Includes Synthesis" }, "source_deadline_seconds": { "type": "integer", "title": "Source Deadline Seconds", "default": 15 }, "turn_deadline_seconds": { "type": "integer", "title": "Turn Deadline Seconds", "default": 90 }, "budget_check_passed": { "type": "boolean", "title": "Budget Check Passed" }, "passed": { "type": "boolean", "title": "Passed" }, "measured_at": { "type": "string", "format": "date-time", "title": "Measured At" } }, "additionalProperties": false, "type": "object", "required": [ "dataset_id", "dataset_hash", "model_version", "checker_implementation_hash", "case_count", "bad_cases", "good_cases", "false_acceptances", "false_rejections", "false_acceptance_rate", "false_rejection_rate", "source_latency_ms", "turn_latency_ms", "input_tokens", "output_tokens", "estimated_usd", "includes_parallel_checks", "includes_retries", "includes_synthesis", "budget_check_passed", "passed", "measured_at" ], "title": "EvaluationReceipt" }, "EvaluationReceipt-Output": { "properties": { "dataset_id": { "type": "string", "title": "Dataset Id" }, "dataset_hash": { "type": "string", "title": "Dataset Hash" }, "model_version": { "type": "string", "title": "Model Version" }, "checker_implementation_hash": { "type": "string", "title": "Checker Implementation Hash" }, "case_count": { "type": "integer", "minimum": 40.0, "title": "Case Count" }, "bad_cases": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Bad Cases" }, "good_cases": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Good Cases" }, "false_acceptances": { "type": "integer", "minimum": 0.0, "title": "False Acceptances" }, "false_rejections": { "type": "integer", "minimum": 0.0, "title": "False Rejections" }, "false_acceptance_rate": { "type": "number", "title": "False Acceptance Rate" }, "false_rejection_rate": { "type": "number", "title": "False Rejection Rate" }, "max_false_acceptance_rate": { "type": "number", "title": "Max False Acceptance Rate", "default": 0.05 }, "max_false_rejection_rate": { "type": "number", "title": "Max False Rejection Rate", "default": 0.1 }, "source_latency_ms": { "additionalProperties": { "type": "number" }, "type": "object", "title": "Source Latency Ms" }, "turn_latency_ms": { "additionalProperties": { "type": "number" }, "type": "object", "title": "Turn Latency Ms" }, "input_tokens": { "type": "integer", "title": "Input Tokens" }, "output_tokens": { "type": "integer", "title": "Output Tokens" }, "estimated_usd": { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Estimated Usd" }, "includes_parallel_checks": { "type": "boolean", "title": "Includes Parallel Checks" }, "includes_retries": { "type": "boolean", "title": "Includes Retries" }, "includes_synthesis": { "type": "boolean", "title": "Includes Synthesis" }, "source_deadline_seconds": { "type": "integer", "title": "Source Deadline Seconds", "default": 15 }, "turn_deadline_seconds": { "type": "integer", "title": "Turn Deadline Seconds", "default": 90 }, "budget_check_passed": { "type": "boolean", "title": "Budget Check Passed" }, "passed": { "type": "boolean", "title": "Passed" }, "measured_at": { "type": "string", "format": "date-time", "title": "Measured At" } }, "additionalProperties": false, "type": "object", "required": [ "dataset_id", "dataset_hash", "model_version", "checker_implementation_hash", "case_count", "bad_cases", "good_cases", "false_acceptances", "false_rejections", "false_acceptance_rate", "false_rejection_rate", "source_latency_ms", "turn_latency_ms", "input_tokens", "output_tokens", "estimated_usd", "includes_parallel_checks", "includes_retries", "includes_synthesis", "budget_check_passed", "passed", "measured_at" ], "title": "EvaluationReceipt" }, "EventContent": { "properties": { "type": { "type": "string", "title": "Type" }, "text": { "title": "Text" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "EventContent" }, "EventListResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/EventResponse" }, "type": "array", "title": "Data" }, "next_page": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next Page" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "type": "object", "required": [ "data" ], "title": "EventListResponse" }, "EventMetadata": { "properties": { "id": { "type": "string", "title": "Id" }, "session_id": { "type": "string", "format": "uuid", "title": "Session Id" }, "run_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Run Id" }, "sequence": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sequence" }, "type": { "type": "string", "title": "Type" }, "tool_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tool Name" }, "byte_size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Byte Size" }, "input_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Input Tokens" }, "output_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Output Tokens" }, "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Code" }, "content_hash": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content Hash" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "additionalProperties": false, "type": "object", "required": [ "id", "session_id", "run_id", "sequence", "type", "tool_name", "byte_size", "input_tokens", "output_tokens", "error_code", "content_hash", "created_at" ], "title": "EventMetadata", "description": "Spec section 7: metadata only. Never content, inputs, outputs, titles or URLs." }, "EventPresent": { "properties": { "kind": { "type": "string", "const": "event_present", "title": "Kind" }, "type": { "type": "string", "minLength": 1, "title": "Type" } }, "additionalProperties": false, "type": "object", "required": [ "kind", "type" ], "title": "EventPresent" }, "EventResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "type": { "type": "string", "title": "Type", "description": "Event type. stream.resync is an ephemeral terminal signal that tells the client to reconnect and re-read the persisted session event stream." }, "content": { "anyOf": [ { "items": { "$ref": "#/components/schemas/EventContent" }, "type": "array" }, { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Content", "description": "Text events use a list of content blocks. Tool, run, session, and application-tool events use a JSON object." }, "parent_event_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Event Id" }, "run_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Run Id" }, "model_used": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Used" }, "seq": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Seq" }, "metadata": { "additionalProperties": true, "type": "object", "title": "Metadata" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "sequence": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sequence" }, "workspace_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" }, "session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Session Id" }, "in_reply_to_event_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "In Reply To Event Id" }, "data": { "title": "Data" } }, "type": "object", "required": [ "id", "type" ], "title": "EventResponse", "examples": [ { "content": { "model": "openai/gpt-5", "run_id": "run_123" }, "id": "evt_run_started", "type": "run.started" }, { "content": { "execution_idempotency_key": "evt_custom_tool", "input": { "operations": [ { "op": "add", "title": "Buy milk" } ] }, "name": "todo_ops", "pending_input_id": "5d1a4608909bd2230f0c39e6f0b4875b", "tool_call_id": "call_123" }, "id": "evt_tool_started", "type": "tool.started" }, { "content": { "name": "todo_ops", "output": { "applied": true }, "pending_input_id": "5d1a4608909bd2230f0c39e6f0b4875b", "tool_call_id": "call_123" }, "id": "evt_tool_completed", "type": "tool.completed" }, { "content": { "error": "Application tool failed", "name": "todo_ops", "tool_call_id": "call_123" }, "id": "evt_tool_failed", "type": "tool.failed" }, { "content": { "input": { "operations": [ { "op": "add", "title": "Buy milk" } ] }, "name": "todo_ops", "tool_call_id": "call_123" }, "id": "evt_custom_tool", "type": "agent.custom_tool_use" }, { "content": { "stop_reason": { "event_ids": [ "evt_custom_tool" ], "type": "requires_action" } }, "id": "evt_idle", "type": "session.status_idle" } ] }, "Events": { "properties": { "data": { "items": { "oneOf": [ { "$ref": "#/components/schemas/EvidenceEvent" }, { "$ref": "#/components/schemas/CheckerEvent" }, { "$ref": "#/components/schemas/ActionEvent" }, { "$ref": "#/components/schemas/CompletedEvent" }, { "$ref": "#/components/schemas/FailedEvent" }, { "$ref": "#/components/schemas/CancelledEvent" }, { "$ref": "#/components/schemas/DeltaEvent" }, { "$ref": "#/components/schemas/ResyncEvent" } ], "discriminator": { "propertyName": "type", "mapping": { "assistant.action": "#/components/schemas/ActionEvent", "assistant.cancelled": "#/components/schemas/CancelledEvent", "assistant.checker": "#/components/schemas/CheckerEvent", "assistant.completed": "#/components/schemas/CompletedEvent", "assistant.delta": "#/components/schemas/DeltaEvent", "assistant.evidence": "#/components/schemas/EvidenceEvent", "assistant.failed": "#/components/schemas/FailedEvent", "stream.resync": "#/components/schemas/ResyncEvent" } } }, "type": "array", "title": "Data" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "data", "next_cursor" ], "title": "Events" }, "EvidenceData": { "properties": { "graph_id": { "type": "string", "title": "Graph Id" }, "node_id": { "type": "string", "title": "Node Id" }, "attempt_id": { "type": "string", "title": "Attempt Id" }, "source": { "$ref": "#/components/schemas/SourceReference" }, "coverage": { "$ref": "#/components/schemas/openapi__bami_foundation__Coverage" }, "decision_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Decision Id" }, "usable": { "type": "boolean", "title": "Usable" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "late": { "type": "boolean", "title": "Late" }, "excerpt": { "anyOf": [ { "$ref": "#/components/schemas/ReplyExcerpt" }, { "type": "null" } ], "description": "Reply excerpt for a session_run evidence event. Optional and never required: null when the source carries no reply text, and absent from events recorded before contract version 5. The served response schema omits the null default that the frozen Bami component states; both leave excerpt out of required, so read it as absent or null." } }, "additionalProperties": false, "type": "object", "required": [ "graph_id", "node_id", "attempt_id", "source", "coverage", "decision_id", "usable", "reason", "late" ], "title": "EvidenceData" }, "EvidenceEvent": { "properties": { "id": { "type": "string", "title": "Id" }, "sequence": { "type": "integer", "minimum": 1.0, "title": "Sequence" }, "conversation_id": { "type": "string", "title": "Conversation Id" }, "run_id": { "type": "string", "format": "uuid", "title": "Run Id" }, "request_id": { "type": "string", "title": "Request Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "late": { "type": "boolean", "title": "Late" }, "usable_as_evidence": { "type": "boolean", "title": "Usable As Evidence" }, "type": { "type": "string", "const": "assistant.evidence", "title": "Type" }, "data": { "$ref": "#/components/schemas/EvidenceData" } }, "additionalProperties": false, "type": "object", "required": [ "id", "sequence", "conversation_id", "run_id", "request_id", "created_at", "late", "usable_as_evidence", "type", "data" ], "title": "EvidenceEvent" }, "ExecutorDeclaration": { "properties": { "tool_id": { "type": "string", "title": "Tool Id" }, "tool_definition_id": { "type": "string", "title": "Tool Definition Id" }, "definition_hash": { "type": "string", "title": "Definition Hash" }, "mode": { "type": "string", "enum": [ "application_live", "stubbed" ], "title": "Mode" }, "stub": { "anyOf": [ { "$ref": "#/components/schemas/ToolStub" }, { "type": "null" } ] }, "consequential": { "type": "boolean", "const": false, "title": "Consequential", "default": false } }, "additionalProperties": false, "type": "object", "required": [ "tool_id", "tool_definition_id", "definition_hash", "mode", "stub" ], "title": "ExecutorDeclaration" }, "ExtendTtlRequest": { "properties": { "minutes": { "type": "integer", "title": "Minutes", "default": 10 } }, "type": "object", "title": "ExtendTtlRequest", "description": "Request model for extending sandbox TTL." }, "ExtendTtlResponse": { "properties": { "status": { "type": "string", "title": "Status" }, "expires_in_minutes": { "type": "integer", "title": "Expires In Minutes" } }, "type": "object", "required": [ "status", "expires_in_minutes" ], "title": "ExtendTtlResponse", "description": "Response model for TTL extension." }, "FailedData": { "properties": { "graph_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Graph Id" }, "receipt_id": { "type": "string", "title": "Receipt Id" }, "code": { "type": "string", "title": "Code" }, "reason": { "type": "string", "title": "Reason" }, "retryable": { "type": "boolean", "title": "Retryable" }, "outcome": { "type": "string", "enum": [ "failed", "timed_out" ], "title": "Outcome" } }, "additionalProperties": false, "type": "object", "required": [ "graph_id", "receipt_id", "code", "reason", "retryable", "outcome" ], "title": "FailedData" }, "FailedEvent": { "properties": { "id": { "type": "string", "title": "Id" }, "sequence": { "type": "integer", "minimum": 1.0, "title": "Sequence" }, "conversation_id": { "type": "string", "title": "Conversation Id" }, "run_id": { "type": "string", "format": "uuid", "title": "Run Id" }, "request_id": { "type": "string", "title": "Request Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "late": { "type": "boolean", "title": "Late" }, "usable_as_evidence": { "type": "boolean", "title": "Usable As Evidence" }, "type": { "type": "string", "const": "assistant.failed", "title": "Type" }, "data": { "$ref": "#/components/schemas/FailedData" } }, "additionalProperties": false, "type": "object", "required": [ "id", "sequence", "conversation_id", "run_id", "request_id", "created_at", "late", "usable_as_evidence", "type", "data" ], "title": "FailedEvent" }, "FailureCount": { "properties": { "count": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Count" }, "unavailable_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unavailable Reason" } }, "additionalProperties": false, "type": "object", "required": [ "count", "unavailable_reason" ], "title": "FailureCount" }, "FileInfo": { "properties": { "path": { "type": "string", "title": "Path" }, "size": { "type": "integer", "title": "Size" }, "modified_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Modified At" } }, "type": "object", "required": [ "path", "size" ], "title": "FileInfo", "description": "File metadata." }, "FileListResponse": { "properties": { "files": { "items": { "$ref": "#/components/schemas/FileInfo" }, "type": "array", "title": "Files" } }, "type": "object", "title": "FileListResponse", "description": "Response model for file listing." }, "FileUploadResponse": { "properties": { "path": { "type": "string", "title": "Path" }, "size": { "type": "integer", "title": "Size" }, "content_type": { "type": "string", "title": "Content Type", "default": "application/octet-stream" } }, "type": "object", "required": [ "path", "size" ], "title": "FileUploadResponse", "description": "Response model for file upload." }, "FinalTextContains": { "properties": { "kind": { "type": "string", "const": "final_text_contains", "title": "Kind" }, "text": { "type": "string", "minLength": 1, "title": "Text" } }, "additionalProperties": false, "type": "object", "required": [ "kind", "text" ], "title": "FinalTextContains" }, "FinalTextMatches": { "properties": { "kind": { "type": "string", "const": "final_text_matches", "title": "Kind" }, "regex": { "type": "string", "title": "Regex" } }, "additionalProperties": false, "type": "object", "required": [ "kind", "regex" ], "title": "FinalTextMatches" }, "GlobalSettingsPatch-Input": { "properties": { "enabled": { "type": "boolean", "title": "Enabled" }, "tenant_enabled_default": { "type": "boolean", "title": "Tenant Enabled Default" }, "jev_enabled": { "type": "boolean", "title": "Jev Enabled" }, "model_version": { "type": "string", "title": "Model Version" }, "fallback_enabled": { "type": "boolean", "const": false, "title": "Fallback Enabled" }, "release_id": { "type": "string", "title": "Release Id" }, "max_tool_calls_per_turn": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Max Tool Calls Per Turn" }, "max_concurrent_tool_calls": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Max Concurrent Tool Calls" }, "source_deadline_seconds": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Source Deadline Seconds" }, "turn_deadline_seconds": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Turn Deadline Seconds" }, "max_active_per_conversation": { "type": "integer", "const": 1, "title": "Max Active Per Conversation" }, "max_active_per_user": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Max Active Per User" }, "max_active_per_tenant": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Max Active Per Tenant" }, "max_active_global": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Max Active Global" }, "messages_per_minute": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Messages Per Minute" }, "messages_per_day": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Messages Per Day" }, "tenant_daily_tokens": { "type": "integer", "minimum": 0.0, "title": "Tenant Daily Tokens" }, "tenant_daily_usd": { "anyOf": [ { "type": "number", "minimum": 0.0 }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" } ], "title": "Tenant Daily Usd" }, "global_daily_tokens": { "type": "integer", "minimum": 0.0, "title": "Global Daily Tokens" }, "global_daily_usd": { "anyOf": [ { "type": "number", "minimum": 0.0 }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" } ], "title": "Global Daily Usd" }, "budget_alert_percent": { "type": "integer", "maximum": 100.0, "minimum": 1.0, "title": "Budget Alert Percent" }, "content_retention_days": { "type": "integer", "maximum": 90.0, "minimum": 1.0, "title": "Content Retention Days" }, "control_poll_seconds": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Control Poll Seconds" }, "retention_sweep_seconds": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Retention Sweep Seconds" }, "admin_session_ttl_seconds": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Admin Session Ttl Seconds" }, "admin_enrolled_user_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Admin Enrolled User Ids" }, "checker_min_cases": { "type": "integer", "minimum": 40.0, "title": "Checker Min Cases" }, "checker_max_false_acceptance": { "anyOf": [ { "type": "number", "maximum": 0.05, "minimum": 0.0 }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" } ], "title": "Checker Max False Acceptance" }, "checker_max_false_rejection": { "anyOf": [ { "type": "number", "maximum": 0.1, "minimum": 0.0 }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" } ], "title": "Checker Max False Rejection" }, "action_activate_enabled": { "type": "boolean", "title": "Action Activate Enabled" }, "action_delete_enabled": { "type": "boolean", "title": "Action Delete Enabled" }, "action_deprecate_enabled": { "type": "boolean", "title": "Action Deprecate Enabled" } }, "additionalProperties": false, "type": "object", "title": "GlobalSettingsPatch" }, "GlobalSettingsPatch-Output": { "properties": { "enabled": { "type": "boolean", "title": "Enabled" }, "tenant_enabled_default": { "type": "boolean", "title": "Tenant Enabled Default" }, "jev_enabled": { "type": "boolean", "title": "Jev Enabled" }, "model_version": { "type": "string", "title": "Model Version" }, "fallback_enabled": { "type": "boolean", "const": false, "title": "Fallback Enabled" }, "release_id": { "type": "string", "title": "Release Id" }, "max_tool_calls_per_turn": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Max Tool Calls Per Turn" }, "max_concurrent_tool_calls": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Max Concurrent Tool Calls" }, "source_deadline_seconds": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Source Deadline Seconds" }, "turn_deadline_seconds": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Turn Deadline Seconds" }, "max_active_per_conversation": { "type": "integer", "const": 1, "title": "Max Active Per Conversation" }, "max_active_per_user": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Max Active Per User" }, "max_active_per_tenant": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Max Active Per Tenant" }, "max_active_global": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Max Active Global" }, "messages_per_minute": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Messages Per Minute" }, "messages_per_day": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Messages Per Day" }, "tenant_daily_tokens": { "type": "integer", "minimum": 0.0, "title": "Tenant Daily Tokens" }, "tenant_daily_usd": { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Tenant Daily Usd" }, "global_daily_tokens": { "type": "integer", "minimum": 0.0, "title": "Global Daily Tokens" }, "global_daily_usd": { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Global Daily Usd" }, "budget_alert_percent": { "type": "integer", "maximum": 100.0, "minimum": 1.0, "title": "Budget Alert Percent" }, "content_retention_days": { "type": "integer", "maximum": 90.0, "minimum": 1.0, "title": "Content Retention Days" }, "control_poll_seconds": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Control Poll Seconds" }, "retention_sweep_seconds": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Retention Sweep Seconds" }, "admin_session_ttl_seconds": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Admin Session Ttl Seconds" }, "admin_enrolled_user_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Admin Enrolled User Ids" }, "checker_min_cases": { "type": "integer", "minimum": 40.0, "title": "Checker Min Cases" }, "checker_max_false_acceptance": { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Checker Max False Acceptance" }, "checker_max_false_rejection": { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Checker Max False Rejection" }, "action_activate_enabled": { "type": "boolean", "title": "Action Activate Enabled" }, "action_delete_enabled": { "type": "boolean", "title": "Action Delete Enabled" }, "action_deprecate_enabled": { "type": "boolean", "title": "Action Deprecate Enabled" } }, "additionalProperties": false, "type": "object", "title": "GlobalSettingsPatch" }, "GlobalSettingsResponse": { "properties": { "revision": { "type": "integer", "minimum": 0.0, "title": "Revision" }, "settings": { "$ref": "#/components/schemas/GlobalSettingsPatch-Output" }, "effective_settings": { "$ref": "#/components/schemas/Settings" } }, "additionalProperties": false, "type": "object", "required": [ "revision", "settings", "effective_settings" ], "title": "GlobalSettingsResponse" }, "GlobalUpdate": { "properties": { "reason": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Reason" }, "expected_revision": { "type": "integer", "minimum": 0.0, "title": "Expected Revision" }, "settings": { "$ref": "#/components/schemas/GlobalSettingsPatch-Input" } }, "additionalProperties": false, "type": "object", "required": [ "reason", "expected_revision", "settings" ], "title": "GlobalUpdate" }, "GrantCreate": { "properties": { "reason": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Reason" }, "expected_revision": { "type": "integer", "minimum": 0.0, "title": "Expected Revision" }, "grantee_id": { "type": "string", "format": "uuid", "title": "Grantee Id" }, "conversation_id": { "type": "string", "maxLength": 64, "minLength": 1, "title": "Conversation Id" }, "purpose": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Purpose" }, "consent_reference": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Consent Reference" }, "legal_obligation_reference": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Legal Obligation Reference" }, "notification_prohibited_reference": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Notification Prohibited Reference" } }, "additionalProperties": false, "type": "object", "required": [ "reason", "expected_revision", "grantee_id", "conversation_id", "purpose", "consent_reference", "legal_obligation_reference", "notification_prohibited_reference" ], "title": "GrantCreate" }, "Graph": { "properties": { "id": { "type": "string", "title": "Id" }, "conversation_id": { "type": "string", "title": "Conversation Id" }, "run_id": { "type": "string", "format": "uuid", "title": "Run Id" }, "request_id": { "type": "string", "title": "Request Id" }, "version": { "type": "integer", "const": 1, "title": "Version" }, "scope_generation": { "type": "integer", "title": "Scope Generation" }, "target": { "$ref": "#/components/schemas/Scope" }, "target_coverage": { "$ref": "#/components/schemas/openapi__bami_foundation__Coverage" }, "limits": { "$ref": "#/components/schemas/TurnLimits" }, "release_id": { "type": "string", "title": "Release Id" }, "model_version": { "type": "string", "title": "Model Version" }, "status": { "type": "string", "title": "Status" }, "source_deadline_seconds": { "type": "integer", "title": "Source Deadline Seconds" }, "turn_deadline_at": { "type": "string", "format": "date-time", "title": "Turn Deadline At" }, "nodes": { "items": { "$ref": "#/components/schemas/Node" }, "type": "array", "title": "Nodes" }, "optional_round": { "$ref": "#/components/schemas/OptionalRound" }, "synthesis": { "anyOf": [ { "$ref": "#/components/schemas/Synthesis" }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At" }, "expires_at": { "type": "string", "format": "date-time", "title": "Expires At" } }, "additionalProperties": false, "type": "object", "required": [ "id", "conversation_id", "run_id", "request_id", "version", "scope_generation", "target", "target_coverage", "limits", "release_id", "model_version", "status", "source_deadline_seconds", "turn_deadline_at", "nodes", "optional_round", "synthesis", "created_at", "completed_at", "expires_at" ], "title": "Graph" }, "GraphPage": { "properties": { "data": { "items": { "$ref": "#/components/schemas/GraphReference" }, "type": "array", "title": "Data" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "data", "next_cursor" ], "title": "GraphPage" }, "GraphReference": { "properties": { "id": { "type": "string", "title": "Id" }, "run_id": { "type": "string", "format": "uuid", "title": "Run Id" }, "version": { "type": "integer", "const": 1, "title": "Version" }, "status": { "type": "string", "title": "Status" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "expires_at": { "type": "string", "format": "date-time", "title": "Expires At" } }, "additionalProperties": false, "type": "object", "required": [ "id", "run_id", "version", "status", "created_at", "expires_at" ], "title": "GraphReference" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "Health": { "properties": { "period": { "$ref": "#/components/schemas/Period" }, "runs": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Runs" }, "failures": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Failures" }, "waiting": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Waiting" }, "input_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Input Tokens" }, "output_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Output Tokens" }, "elapsed_p50_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Elapsed P50 Ms" }, "elapsed_p95_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Elapsed P95 Ms" }, "elapsed_sample_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Elapsed Sample Count" }, "elapsed_note": { "type": "string", "title": "Elapsed Note" }, "unavailable_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unavailable Reason" } }, "additionalProperties": false, "type": "object", "required": [ "period", "runs", "failures", "waiting", "input_tokens", "output_tokens", "elapsed_p50_ms", "elapsed_p95_ms", "elapsed_sample_count", "elapsed_note", "unavailable_reason" ], "title": "Health" }, "HealthComponent": { "properties": { "component": { "type": "string", "enum": [ "api", "database", "worker", "provider", "notification_delivery" ], "title": "Component" }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Region" }, "status": { "type": "string", "enum": [ "ok", "degraded", "down", "unknown" ], "title": "Status" }, "availability": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Availability" }, "latency_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Latency Ms" }, "heartbeat_age_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Heartbeat Age Seconds" }, "queue_depth": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Queue Depth" }, "error_rate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Rate" }, "sample_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sample Count" }, "window_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Window Seconds" }, "observed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Observed At" }, "freshness": { "type": "string", "enum": [ "fresh", "stale", "unknown" ], "title": "Freshness" }, "unavailable_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unavailable Reason" } }, "additionalProperties": false, "type": "object", "required": [ "component", "region", "status", "availability", "latency_ms", "heartbeat_age_seconds", "queue_depth", "error_rate", "sample_count", "window_seconds", "observed_at", "freshness", "unavailable_reason" ], "title": "HealthComponent" }, "HealthResponse": { "properties": { "status": { "type": "string", "enum": [ "ok", "degraded", "down", "unknown" ], "title": "Status" }, "components": { "items": { "$ref": "#/components/schemas/HealthComponent" }, "type": "array", "title": "Components" }, "attention": { "$ref": "#/components/schemas/AttentionCounts" }, "incidents": { "$ref": "#/components/schemas/IncidentCounts" }, "monitoring": { "$ref": "#/components/schemas/Monitoring" }, "observed_at": { "type": "string", "format": "date-time", "title": "Observed At" }, "coverage": { "$ref": "#/components/schemas/app__modules__operator_console__console_schema__Coverage" } }, "additionalProperties": false, "type": "object", "required": [ "status", "components", "attention", "incidents", "monitoring", "observed_at", "coverage" ], "title": "HealthResponse" }, "IncidentCounts": { "properties": { "open": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Open" }, "monitoring": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Monitoring" }, "unavailable_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unavailable Reason" } }, "additionalProperties": false, "type": "object", "required": [ "open", "monitoring", "unavailable_reason" ], "title": "IncidentCounts" }, "IncidentFeed": { "properties": { "active": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Active", "description": "Active incidents, or null when the source failed." }, "items": { "items": { "$ref": "#/components/schemas/IncidentSummary" }, "type": "array", "title": "Items" }, "unavailable_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unavailable Reason" } }, "type": "object", "required": [ "active" ], "title": "IncidentFeed" }, "IncidentOut": { "properties": { "id": { "type": "string", "title": "Id" }, "component": { "type": "string", "title": "Component" }, "severity": { "type": "string", "enum": [ "critical", "warning", "info" ], "title": "Severity" }, "status": { "type": "string", "enum": [ "open", "monitoring", "resolved" ], "title": "Status" }, "summary": { "type": "string", "title": "Summary" }, "attention_item_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Attention Item Id" }, "workspace_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Workspace Id" }, "owner_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Owner Id" }, "owner_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner Label" }, "next_update_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Next Update At" }, "next_update_overdue": { "type": "boolean", "title": "Next Update Overdue" }, "affected_tenant_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Affected Tenant Count" }, "started_at": { "type": "string", "format": "date-time", "title": "Started At" }, "resolved_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Resolved At" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" } }, "additionalProperties": false, "type": "object", "required": [ "id", "component", "severity", "status", "summary", "attention_item_id", "workspace_id", "owner_id", "owner_label", "next_update_at", "next_update_overdue", "affected_tenant_count", "started_at", "resolved_at", "created_at", "updated_at" ], "title": "IncidentOut" }, "IncidentPage": { "properties": { "data": { "items": { "$ref": "#/components/schemas/IncidentOut" }, "type": "array", "title": "Data" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "observed_at": { "type": "string", "format": "date-time", "title": "Observed At" }, "coverage": { "$ref": "#/components/schemas/app__modules__operator_console__console_schema__Coverage" } }, "additionalProperties": false, "type": "object", "required": [ "data", "next_cursor", "observed_at", "coverage" ], "title": "IncidentPage" }, "IncidentSummary": { "properties": { "id": { "type": "string", "title": "Id" }, "component": { "type": "string", "title": "Component" }, "severity": { "type": "string", "enum": [ "critical", "warning", "info" ], "title": "Severity" }, "status": { "type": "string", "enum": [ "open", "monitoring", "resolved" ], "title": "Status" }, "summary": { "type": "string", "title": "Summary" }, "started_at": { "type": "string", "format": "date-time", "title": "Started At" }, "next_update_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Next Update At" }, "resolved_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Resolved At" } }, "type": "object", "required": [ "id", "component", "severity", "status", "summary", "started_at" ], "title": "IncidentSummary", "description": "Customer safe incident entry for the status page (no owner, workspace or logs)." }, "InputPathEquals": { "properties": { "path": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*(?:\\[[0-9]+\\])*(?:\\.[A-Za-z_][A-Za-z0-9_]*(?:\\[[0-9]+\\])*)*$", "title": "Path" }, "equals": { "$ref": "#/components/schemas/JsonValue" } }, "additionalProperties": false, "type": "object", "required": [ "path", "equals" ], "title": "InputPathEquals" }, "JsonPathEquals": { "properties": { "kind": { "type": "string", "const": "json_path_equals", "title": "Kind" }, "path": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*(?:\\[[0-9]+\\])*(?:\\.[A-Za-z_][A-Za-z0-9_]*(?:\\[[0-9]+\\])*)*$", "title": "Path" }, "equals": { "$ref": "#/components/schemas/JsonValue" } }, "additionalProperties": false, "type": "object", "required": [ "kind", "path", "equals" ], "title": "JsonPathEquals" }, "JsonValue": {}, "KeyCreateRequest": { "properties": { "name": { "type": "string", "maxLength": 100, "minLength": 1, "title": "Name" }, "scopes": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 15 }, { "type": "null" } ], "title": "Scopes" }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Expires At" } }, "type": "object", "required": [ "name" ], "title": "KeyCreateRequest" }, "KeyCreateResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "prefix": { "type": "string", "title": "Prefix" }, "scopes": { "items": { "type": "string" }, "type": "array", "title": "Scopes" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Expires At" }, "secret": { "type": "string", "title": "Secret" } }, "type": "object", "required": [ "id", "name", "prefix", "scopes", "created_at", "expires_at", "secret" ], "title": "KeyCreateResponse" }, "KeyItem": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "prefix": { "type": "string", "title": "Prefix" }, "scopes": { "items": { "type": "string" }, "type": "array", "title": "Scopes" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Expires At" }, "last_used_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Used At" }, "revoked_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Revoked At" } }, "type": "object", "required": [ "id", "name", "prefix", "scopes", "created_at", "expires_at", "last_used_at", "revoked_at" ], "title": "KeyItem" }, "KeyListResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/KeyItem" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "items" ], "title": "KeyListResponse" }, "KeyOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "tenant_id": { "type": "string", "format": "uuid", "title": "Tenant Id" }, "public_key_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Public Key Id" }, "scopes": { "items": { "type": "string" }, "type": "array", "title": "Scopes" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Expires At" }, "last_used_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Used At" }, "revoked_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Revoked At" }, "status": { "type": "string", "enum": [ "active", "expired", "revoked" ], "title": "Status" } }, "additionalProperties": false, "type": "object", "required": [ "id", "name", "tenant_id", "public_key_id", "scopes", "created_at", "expires_at", "last_used_at", "revoked_at", "status" ], "title": "KeyOut" }, "KeyPage": { "properties": { "data": { "items": { "$ref": "#/components/schemas/KeyOut" }, "type": "array", "title": "Data" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "observed_at": { "type": "string", "format": "date-time", "title": "Observed At" }, "coverage": { "$ref": "#/components/schemas/app__modules__operator_console__console_schema__Coverage" } }, "additionalProperties": false, "type": "object", "required": [ "data", "next_cursor", "observed_at", "coverage" ], "title": "KeyPage" }, "KeyRevokeResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "revoked_at": { "type": "string", "format": "date-time", "title": "Revoked At" }, "receipt_id": { "type": "string", "title": "Receipt Id" }, "audit_id": { "type": "string", "title": "Audit Id" }, "revision": { "type": "integer", "minimum": 0.0, "title": "Revision" } }, "additionalProperties": false, "type": "object", "required": [ "id", "revoked_at", "receipt_id", "audit_id", "revision" ], "title": "KeyRevokeResponse" }, "KillReceipt": { "properties": { "id": { "type": "string", "title": "Id" }, "revision": { "type": "integer", "minimum": 0.0, "title": "Revision" }, "tenant_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Tenant Id" }, "stop_generation": { "type": "integer", "minimum": 0.0, "title": "Stop Generation" }, "admission_stopped_at": { "type": "string", "format": "date-time", "title": "Admission Stopped At" }, "status": { "type": "string", "enum": [ "cancelling", "cancelled" ], "title": "Status" }, "cancellation_receipt_ids": { "items": { "type": "string" }, "type": "array", "title": "Cancellation Receipt Ids" }, "pending_run_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Pending Run Ids" }, "action": { "anyOf": [ { "type": "string", "enum": [ "activate", "delete", "deprecate" ] }, { "type": "null" } ], "title": "Action" }, "pending_approval_ids": { "items": { "type": "string" }, "type": "array", "title": "Pending Approval Ids" } }, "additionalProperties": false, "type": "object", "required": [ "id", "revision", "tenant_id", "stop_generation", "admission_stopped_at", "status", "cancellation_receipt_ids", "pending_run_ids" ], "title": "KillReceipt" }, "KillRequest": { "properties": { "reason": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Reason" }, "expected_revision": { "type": "integer", "minimum": 0.0, "title": "Expected Revision" }, "tenant_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Tenant Id" }, "action": { "anyOf": [ { "type": "string", "enum": [ "activate", "delete", "deprecate" ] }, { "type": "null" } ], "title": "Action" } }, "additionalProperties": false, "type": "object", "required": [ "reason", "expected_revision", "tenant_id" ], "title": "KillRequest" }, "LatencyComponent": { "properties": { "status": { "type": "string", "enum": [ "ok", "degraded", "down", "unconfigured" ], "title": "Status" }, "latency_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Latency Ms" } }, "type": "object", "required": [ "status" ], "title": "LatencyComponent" }, "LatencyPercentiles": { "properties": { "p50": { "anyOf": [ { "type": "number", "minimum": 0.0 }, { "type": "null" } ], "title": "P50" }, "p90": { "anyOf": [ { "type": "number", "minimum": 0.0 }, { "type": "null" } ], "title": "P90" }, "p95": { "anyOf": [ { "type": "number", "minimum": 0.0 }, { "type": "null" } ], "title": "P95" }, "p99": { "anyOf": [ { "type": "number", "minimum": 0.0 }, { "type": "null" } ], "title": "P99" } }, "additionalProperties": false, "type": "object", "required": [ "p50", "p90", "p95", "p99" ], "title": "LatencyPercentiles" }, "Limit": { "properties": { "name": { "type": "string", "title": "Name" }, "effective_value": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Effective Value" }, "source": { "type": "string", "enum": [ "inherited", "overridden" ], "title": "Source" }, "window": { "type": "string", "title": "Window" }, "resets_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Resets At" }, "enforcement": { "type": "string", "enum": [ "hard_refusal", "soft_alert", "informational" ], "title": "Enforcement" }, "containment_capable": { "type": "boolean", "title": "Containment Capable" }, "editable": { "type": "boolean", "title": "Editable" }, "platform_value": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Platform Value" } }, "additionalProperties": false, "type": "object", "required": [ "name", "effective_value", "source", "window", "resets_at", "enforcement", "containment_capable", "editable", "platform_value" ], "title": "Limit" }, "LimitsPatch": { "properties": { "sessions_per_minute": { "anyOf": [ { "type": "integer", "minimum": 1.0 }, { "type": "null" } ], "title": "Sessions Per Minute" }, "runs_per_minute": { "anyOf": [ { "type": "integer", "minimum": 1.0 }, { "type": "null" } ], "title": "Runs Per Minute" }, "events_per_minute": { "anyOf": [ { "type": "integer", "minimum": 1.0 }, { "type": "null" } ], "title": "Events Per Minute" } }, "additionalProperties": false, "type": "object", "title": "LimitsPatch" }, "LimitsRequest": { "properties": { "reason": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Reason" }, "expected_revision": { "type": "integer", "minimum": 0.0, "title": "Expected Revision" }, "approval_reference": { "anyOf": [ { "type": "string", "maxLength": 64, "minLength": 1 }, { "type": "null" } ], "title": "Approval Reference" }, "limits": { "$ref": "#/components/schemas/LimitsPatch" } }, "additionalProperties": false, "type": "object", "required": [ "reason", "expected_revision", "limits" ], "title": "LimitsRequest" }, "Login": { "properties": { "email": { "type": "string", "maxLength": 320, "minLength": 1, "title": "Email" }, "password": { "type": "string", "maxLength": 1024, "minLength": 1, "title": "Password" } }, "additionalProperties": false, "type": "object", "required": [ "email", "password" ], "title": "Login" }, "LoginRequest": { "properties": { "email": { "type": "string", "maxLength": 254, "format": "email", "title": "Email" }, "password": { "type": "string", "maxLength": 128, "title": "Password" } }, "type": "object", "required": [ "email", "password" ], "title": "LoginRequest" }, "MFA": { "properties": { "challenge_id": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Challenge Id" }, "code": { "type": "string", "pattern": "^\\d{6}$", "title": "Code" } }, "additionalProperties": false, "type": "object", "required": [ "challenge_id", "code" ], "title": "MFA" }, "MeResponse": { "properties": { "user": { "$ref": "#/components/schemas/UserSummary" }, "tenant": { "$ref": "#/components/schemas/TenantSummary" }, "session": { "$ref": "#/components/schemas/SessionExpiry" } }, "type": "object", "required": [ "user", "tenant", "session" ], "title": "MeResponse" }, "Membership": { "properties": { "tenant_id": { "type": "string", "format": "uuid", "title": "Tenant Id" }, "tenant_name": { "type": "string", "title": "Tenant Name" }, "role": { "type": "string", "title": "Role" } }, "additionalProperties": false, "type": "object", "required": [ "tenant_id", "tenant_name", "role" ], "title": "Membership" }, "MemoryDeleteResponse": { "properties": { "scope": { "type": "string", "enum": [ "user", "session" ], "title": "Scope" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id" }, "session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Session Id" }, "deleted_entries": { "type": "integer", "title": "Deleted Entries", "description": "Number of stored entries removed." } }, "type": "object", "required": [ "scope", "deleted_entries" ], "title": "MemoryDeleteResponse", "description": "Result of erasing a namespace." }, "MemoryEntryResponse": { "properties": { "path": { "type": "string", "title": "Path", "description": "Path of the file in the agent's /memories/ folder." }, "byte_size": { "type": "integer", "title": "Byte Size", "description": "Size of the stored entry in bytes." }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "required": [ "path", "byte_size" ], "title": "MemoryEntryResponse" }, "MemoryScopeResponse": { "properties": { "scope": { "type": "string", "enum": [ "user", "session" ], "title": "Scope", "description": "user means the memory follows one end user across their sessions. session means it is confined to a single conversation, which is what a session created without a user_id gets." }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id", "description": "Set when scope is user. The tenant user this memory belongs to." }, "session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Session Id", "description": "Set when scope is session. The single conversation this memory belongs to." }, "exists": { "type": "boolean", "title": "Exists", "description": "Whether the namespace currently holds any entry." }, "entry_count": { "type": "integer", "title": "Entry Count", "default": 0 }, "byte_size": { "type": "integer", "title": "Byte Size", "description": "Total bytes stored in this namespace.", "default": 0 }, "entries": { "items": { "$ref": "#/components/schemas/MemoryEntryResponse" }, "type": "array", "title": "Entries" } }, "type": "object", "required": [ "scope", "exists" ], "title": "MemoryScopeResponse", "description": "What one agent memory namespace holds, and who it belongs to.", "examples": [ { "byte_size": 612, "entries": [ { "byte_size": 612, "created_at": "2026-09-11T10:04:11Z", "path": "/AGENTS.md", "updated_at": "2026-09-11T10:41:52Z" } ], "entry_count": 1, "exists": true, "scope": "session", "session_id": "0f3a1c7d2b9e4f6a8c5d1e7b3a9f2c4d" } ] }, "Message": { "properties": { "id": { "type": "string", "title": "Id" }, "role": { "type": "string", "enum": [ "user", "assistant" ], "title": "Role" }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content" }, "content_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content Id" }, "run_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Run Id" }, "scope_generation": { "type": "integer", "title": "Scope Generation" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "expires_at": { "type": "string", "format": "date-time", "title": "Expires At" } }, "additionalProperties": false, "type": "object", "required": [ "id", "role", "content", "content_id", "run_id", "scope_generation", "created_at", "expires_at" ], "title": "Message" }, "MessageAccepted": { "properties": { "conversation_id": { "type": "string", "title": "Conversation Id" }, "run_id": { "type": "string", "format": "uuid", "title": "Run Id" }, "status": { "type": "string", "enum": [ "queued", "running", "completed", "failed", "cancelled", "timed_out" ], "title": "Status" } }, "additionalProperties": false, "type": "object", "required": [ "conversation_id", "run_id", "status" ], "title": "MessageAccepted" }, "MessageCreate": { "properties": { "content": { "type": "string", "maxLength": 32000, "minLength": 1, "title": "Content" }, "scope_generation": { "type": "integer", "minimum": 0.0, "title": "Scope Generation" }, "client_message_id": { "type": "string", "maxLength": 64, "minLength": 1, "title": "Client Message Id" } }, "additionalProperties": false, "type": "object", "required": [ "content", "scope_generation", "client_message_id" ], "title": "MessageCreate" }, "MessageListResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/MessageResponse" }, "type": "array", "title": "Data" }, "next_page": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next Page" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total" } }, "type": "object", "required": [ "data" ], "title": "MessageListResponse" }, "MessagePage": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Message" }, "type": "array", "title": "Data" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "data", "next_cursor" ], "title": "MessagePage" }, "MessageResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "session_id": { "type": "string", "title": "Session Id" }, "role": { "type": "string", "title": "Role" }, "content": { "type": "string", "title": "Content" }, "run_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Run Id" }, "sequence": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sequence" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" } }, "type": "object", "required": [ "id", "session_id", "role", "content" ], "title": "MessageResponse" }, "MetricCounts": { "properties": { "turns": { "type": "integer", "minimum": 0.0, "title": "Turns" }, "failures": { "type": "integer", "minimum": 0.0, "title": "Failures" }, "checker_rejections": { "type": "integer", "minimum": 0.0, "title": "Checker Rejections" } }, "additionalProperties": false, "type": "object", "required": [ "turns", "failures", "checker_rejections" ], "title": "MetricCounts" }, "MetricResponse": { "properties": { "windows": { "items": { "$ref": "#/components/schemas/MetricWindow" }, "type": "array", "title": "Windows" } }, "additionalProperties": false, "type": "object", "required": [ "windows" ], "title": "MetricResponse" }, "MetricWindow": { "properties": { "from": { "type": "string", "format": "date-time", "title": "From" }, "to": { "type": "string", "format": "date-time", "title": "To" }, "release_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Release Id" }, "counts": { "$ref": "#/components/schemas/MetricCounts" }, "latency_ms": { "$ref": "#/components/schemas/LatencyPercentiles" }, "tokens": { "type": "integer", "minimum": 0.0, "title": "Tokens" }, "usd": { "anyOf": [ { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Usd" }, "unavailable_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unavailable Reason" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to", "release_id", "counts", "latency_ms", "tokens", "usd", "unavailable_reason" ], "title": "MetricWindow" }, "ModelInfo": { "properties": { "model_id": { "type": "string", "title": "Model Id" }, "display_name": { "type": "string", "title": "Display Name" }, "provider": { "type": "string", "title": "Provider", "default": "openrouter" }, "input_cost_per_1m": { "type": "number", "title": "Input Cost Per 1M" }, "output_cost_per_1m": { "type": "number", "title": "Output Cost Per 1M" }, "is_default": { "type": "boolean", "title": "Is Default", "default": false } }, "type": "object", "required": [ "model_id", "display_name", "input_cost_per_1m", "output_cost_per_1m" ], "title": "ModelInfo" }, "ModelOption": { "properties": { "model_id": { "type": "string", "title": "Model Id" }, "provider": { "type": "string", "title": "Provider" }, "provider_configured": { "type": "boolean", "title": "Provider Configured" }, "display_name": { "type": "string", "title": "Display Name" }, "input_cost_per_1m": { "type": "number", "title": "Input Cost Per 1M" }, "output_cost_per_1m": { "type": "number", "title": "Output Cost Per 1M" }, "pricing_source": { "type": "string", "title": "Pricing Source" }, "is_default": { "type": "boolean", "title": "Is Default" } }, "additionalProperties": false, "type": "object", "required": [ "model_id", "provider", "provider_configured", "display_name", "input_cost_per_1m", "output_cost_per_1m", "pricing_source", "is_default" ], "title": "ModelOption" }, "ModelOverview": { "properties": { "revision": { "type": "integer", "title": "Revision" }, "provider_key_present": { "type": "boolean", "title": "Provider Key Present" }, "default_model": { "type": "string", "title": "Default Model" }, "providers": { "items": { "$ref": "#/components/schemas/ProviderOption" }, "type": "array", "title": "Providers" }, "models": { "items": { "$ref": "#/components/schemas/ModelOption" }, "type": "array", "title": "Models" }, "current": { "$ref": "#/components/schemas/CurrentModel" }, "qualifications": { "items": { "$ref": "#/components/schemas/QualificationJob" }, "type": "array", "title": "Qualifications" } }, "additionalProperties": false, "type": "object", "required": [ "revision", "provider_key_present", "default_model", "providers", "models", "current", "qualifications" ], "title": "ModelOverview" }, "ModelUsage": { "properties": { "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" }, "runs_total": { "type": "integer", "minimum": 0.0, "title": "Runs Total" }, "input_tokens": { "type": "integer", "minimum": 0.0, "title": "Input Tokens" }, "output_tokens": { "type": "integer", "minimum": 0.0, "title": "Output Tokens" } }, "additionalProperties": false, "type": "object", "required": [ "model", "runs_total", "input_tokens", "output_tokens" ], "title": "ModelUsage" }, "ModelsListResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ModelInfo" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "ModelsListResponse" }, "Monitoring": { "properties": { "status": { "type": "string", "enum": [ "fresh", "stale", "unavailable" ], "title": "Status" }, "last_evaluated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Evaluated At" }, "unavailable_since": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Unavailable Since" }, "failed_signals": { "items": { "type": "string", "enum": [ "WORKER_HEARTBEAT_STALE", "PROVIDER_ERROR_RATE", "NOTIFICATION_DELIVERY_FAILED", "BUDGET_WARNING", "BUDGET_EXHAUSTED", "WORKSPACE_FAILURE_STREAK", "CONTAINMENT_REVIEW_OVERDUE", "SUPPORT_NOTICE_BLOCKED" ] }, "type": "array", "title": "Failed Signals" }, "registry_size": { "type": "integer", "minimum": 0.0, "title": "Registry Size" } }, "additionalProperties": false, "type": "object", "required": [ "status", "last_evaluated_at", "unavailable_since", "failed_signals", "registry_size" ], "title": "Monitoring" }, "Mutation": { "properties": { "reason": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Reason" }, "expected_revision": { "type": "integer", "minimum": 0.0, "title": "Expected Revision" } }, "additionalProperties": false, "type": "object", "required": [ "reason", "expected_revision" ], "title": "Mutation" }, "Node": { "properties": { "id": { "type": "string", "title": "Id" }, "key": { "type": "string", "title": "Key" }, "kind": { "type": "string", "enum": [ "resolve", "gather", "checker", "optional_round", "synthesis" ], "title": "Kind" }, "dependencies": { "items": { "type": "string" }, "type": "array", "title": "Dependencies" }, "planned_inputs": { "additionalProperties": true, "type": "object", "title": "Planned Inputs" }, "status": { "type": "string", "enum": [ "planned", "running", "completed", "failed", "skipped", "cancelled", "timed_out" ], "title": "Status" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "source_deadline_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Source Deadline At" }, "attempts": { "items": { "$ref": "#/components/schemas/Attempt" }, "type": "array", "title": "Attempts" }, "checker_decisions": { "items": { "$ref": "#/components/schemas/CheckerDecision" }, "type": "array", "title": "Checker Decisions" } }, "additionalProperties": false, "type": "object", "required": [ "id", "key", "kind", "dependencies", "planned_inputs", "status", "reason", "source_deadline_at", "attempts", "checker_decisions" ], "title": "Node" }, "NotificationSettingsOut": { "properties": { "daily_digest": { "type": "boolean", "title": "Daily Digest" }, "recipients": { "items": { "type": "string" }, "type": "array", "title": "Recipients" }, "revision": { "type": "integer", "minimum": 0.0, "title": "Revision" }, "observed_at": { "type": "string", "format": "date-time", "title": "Observed At" } }, "additionalProperties": false, "type": "object", "required": [ "daily_digest", "recipients", "revision", "observed_at" ], "title": "NotificationSettingsOut" }, "NotificationSettingsPatch": { "properties": { "reason": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Reason" }, "expected_revision": { "type": "integer", "minimum": 0.0, "title": "Expected Revision" }, "daily_digest": { "type": "boolean", "title": "Daily Digest" } }, "additionalProperties": false, "type": "object", "required": [ "reason", "expected_revision", "daily_digest" ], "title": "NotificationSettingsPatch" }, "NotificationSettingsResponse": { "properties": { "daily_digest": { "type": "boolean", "title": "Daily Digest" }, "recipients": { "items": { "type": "string" }, "type": "array", "title": "Recipients" }, "audit_id": { "type": "string", "title": "Audit Id" }, "revision": { "type": "integer", "minimum": 0.0, "title": "Revision" } }, "additionalProperties": false, "type": "object", "required": [ "daily_digest", "recipients", "audit_id", "revision" ], "title": "NotificationSettingsResponse" }, "NotificationSummary": { "properties": { "recipients": { "type": "integer", "minimum": 0.0, "title": "Recipients" }, "queued": { "type": "integer", "minimum": 0.0, "title": "Queued" }, "delivered": { "type": "integer", "minimum": 0.0, "title": "Delivered" }, "failed": { "type": "integer", "minimum": 0.0, "title": "Failed" }, "pruned": { "type": "integer", "minimum": 0.0, "title": "Pruned" } }, "additionalProperties": false, "type": "object", "required": [ "recipients", "queued", "delivered", "failed", "pruned" ], "title": "NotificationSummary" }, "Observability": { "properties": { "sessions": { "items": { "$ref": "#/components/schemas/SessionResponse" }, "type": "array", "title": "Sessions" }, "next_page": { "anyOf": [ { "type": "integer", "minimum": 1.0 }, { "type": "null" } ], "title": "Next Page" }, "failures": { "$ref": "#/components/schemas/FailureCount" }, "usage": { "$ref": "#/components/schemas/ObservabilityUsage" }, "coverage": { "$ref": "#/components/schemas/openapi__bami_foundation__Coverage" } }, "additionalProperties": false, "type": "object", "required": [ "sessions", "next_page", "failures", "usage", "coverage" ], "title": "Observability" }, "ObservabilityUsage": { "properties": { "input_tokens": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Input Tokens" }, "output_tokens": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Output Tokens" }, "usd": { "anyOf": [ { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Usd" }, "unavailable_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unavailable Reason" } }, "additionalProperties": false, "type": "object", "required": [ "input_tokens", "output_tokens", "usd", "unavailable_reason" ], "title": "ObservabilityUsage" }, "OperationOut": { "properties": { "idempotency_key": { "type": "string", "title": "Idempotency Key" }, "status": { "type": "string", "enum": [ "pending", "completed" ], "title": "Status" }, "outcome": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Outcome" }, "http_status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Http Status" }, "audit_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Audit Id" }, "created_resource_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created Resource Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "additionalProperties": false, "type": "object", "required": [ "idempotency_key", "status", "outcome", "http_status", "audit_id", "created_resource_id", "created_at" ], "title": "OperationOut" }, "OptionalRound": { "properties": { "max_rounds": { "type": "integer", "const": 1, "title": "Max Rounds", "default": 1 }, "status": { "type": "string", "enum": [ "planned", "chosen", "completed", "skipped", "cancelled" ], "title": "Status" }, "trigger_source_ids": { "items": { "type": "string" }, "type": "array", "title": "Trigger Source Ids" }, "checker_decision_ids": { "items": { "type": "string" }, "type": "array", "title": "Checker Decision Ids" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "chosen_inputs": { "additionalProperties": { "additionalProperties": true, "type": "object" }, "type": "object", "title": "Chosen Inputs" }, "recorded_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Recorded At" } }, "additionalProperties": false, "type": "object", "required": [ "status", "trigger_source_ids", "checker_decision_ids", "reason", "chosen_inputs", "recorded_at" ], "title": "OptionalRound" }, "OutcomeIs": { "properties": { "kind": { "type": "string", "const": "outcome_is", "title": "Kind" }, "outcome": { "type": "string", "enum": [ "queued", "running", "passed", "failed", "waiting", "inconclusive", "cancelled", "timed_out" ], "title": "Outcome" } }, "additionalProperties": false, "type": "object", "required": [ "kind", "outcome" ], "title": "OutcomeIs" }, "PasswordChangeRequest": { "properties": { "current_password": { "type": "string", "maxLength": 128, "title": "Current Password" }, "new_password": { "type": "string", "maxLength": 128, "minLength": 10, "title": "New Password" } }, "type": "object", "required": [ "current_password", "new_password" ], "title": "PasswordChangeRequest" }, "PayerUsage": { "properties": { "payer": { "type": "string", "enum": [ "platform", "tenant_verification", "tenant_builder" ], "title": "Payer" }, "runs_total": { "type": "integer", "minimum": 0.0, "title": "Runs Total" }, "usd": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usd" }, "provenance": { "type": "string", "enum": [ "provider_reported", "recorded_unverified", "estimated", "mixed", "unavailable" ], "title": "Provenance" } }, "additionalProperties": false, "type": "object", "required": [ "payer", "runs_total", "usd", "provenance" ], "title": "PayerUsage" }, "Period": { "properties": { "from": { "type": "string", "format": "date-time", "title": "From" }, "to": { "type": "string", "format": "date-time", "title": "To" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "title": "Period" }, "Person": { "properties": { "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, "name": { "type": "string", "title": "Name" }, "email": { "type": "string", "title": "Email" }, "role": { "type": "string", "title": "Role" }, "verified_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Verified At" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "additionalProperties": false, "type": "object", "required": [ "user_id", "name", "email", "role", "verified_at", "created_at" ], "title": "Person" }, "Preference": { "properties": { "opted_out": { "type": "boolean", "title": "Opted Out" } }, "additionalProperties": false, "type": "object", "required": [ "opted_out" ], "title": "Preference" }, "ProvenanceUsage": { "properties": { "provenance": { "type": "string", "enum": [ "provider_reported", "recorded_unverified", "estimated", "mixed", "unavailable" ], "title": "Provenance" }, "run_count": { "type": "integer", "minimum": 0.0, "title": "Run Count" } }, "additionalProperties": false, "type": "object", "required": [ "provenance", "run_count" ], "title": "ProvenanceUsage" }, "ProviderOption": { "properties": { "id": { "type": "string", "title": "Id" }, "display_name": { "type": "string", "title": "Display Name" }, "configured": { "type": "boolean", "title": "Configured" }, "is_default": { "type": "boolean", "title": "Is Default" }, "pricing_source": { "type": "string", "title": "Pricing Source" }, "models": { "items": { "$ref": "#/components/schemas/ModelOption" }, "type": "array", "title": "Models" } }, "additionalProperties": false, "type": "object", "required": [ "id", "display_name", "configured", "is_default", "pricing_source", "models" ], "title": "ProviderOption" }, "QualificationJob": { "properties": { "id": { "type": "string", "title": "Id" }, "model_version": { "type": "string", "title": "Model Version" }, "status": { "type": "string", "enum": [ "queued", "running", "passed", "failed", "error" ], "title": "Status" }, "phase": { "type": "string", "title": "Phase" }, "requested_by": { "type": "string", "title": "Requested By" }, "requested_at": { "type": "string", "format": "date-time", "title": "Requested At" }, "started_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Started At" }, "finished_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Finished At" }, "result": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Result" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "release_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Release Id" }, "stage": { "type": "string", "enum": [ "none", "internal", "preview", "general" ], "title": "Stage" }, "confirmations": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Confirmations" } }, "additionalProperties": false, "type": "object", "required": [ "id", "model_version", "status", "phase", "requested_by", "requested_at", "started_at", "finished_at", "result", "error", "release_id", "stage", "confirmations" ], "title": "QualificationJob" }, "QualificationStart": { "properties": { "model_version": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Model Version" }, "reason": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Reason" } }, "additionalProperties": false, "type": "object", "required": [ "model_version", "reason" ], "title": "QualificationStart" }, "Receipt": { "properties": { "id": { "type": "string", "title": "Id" }, "kind": { "type": "string", "enum": [ "verification", "cancellation", "timeout", "action" ], "title": "Kind" }, "workspace_id": { "type": "string", "format": "uuid", "title": "Workspace Id" }, "creator_id": { "type": "string", "format": "uuid", "title": "Creator Id" }, "conversation_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Conversation Id" }, "request_id": { "type": "string", "title": "Request Id" }, "session_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Session Id" }, "run_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Run Id" }, "via": { "anyOf": [ { "type": "string", "const": "assistant" }, { "type": "null" } ], "title": "Via" }, "label": { "type": "string", "title": "Label" }, "outcome": { "type": "string", "enum": [ "queued", "running", "passed", "failed", "waiting", "inconclusive", "cancelled", "timed_out" ], "title": "Outcome" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "agent_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Agent Id" }, "agent_revision_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agent Revision Id" }, "agent_revision": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Agent Revision" }, "deployment_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deployment Id" }, "deployment_hash": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deployment Hash" }, "draft_id": { "type": "null", "title": "Draft Id" }, "draft_revision": { "type": "null", "title": "Draft Revision" }, "draft_hash": { "type": "null", "title": "Draft Hash" }, "test_snapshot_id": { "type": "null", "title": "Test Snapshot Id" }, "test_snapshot_hash": { "type": "null", "title": "Test Snapshot Hash" }, "runtime_profile_version": { "type": "null", "title": "Runtime Profile Version" }, "unavailable": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Unavailable" }, "effective_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Effective Model" }, "environment_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Environment Id" }, "prompt_policy_hash": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prompt Policy Hash" }, "executors": { "items": { "$ref": "#/components/schemas/ExecutorDeclaration" }, "type": "array", "title": "Executors" }, "input": { "anyOf": [ {}, { "type": "null" } ], "title": "Input" }, "assertions": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/FinalTextContains" }, { "$ref": "#/components/schemas/FinalTextMatches" }, { "$ref": "#/components/schemas/ToolCalled" }, { "$ref": "#/components/schemas/ToolNotCalled" }, { "$ref": "#/components/schemas/EventPresent" }, { "$ref": "#/components/schemas/JsonPathEquals" }, { "$ref": "#/components/schemas/OutcomeIs" } ], "discriminator": { "propertyName": "kind", "mapping": { "event_present": "#/components/schemas/EventPresent", "final_text_contains": "#/components/schemas/FinalTextContains", "final_text_matches": "#/components/schemas/FinalTextMatches", "json_path_equals": "#/components/schemas/JsonPathEquals", "outcome_is": "#/components/schemas/OutcomeIs", "tool_called": "#/components/schemas/ToolCalled", "tool_not_called": "#/components/schemas/ToolNotCalled" } } }, "type": "array" }, { "type": "null" } ], "title": "Assertions" }, "permitted_overrides": { "additionalProperties": true, "type": "object", "title": "Permitted Overrides" }, "output_references": { "items": { "type": "string" }, "type": "array", "title": "Output References" }, "event_references": { "items": { "type": "string" }, "type": "array", "title": "Event References" }, "content_hashes": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Content Hashes" }, "usage": { "$ref": "#/components/schemas/Usage" }, "remaining_local_change": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Remaining Local Change" }, "proof_limits": { "items": { "type": "string" }, "type": "array", "title": "Proof Limits" }, "memory_isolated": { "type": "boolean", "const": true, "title": "Memory Isolated", "default": true }, "usage_disclosed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Usage Disclosed At" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At" }, "content_expires_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Content Expires At" }, "content_deleted_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Content Deleted At" }, "audit_expires_at": { "type": "string", "format": "date-time", "title": "Audit Expires At" } }, "additionalProperties": false, "type": "object", "required": [ "id", "kind", "workspace_id", "creator_id", "conversation_id", "request_id", "session_id", "run_id", "via", "label", "outcome", "reason", "agent_id", "agent_revision_id", "agent_revision", "deployment_id", "deployment_hash", "unavailable", "effective_model", "environment_id", "prompt_policy_hash", "executors", "input", "assertions", "permitted_overrides", "output_references", "event_references", "content_hashes", "usage", "remaining_local_change", "proof_limits", "usage_disclosed_at", "created_at", "completed_at", "content_expires_at", "content_deleted_at", "audit_expires_at" ], "title": "Receipt" }, "ReceiptOut": { "properties": { "id": { "type": "string", "title": "Id" }, "kind": { "type": "string", "title": "Kind" }, "effective_at": { "type": "string", "format": "date-time", "title": "Effective At" }, "reason_category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason Category" }, "message": { "type": "string", "title": "Message" }, "support_route": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Support Route" }, "details": { "additionalProperties": true, "type": "object", "title": "Details" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "additionalProperties": false, "type": "object", "required": [ "id", "kind", "effective_at", "reason_category", "message", "support_route", "details", "created_at" ], "title": "ReceiptOut" }, "ReceiptPage": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ReceiptOut" }, "type": "array", "title": "Data" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "observed_at": { "type": "string", "format": "date-time", "title": "Observed At" } }, "additionalProperties": false, "type": "object", "required": [ "data", "next_cursor", "observed_at" ], "title": "ReceiptPage" }, "RecentRun": { "properties": { "run_id": { "type": "string", "format": "uuid", "title": "Run Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "status": { "type": "string", "enum": [ "queued", "running", "waiting_for_input", "completed", "failed", "cancelled", "expired" ], "title": "Status" }, "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Code" } }, "additionalProperties": false, "type": "object", "required": [ "run_id", "created_at", "status", "error_code" ], "title": "RecentRun" }, "Release": { "properties": { "id": { "type": "string", "title": "Id" }, "model_version": { "type": "string", "title": "Model Version" }, "prompt_hash": { "type": "string", "title": "Prompt Hash" }, "knowledge_hash": { "type": "string", "title": "Knowledge Hash" }, "prompt_reference": { "type": "string", "title": "Prompt Reference" }, "knowledge_reference": { "type": "string", "title": "Knowledge Reference" }, "evaluation": { "$ref": "#/components/schemas/EvaluationReceipt-Output" }, "created_by": { "type": "string", "format": "uuid", "title": "Created By" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "additionalProperties": false, "type": "object", "required": [ "id", "model_version", "prompt_hash", "knowledge_hash", "prompt_reference", "knowledge_reference", "evaluation", "created_by", "created_at" ], "title": "Release" }, "ReleaseCreate": { "properties": { "reason": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Reason" }, "expected_revision": { "type": "integer", "minimum": 0.0, "title": "Expected Revision" }, "model_version": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Model Version" }, "prompt_hash": { "type": "string", "pattern": "^[a-f0-9]{64}$", "title": "Prompt Hash" }, "knowledge_hash": { "type": "string", "pattern": "^[a-f0-9]{64}$", "title": "Knowledge Hash" }, "prompt_reference": { "type": "string", "maxLength": 500, "minLength": 1, "title": "Prompt Reference" }, "knowledge_reference": { "type": "string", "maxLength": 500, "minLength": 1, "title": "Knowledge Reference" }, "evaluation": { "$ref": "#/components/schemas/EvaluationReceipt-Input" } }, "additionalProperties": false, "type": "object", "required": [ "reason", "expected_revision", "model_version", "prompt_hash", "knowledge_hash", "prompt_reference", "knowledge_reference", "evaluation" ], "title": "ReleaseCreate" }, "ReleaseCreated": { "properties": { "revision": { "type": "integer", "title": "Revision" }, "release": { "$ref": "#/components/schemas/Release" } }, "additionalProperties": false, "type": "object", "required": [ "revision", "release" ], "title": "ReleaseCreated" }, "ReleasePage": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Release" }, "type": "array", "title": "Data" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "data", "next_cursor" ], "title": "ReleasePage" }, "ReplyDisclosure": { "properties": { "statement": { "type": "string", "title": "Statement" }, "provider_model_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider Model Version" }, "provider_calls": { "type": "integer", "title": "Provider Calls" }, "retention_days": { "type": "integer", "title": "Retention Days" }, "redaction": { "type": "string", "title": "Redaction" }, "single_use": { "type": "boolean", "const": true, "title": "Single Use", "default": true } }, "additionalProperties": false, "type": "object", "required": [ "statement", "provider_model_version", "provider_calls", "retention_days", "redaction" ], "title": "ReplyDisclosure", "description": "What the person is shown before they may allow one reply read." }, "ReplyEvidenceApproval": { "properties": { "id": { "type": "string", "title": "Id" }, "workspace_id": { "type": "string", "format": "uuid", "title": "Workspace Id" }, "conversation_id": { "type": "string", "title": "Conversation Id" }, "requester_id": { "type": "string", "format": "uuid", "title": "Requester Id" }, "offer_run_id": { "type": "string", "format": "uuid", "title": "Offer Run Id" }, "request_id": { "type": "string", "title": "Request Id" }, "scope_generation": { "type": "integer", "title": "Scope Generation" }, "target_run_id": { "type": "string", "format": "uuid", "title": "Target Run Id" }, "target_session_id": { "type": "string", "format": "uuid", "title": "Target Session Id" }, "diagnosis_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Diagnosis Id" }, "disclosure": { "$ref": "#/components/schemas/ReplyDisclosure" }, "decision": { "anyOf": [ { "type": "string", "enum": [ "allow", "deny" ] }, { "type": "null" } ], "title": "Decision" }, "decider_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Decider Id" }, "decided_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Decided At" }, "decision_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Decision Reason" }, "outcome": { "type": "string", "enum": [ "offered", "allowed", "declined", "spent", "expired" ], "title": "Outcome" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "expires_at": { "type": "string", "format": "date-time", "title": "Expires At" }, "consumed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Consumed At" }, "consumed_by_run_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Consumed By Run Id" }, "message_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Message Id" } }, "additionalProperties": false, "type": "object", "required": [ "id", "workspace_id", "conversation_id", "requester_id", "offer_run_id", "request_id", "scope_generation", "target_run_id", "target_session_id", "diagnosis_id", "disclosure", "decision", "decider_id", "decided_at", "decision_reason", "outcome", "created_at", "expires_at", "consumed_at", "consumed_by_run_id", "message_id" ], "title": "ReplyEvidenceApproval", "description": "Contract v5 second gate. Bound to one actor, workspace, run and diagnosis." }, "ReplyEvidenceDecision": { "properties": { "decision": { "type": "string", "enum": [ "allow", "deny" ], "title": "Decision" }, "reason": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ], "title": "Reason" } }, "additionalProperties": false, "type": "object", "required": [ "decision" ], "title": "ReplyEvidenceDecision" }, "ReplyExcerpt": { "properties": { "message_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message Id" }, "role": { "type": "string", "const": "assistant", "title": "Role" }, "text": { "type": "string", "title": "Text" }, "truncated": { "type": "boolean", "title": "Truncated" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, "additionalProperties": false, "type": "object", "required": [ "message_id", "role", "text", "truncated", "language" ], "title": "ReplyExcerpt" }, "RequestCorrelation": { "properties": { "target": { "$ref": "#/components/schemas/RequestTarget" }, "sessions": { "items": { "$ref": "#/components/schemas/app__modules__operator_console__console_schema__SessionSummary" }, "type": "array", "title": "Sessions" }, "runs": { "items": { "$ref": "#/components/schemas/RunSummary" }, "type": "array", "title": "Runs" }, "events": { "items": { "$ref": "#/components/schemas/EventMetadata" }, "type": "array", "title": "Events" }, "audit": { "items": { "$ref": "#/components/schemas/AuditRecord" }, "type": "array", "title": "Audit" }, "coverage": { "$ref": "#/components/schemas/app__modules__operator_console__console_schema__Coverage" }, "observed_at": { "type": "string", "format": "date-time", "title": "Observed At" }, "next_cursors": { "$ref": "#/components/schemas/RequestCursors" } }, "additionalProperties": false, "type": "object", "required": [ "target", "sessions", "runs", "events", "audit", "coverage", "observed_at", "next_cursors" ], "title": "RequestCorrelation" }, "RequestCursors": { "properties": { "sessions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sessions" }, "runs": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Runs" }, "events": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Events" }, "audit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Audit" } }, "additionalProperties": false, "type": "object", "required": [ "sessions", "runs", "events", "audit" ], "title": "RequestCursors" }, "RequestTarget": { "properties": { "request_id": { "type": "string", "title": "Request Id" }, "workspace_id": { "type": "string", "format": "uuid", "title": "Workspace Id" }, "sources": { "items": { "type": "string" }, "type": "array", "title": "Sources" }, "session_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Session Ids" }, "run_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Run Ids" }, "agent_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Agent Id" }, "deployment_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deployment Id" }, "link_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Link Count" }, "first_seen_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "First Seen At" }, "last_seen_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Seen At" }, "link_coverage": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Link Coverage" }, "unavailable_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unavailable Reason" } }, "additionalProperties": false, "type": "object", "required": [ "request_id", "workspace_id", "sources", "session_ids", "run_ids", "agent_id", "deployment_id", "link_count", "first_seen_at", "last_seen_at", "link_coverage", "unavailable_reason" ], "title": "RequestTarget" }, "ResetConfirmRequest": { "properties": { "token": { "type": "string", "title": "Token" }, "new_password": { "type": "string", "maxLength": 128, "minLength": 10, "title": "New Password" } }, "type": "object", "required": [ "token", "new_password" ], "title": "ResetConfirmRequest" }, "ResumeAccepted": { "properties": { "run_id": { "type": "string", "title": "Run Id" }, "status": { "type": "string", "title": "Status" }, "accepted_events": { "items": { "$ref": "#/components/schemas/AcceptedEvent" }, "type": "array", "title": "Accepted Events" }, "remaining_event_ids": { "items": { "type": "string" }, "type": "array", "title": "Remaining Event Ids" } }, "type": "object", "required": [ "run_id", "status", "accepted_events", "remaining_event_ids" ], "title": "ResumeAccepted" }, "ResumeEventInput": { "properties": { "type": { "type": "string", "const": "user.custom_tool_result", "title": "Type" }, "in_reply_to_event_id": { "type": "string", "maxLength": 64, "minLength": 1, "title": "In Reply To Event Id" }, "content": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Content" }, "error": { "anyOf": [ { "$ref": "#/components/schemas/ToolResultError" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "type", "in_reply_to_event_id" ], "title": "ResumeEventInput" }, "ResyncData": { "properties": { "reason": { "type": "string", "title": "Reason" }, "last_durable_event_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Durable Event Id" }, "reload_required": { "type": "boolean", "const": true, "title": "Reload Required", "default": true } }, "additionalProperties": false, "type": "object", "required": [ "reason", "last_durable_event_id" ], "title": "ResyncData" }, "ResyncEvent": { "properties": { "conversation_id": { "type": "string", "title": "Conversation Id" }, "run_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Run Id" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "type": { "type": "string", "const": "stream.resync", "title": "Type" }, "data": { "$ref": "#/components/schemas/ResyncData" } }, "additionalProperties": false, "type": "object", "required": [ "conversation_id", "run_id", "request_id", "created_at", "type", "data" ], "title": "ResyncEvent" }, "ReviewPage": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ContainmentReviewOut" }, "type": "array", "title": "Data" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "observed_at": { "type": "string", "format": "date-time", "title": "Observed At" }, "coverage": { "$ref": "#/components/schemas/app__modules__operator_console__console_schema__Coverage" } }, "additionalProperties": false, "type": "object", "required": [ "data", "next_cursor", "observed_at", "coverage" ], "title": "ReviewPage" }, "RoleRevokeRequest": { "properties": { "reason": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Reason" }, "expected_revision": { "type": "integer", "minimum": 0.0, "title": "Expected Revision" }, "approval_reference": { "anyOf": [ { "type": "string", "maxLength": 64, "minLength": 1 }, { "type": "null" } ], "title": "Approval Reference" } }, "additionalProperties": false, "type": "object", "required": [ "reason", "expected_revision" ], "title": "RoleRevokeRequest" }, "RoleUpdateRequest": { "properties": { "reason": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Reason" }, "expected_revision": { "type": "integer", "minimum": 0.0, "title": "Expected Revision" }, "approval_reference": { "anyOf": [ { "type": "string", "maxLength": 64, "minLength": 1 }, { "type": "null" } ], "title": "Approval Reference" }, "role": { "type": "string", "enum": [ "operator", "support" ], "title": "Role" }, "tenant_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "maxItems": 500, "title": "Tenant Ids" } }, "additionalProperties": false, "type": "object", "required": [ "reason", "expected_revision", "role" ], "title": "RoleUpdateRequest" }, "Rollout": { "properties": { "id": { "type": "string", "title": "Id" }, "revision": { "type": "integer", "minimum": 0.0, "title": "Revision" }, "release_id": { "type": "string", "title": "Release Id" }, "previous_release_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous Release Id" }, "cohort": { "type": "string", "enum": [ "internal", "preview", "general" ], "title": "Cohort" }, "tenant_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Tenant Ids" }, "actor_id": { "type": "string", "format": "uuid", "title": "Actor Id" }, "reason": { "type": "string", "title": "Reason" }, "outcome": { "type": "string", "enum": [ "applied", "rejected" ], "title": "Outcome" }, "rollback_of": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rollback Of" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "additionalProperties": false, "type": "object", "required": [ "id", "revision", "release_id", "previous_release_id", "cohort", "tenant_ids", "actor_id", "reason", "outcome", "rollback_of", "created_at" ], "title": "Rollout" }, "RolloutCreate": { "properties": { "reason": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Reason" }, "expected_revision": { "type": "integer", "minimum": 0.0, "title": "Expected Revision" }, "release_id": { "type": "string", "maxLength": 64, "minLength": 1, "title": "Release Id" }, "cohort": { "type": "string", "enum": [ "internal", "preview", "general" ], "title": "Cohort" }, "tenant_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Tenant Ids" } }, "additionalProperties": false, "type": "object", "required": [ "reason", "expected_revision", "release_id", "cohort", "tenant_ids" ], "title": "RolloutCreate" }, "RunCost": { "properties": { "calls": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Calls" }, "priced_calls": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Priced Calls" }, "usd": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usd" }, "provenance": { "type": "string", "enum": [ "provider_reported", "recorded_unverified", "estimated", "mixed", "unavailable" ], "title": "Provenance" }, "unavailable_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unavailable Reason" } }, "additionalProperties": false, "type": "object", "required": [ "calls", "priced_calls", "usd", "provenance", "unavailable_reason" ], "title": "RunCost", "description": "Per call cost for one run, read from the ledger, never inferred." }, "RunDetailResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "session_id": { "type": "string", "title": "Session Id" }, "status": { "type": "string", "enum": [ "queued", "running", "waiting_for_input", "completed", "failed", "cancelled", "expired" ], "title": "Status" }, "record_integrity": { "type": "string", "enum": [ "complete", "lost" ], "title": "Record Integrity", "description": "Whether the run's history was recorded, separately from its status. complete is the normal answer, including for a turn that finished with nothing to say. lost means the run executed but its history was not recorded; an empty timeline must not be read as a silent turn.", "default": "complete" }, "model_used": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Used" }, "usage": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Usage" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At" } }, "type": "object", "required": [ "id", "session_id", "status" ], "title": "RunDetailResponse" }, "RunNotCancellableErrorBody": { "properties": { "code": { "type": "string", "const": "RUN_NOT_CANCELLABLE", "title": "Code", "default": "RUN_NOT_CANCELLABLE" }, "message": { "type": "string", "title": "Message" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request Id" }, "run_id": { "type": "string", "title": "Run Id" }, "run_status": { "type": "string", "title": "Run Status" } }, "type": "object", "required": [ "message", "run_id", "run_status" ], "title": "RunNotCancellableErrorBody" }, "RunNotCancellableErrorEnvelope": { "properties": { "error": { "$ref": "#/components/schemas/RunNotCancellableErrorBody" } }, "type": "object", "required": [ "error" ], "title": "RunNotCancellableErrorEnvelope" }, "RunPage": { "properties": { "data": { "items": { "$ref": "#/components/schemas/RunSummary" }, "type": "array", "title": "Data" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "observed_at": { "type": "string", "format": "date-time", "title": "Observed At" }, "coverage": { "$ref": "#/components/schemas/app__modules__operator_console__console_schema__Coverage" } }, "additionalProperties": false, "type": "object", "required": [ "data", "next_cursor", "observed_at", "coverage" ], "title": "RunPage" }, "RunResponse": { "properties": { "run_id": { "type": "string", "title": "Run Id" }, "status": { "type": "string", "enum": [ "queued", "running", "waiting_for_input", "completed", "failed", "cancelled", "expired" ], "title": "Status" }, "record_integrity": { "type": "string", "enum": [ "complete", "lost" ], "title": "Record Integrity", "description": "Whether the run's history was recorded, separately from its status. complete is the normal answer, including for a turn that finished with nothing to say. lost means the run executed but its history was not recorded; an empty timeline must not be read as a silent turn.", "default": "complete" }, "model_used": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Used" }, "artifacts": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ArtifactResponse" }, "type": "array" }, { "type": "null" } ], "title": "Artifacts" }, "required_event_ids": { "items": { "type": "string" }, "type": "array", "title": "Required Event Ids" } }, "type": "object", "required": [ "run_id", "status" ], "title": "RunResponse" }, "RunSummary": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "tenant_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Tenant Id" }, "workspace_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Name", "description": "The workspace's display name, resolved server side. Null for a deleted or otherwise unresolvable tenant; the caller falls back to the id." }, "session_id": { "type": "string", "format": "uuid", "title": "Session Id" }, "agent_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Agent Id" }, "status": { "type": "string", "enum": [ "queued", "running", "waiting_for_input", "completed", "failed", "cancelled", "expired" ], "title": "Status" }, "model_used": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Used" }, "payer": { "type": "string", "enum": [ "platform", "tenant_verification", "tenant_builder" ], "title": "Payer" }, "provenance": { "type": "string", "enum": [ "provider_reported", "recorded_unverified", "estimated", "mixed", "unavailable" ], "title": "Provenance" }, "cost": { "$ref": "#/components/schemas/RunCost" }, "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Code" }, "input_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Input Tokens" }, "output_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Output Tokens" }, "usd": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usd" }, "elapsed_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Elapsed Ms" }, "wait_generation": { "type": "integer", "title": "Wait Generation" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At" } }, "additionalProperties": false, "type": "object", "required": [ "id", "tenant_id", "workspace_name", "session_id", "agent_id", "status", "model_used", "payer", "provenance", "cost", "error_code", "input_tokens", "output_tokens", "usd", "elapsed_ms", "wait_generation", "created_at", "updated_at", "completed_at" ], "title": "RunSummary" }, "Runs24h": { "properties": { "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total" }, "failed": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Failed" }, "unavailable_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unavailable Reason" } }, "additionalProperties": false, "type": "object", "required": [ "total", "failed", "unavailable_reason" ], "title": "Runs24h" }, "RunsByStatus": { "properties": { "queued": { "type": "integer", "minimum": 0.0, "title": "Queued" }, "running": { "type": "integer", "minimum": 0.0, "title": "Running" }, "waiting_for_input": { "type": "integer", "minimum": 0.0, "title": "Waiting For Input" }, "completed": { "type": "integer", "minimum": 0.0, "title": "Completed" }, "failed": { "type": "integer", "minimum": 0.0, "title": "Failed" }, "cancelled": { "type": "integer", "minimum": 0.0, "title": "Cancelled" }, "expired": { "type": "integer", "minimum": 0.0, "title": "Expired" } }, "additionalProperties": false, "type": "object", "required": [ "queued", "running", "waiting_for_input", "completed", "failed", "cancelled", "expired" ], "title": "RunsByStatus" }, "SandboxResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "session_id": { "type": "string", "title": "Session Id" }, "provider": { "type": "string", "title": "Provider", "default": "daytona" }, "status": { "type": "string", "title": "Status" }, "provider_sandbox_id": { "type": "string", "title": "Provider Sandbox Id" }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Expires At" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "recreated": { "type": "boolean", "title": "Recreated", "default": false } }, "type": "object", "required": [ "id", "session_id", "status", "provider_sandbox_id" ], "title": "SandboxResponse", "description": "Response model for sandbox operations." }, "SandboxStatus": { "type": "string", "enum": [ "ready", "stopped", "missing", "none", "unknown" ], "title": "SandboxStatus", "description": "Observed availability of a session sandbox." }, "Scope": { "properties": { "workspace_id": { "type": "string", "format": "uuid", "title": "Workspace Id" }, "agent_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Agent Id" }, "deployment_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deployment Id" }, "release_stage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Release Stage" }, "release_stage_unavailable_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Release Stage Unavailable Reason" } }, "additionalProperties": false, "type": "object", "required": [ "workspace_id", "agent_id", "deployment_id", "release_stage", "release_stage_unavailable_reason" ], "title": "Scope" }, "ScopeResult": { "properties": { "conversation": { "$ref": "#/components/schemas/Conversation" }, "cancellation_receipt": { "anyOf": [ { "$ref": "#/components/schemas/Receipt" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "conversation", "cancellation_receipt" ], "title": "ScopeResult" }, "ScopeSwitch": { "properties": { "scope": { "$ref": "#/components/schemas/Scope" }, "expected_generation": { "type": "integer", "minimum": 0.0, "title": "Expected Generation" } }, "additionalProperties": false, "type": "object", "required": [ "scope", "expected_generation" ], "title": "ScopeSwitch" }, "SecretListResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/SecretResponse" }, "type": "array", "title": "Data" } }, "type": "object", "title": "SecretListResponse" }, "SecretResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description", "default": "" }, "fingerprint": { "type": "string", "title": "Fingerprint", "description": "A short keyed digest of the value. Two entries with the same fingerprint hold the same value; it does not reveal the value." }, "created_by": { "type": "string", "title": "Created By" }, "updated_by": { "type": "string", "title": "Updated By" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "required": [ "id", "name", "fingerprint", "created_by", "updated_by" ], "title": "SecretResponse", "description": "Everything about a stored secret except the one thing it holds." }, "SendEventItem": { "properties": { "type": { "type": "string", "title": "Type" }, "content": { "anyOf": [ { "items": { "$ref": "#/components/schemas/EventContent" }, "type": "array" }, { "type": "null" } ], "title": "Content" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "hitl_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hitl Id" }, "response": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Response" } }, "type": "object", "required": [ "type" ], "title": "SendEventItem" }, "SendEventsRequest": { "properties": { "events": { "items": { "$ref": "#/components/schemas/SendEventItem" }, "type": "array", "title": "Events" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" } }, "type": "object", "required": [ "events" ], "title": "SendEventsRequest", "examples": [ { "events": [ { "content": [ { "text": "Continue.", "type": "text" } ], "type": "user.message" } ] } ] }, "SendEventsResponse": { "properties": { "event_ids": { "items": { "type": "string" }, "type": "array", "title": "Event Ids" }, "session_status": { "type": "string", "title": "Session Status", "default": "idle" }, "model_used": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Used" } }, "type": "object", "title": "SendEventsResponse" }, "SessionAgentRef": { "properties": { "id": { "type": "string", "title": "Id" }, "version": { "type": "integer", "title": "Version" } }, "type": "object", "required": [ "id", "version" ], "title": "SessionAgentRef" }, "SessionArchiveResponse": { "properties": { "status": { "type": "string", "title": "Status", "default": "archived" }, "archived_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Archived At" } }, "type": "object", "title": "SessionArchiveResponse" }, "SessionBusyErrorBody": { "properties": { "code": { "type": "string", "const": "SESSION_BUSY", "title": "Code", "default": "SESSION_BUSY" }, "message": { "type": "string", "title": "Message" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request Id" }, "active_run_id": { "type": "string", "title": "Active Run Id" }, "active_run_status": { "type": "string", "enum": [ "queued", "running", "waiting_for_input", "completed", "failed", "cancelled", "expired" ], "title": "Active Run Status" }, "recovery": { "items": { "type": "string" }, "type": "array", "title": "Recovery" } }, "type": "object", "required": [ "message", "active_run_id", "active_run_status", "recovery" ], "title": "SessionBusyErrorBody" }, "SessionBusyErrorEnvelope": { "properties": { "error": { "$ref": "#/components/schemas/SessionBusyErrorBody" } }, "type": "object", "required": [ "error" ], "title": "SessionBusyErrorEnvelope" }, "SessionDeploymentRef": { "properties": { "id": { "type": "string", "title": "Id" }, "content_hash": { "type": "string", "title": "Content Hash" } }, "type": "object", "required": [ "id", "content_hash" ], "title": "SessionDeploymentRef" }, "SessionExpiry": { "properties": { "expires_at": { "type": "string", "format": "date-time", "title": "Expires At" } }, "type": "object", "required": [ "expires_at" ], "title": "SessionExpiry" }, "SessionListResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/SessionResponse" }, "type": "array", "title": "Data" }, "next_page": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next Page" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total" } }, "type": "object", "required": [ "data" ], "title": "SessionListResponse" }, "SessionPage": { "properties": { "data": { "items": { "$ref": "#/components/schemas/app__modules__operator_console__console_schema__SessionSummary" }, "type": "array", "title": "Data" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "observed_at": { "type": "string", "format": "date-time", "title": "Observed At" }, "coverage": { "$ref": "#/components/schemas/app__modules__operator_console__console_schema__Coverage" } }, "additionalProperties": false, "type": "object", "required": [ "data", "next_cursor", "observed_at", "coverage" ], "title": "SessionPage" }, "SessionResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id" }, "agent": { "anyOf": [ { "$ref": "#/components/schemas/SessionAgentRef" }, { "type": "null" } ] }, "agent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agent Id" }, "agent_slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agent Slug" }, "deployment": { "anyOf": [ { "$ref": "#/components/schemas/SessionDeploymentRef" }, { "type": "null" } ] }, "deployment_snapshot_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deployment Snapshot Id", "description": "Identifier of the immutable deployment snapshot pinned to this session." }, "deployment_source": { "anyOf": [ { "type": "string", "enum": [ "published", "legacy" ] }, { "type": "null" } ], "title": "Deployment Source", "description": "Origin of the pinned deployment snapshot, either published or legacy." }, "environment_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Environment Id" }, "requires_sandbox": { "type": "boolean", "title": "Requires Sandbox", "description": "Whether this session requires a provisioned sandbox for tools and file operations.", "default": true }, "model": { "type": "string", "title": "Model" }, "status": { "type": "string", "title": "Status", "default": "idle" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "metadata": { "additionalProperties": true, "type": "object", "title": "Metadata" }, "secrets": { "items": { "$ref": "#/components/schemas/SessionSecretBinding" }, "type": "array", "title": "Secrets", "description": "Workspace secrets delivered to this session's sandbox, by name. Values are never included." }, "env": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Env" }, "sandbox_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sandbox Id" }, "sandbox_status": { "$ref": "#/components/schemas/SandboxStatus", "description": "Observed sandbox availability. ready is usable, stopped can be restarted, missing means the provider no longer has it, none means no sandbox is required, and unknown means provider state could not be reached.", "default": "none" }, "usage": { "$ref": "#/components/schemas/SessionUsage" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "archived_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Archived At" } }, "type": "object", "required": [ "id", "model" ], "title": "SessionResponse" }, "SessionSecretBinding": { "properties": { "name": { "type": "string", "title": "Name", "description": "The workspace secret to deliver." }, "env_var": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Env Var", "description": "Environment variable to set in the sandbox. Defaults to the secret name when no file_path is given. Pass null with a file_path to deliver the value only as a file." }, "file_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Path", "description": "Absolute path inside the sandbox to write the value to, created with mode 600 before the first run. Use this for tools that read a credential from a file rather than the environment." } }, "type": "object", "required": [ "name" ], "title": "SessionSecretBinding", "description": "One stored secret, delivered into one session's sandbox.\n\nDelivery is by environment variable, by file, or by both, because real\ncommand line tools are split between the two. A mail client that reads its\ntoken from ``$TOKEN`` wants the variable; one that reads a file under a\ndirectory named by an environment variable wants the file, plus a plain\nnon-secret variable pointing at that directory, which\n``CreateSessionRequest.env`` supplies." }, "SessionUsage": { "properties": { "input_tokens": { "type": "integer", "title": "Input Tokens", "default": 0 }, "output_tokens": { "type": "integer", "title": "Output Tokens", "default": 0 } }, "type": "object", "title": "SessionUsage" }, "Settings": { "properties": { "enabled": { "type": "boolean", "title": "Enabled", "default": false }, "tenant_enabled_default": { "type": "boolean", "title": "Tenant Enabled Default", "default": false }, "tenant_enabled": { "type": "boolean", "title": "Tenant Enabled", "default": false }, "reply_evidence_enabled": { "type": "boolean", "title": "Reply Evidence Enabled", "default": false }, "jev_enabled": { "type": "boolean", "title": "Jev Enabled", "default": false }, "model_version": { "type": "string", "title": "Model Version", "default": "" }, "fallback_enabled": { "type": "boolean", "const": false, "title": "Fallback Enabled", "default": false }, "release_id": { "type": "string", "title": "Release Id", "default": "" }, "evaluation_passed": { "type": "boolean", "title": "Evaluation Passed", "default": false }, "max_tool_calls_per_turn": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Max Tool Calls Per Turn", "default": 24 }, "max_concurrent_tool_calls": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Max Concurrent Tool Calls", "default": 4 }, "source_deadline_seconds": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Source Deadline Seconds", "default": 15 }, "turn_deadline_seconds": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Turn Deadline Seconds", "default": 90 }, "max_active_per_conversation": { "type": "integer", "const": 1, "title": "Max Active Per Conversation", "default": 1 }, "max_active_per_user": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Max Active Per User", "default": 2 }, "max_active_per_tenant": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Max Active Per Tenant", "default": 4 }, "max_active_global": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Max Active Global", "default": 20 }, "messages_per_minute": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Messages Per Minute", "default": 20 }, "messages_per_day": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Messages Per Day", "default": 200 }, "tenant_daily_tokens": { "type": "integer", "minimum": 0.0, "title": "Tenant Daily Tokens", "default": 250000 }, "tenant_daily_usd": { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Tenant Daily Usd", "default": "2" }, "global_daily_tokens": { "type": "integer", "minimum": 0.0, "title": "Global Daily Tokens", "default": 5000000 }, "global_daily_usd": { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Global Daily Usd", "default": "40" }, "budget_alert_percent": { "type": "integer", "maximum": 100.0, "minimum": 1.0, "title": "Budget Alert Percent", "default": 80 }, "content_retention_days": { "type": "integer", "maximum": 90.0, "minimum": 1.0, "title": "Content Retention Days", "default": 30 }, "control_poll_seconds": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Control Poll Seconds", "default": 2 }, "retention_sweep_seconds": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Retention Sweep Seconds", "default": 3600 }, "admin_session_ttl_seconds": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Admin Session Ttl Seconds", "default": 3600 }, "admin_enrolled_user_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Admin Enrolled User Ids" }, "checker_min_cases": { "type": "integer", "minimum": 40.0, "title": "Checker Min Cases", "default": 40 }, "checker_max_false_acceptance": { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Checker Max False Acceptance", "default": "0.05" }, "checker_max_false_rejection": { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Checker Max False Rejection", "default": "0.10" }, "action_activate_enabled": { "type": "boolean", "title": "Action Activate Enabled", "default": false }, "action_delete_enabled": { "type": "boolean", "title": "Action Delete Enabled", "default": false }, "action_deprecate_enabled": { "type": "boolean", "title": "Action Deprecate Enabled", "default": false } }, "additionalProperties": false, "type": "object", "title": "Settings" }, "SettingsPatch-Input": { "properties": { "tenant_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Tenant Enabled" }, "reply_evidence_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Reply Evidence Enabled" }, "jev_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Jev Enabled" }, "max_tool_calls_per_turn": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "Max Tool Calls Per Turn" }, "max_concurrent_tool_calls": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "Max Concurrent Tool Calls" }, "source_deadline_seconds": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "Source Deadline Seconds" }, "turn_deadline_seconds": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "Turn Deadline Seconds" }, "max_active_per_tenant": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "Max Active Per Tenant" }, "messages_per_minute": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "Messages Per Minute" }, "messages_per_day": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "Messages Per Day" }, "tenant_daily_tokens": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Tenant Daily Tokens" }, "tenant_daily_usd": { "anyOf": [ { "type": "number", "minimum": 0.0 }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Tenant Daily Usd" }, "content_retention_days": { "anyOf": [ { "type": "integer", "maximum": 90.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Content Retention Days" }, "release_id": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Release Id" }, "action_activate_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Action Activate Enabled" }, "action_delete_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Action Delete Enabled" }, "action_deprecate_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Action Deprecate Enabled" } }, "additionalProperties": false, "type": "object", "title": "SettingsPatch", "description": "Tenant allowlist. Omission leaves an override unchanged; null removes it." }, "SettingsPatch-Output": { "properties": { "tenant_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Tenant Enabled" }, "reply_evidence_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Reply Evidence Enabled" }, "jev_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Jev Enabled" }, "max_tool_calls_per_turn": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "Max Tool Calls Per Turn" }, "max_concurrent_tool_calls": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "Max Concurrent Tool Calls" }, "source_deadline_seconds": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "Source Deadline Seconds" }, "turn_deadline_seconds": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "Turn Deadline Seconds" }, "max_active_per_tenant": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "Max Active Per Tenant" }, "messages_per_minute": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "Messages Per Minute" }, "messages_per_day": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "Messages Per Day" }, "tenant_daily_tokens": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Tenant Daily Tokens" }, "tenant_daily_usd": { "anyOf": [ { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Tenant Daily Usd" }, "content_retention_days": { "anyOf": [ { "type": "integer", "maximum": 90.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Content Retention Days" }, "release_id": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Release Id" }, "action_activate_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Action Activate Enabled" }, "action_delete_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Action Delete Enabled" }, "action_deprecate_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Action Deprecate Enabled" } }, "additionalProperties": false, "type": "object", "title": "SettingsPatch", "description": "Tenant allowlist. Omission leaves an override unchanged; null removes it." }, "SettingsResponse": { "properties": { "revision": { "type": "integer", "minimum": 0.0, "title": "Revision" }, "settings": { "$ref": "#/components/schemas/SettingsPatch-Output" }, "effective_settings": { "$ref": "#/components/schemas/Settings" } }, "additionalProperties": false, "type": "object", "required": [ "revision", "settings", "effective_settings" ], "title": "SettingsResponse" }, "SignupRequest": { "properties": { "email": { "type": "string", "maxLength": 254, "format": "email", "title": "Email" }, "password": { "type": "string", "maxLength": 128, "minLength": 10, "title": "Password" }, "organization_name": { "type": "string", "maxLength": 100, "minLength": 1, "title": "Organization Name" } }, "type": "object", "required": [ "email", "password", "organization_name" ], "title": "SignupRequest" }, "SkillCatalogEntry": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "scope": { "type": "string", "title": "Scope" }, "license": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "License" }, "compatibility": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Compatibility" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version" }, "enabled": { "type": "boolean", "title": "Enabled", "default": true }, "has_bundled_files": { "type": "boolean", "title": "Has Bundled Files", "default": false }, "can_edit": { "type": "boolean", "title": "Can Edit", "default": false }, "source_material_requirements": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Source Material Requirements" } }, "type": "object", "required": [ "name", "description", "scope" ], "title": "SkillCatalogEntry" }, "SkillCatalogResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/SkillCatalogEntry" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "SkillCatalogResponse" }, "SkillCreateResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" } }, "type": "object", "required": [ "id", "name" ], "title": "SkillCreateResponse" }, "SkillEnableRequest": { "properties": { "enabled": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Enabled" } }, "type": "object", "title": "SkillEnableRequest" }, "SkillEnableResponse": { "properties": { "enabled": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Enabled" } }, "type": "object", "title": "SkillEnableResponse" }, "SkillFileUploadResponse": { "properties": { "name": { "type": "string", "title": "Name" }, "files": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Files" }, "total_files": { "type": "integer", "title": "Total Files", "default": 0 } }, "type": "object", "required": [ "name" ], "title": "SkillFileUploadResponse" }, "SkillImportRequest": { "properties": { "skill_md": { "type": "string", "title": "Skill Md" } }, "type": "object", "required": [ "skill_md" ], "title": "SkillImportRequest" }, "SkillImportResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "warnings": { "items": { "type": "string" }, "type": "array", "title": "Warnings" } }, "type": "object", "required": [ "id", "name" ], "title": "SkillImportResponse" }, "SkillListResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/SkillResponse" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "SkillListResponse" }, "SkillResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content" }, "license": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "License" }, "compatibility": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Compatibility" }, "allowed_tools": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Allowed Tools" }, "metadata": { "additionalProperties": true, "type": "object", "title": "Metadata" }, "manifest": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Manifest" }, "files": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Files" }, "source_material_requirements": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Source Material Requirements" }, "enabled": { "type": "boolean", "title": "Enabled", "default": true }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "required": [ "id", "name", "description" ], "title": "SkillResponse" }, "SkillValidateRequest": { "properties": { "skill_md": { "type": "string", "title": "Skill Md" } }, "type": "object", "required": [ "skill_md" ], "title": "SkillValidateRequest" }, "SkillValidateResponse": { "properties": { "valid": { "type": "boolean", "title": "Valid" }, "errors": { "items": { "type": "string" }, "type": "array", "title": "Errors" }, "warnings": { "items": { "type": "string" }, "type": "array", "title": "Warnings" } }, "type": "object", "required": [ "valid" ], "title": "SkillValidateResponse" }, "SourceCoverage": { "properties": { "source": { "type": "string", "title": "Source" }, "status": { "type": "string", "enum": [ "complete", "partial", "missing", "unavailable" ], "title": "Status" }, "observed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Observed At" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" } }, "additionalProperties": false, "type": "object", "required": [ "source", "status", "observed_at", "reason" ], "title": "SourceCoverage" }, "SourceReference": { "properties": { "id": { "type": "string", "title": "Id" }, "kind": { "type": "string", "enum": [ "audit", "session_run", "timeline", "deployment", "error", "docs" ], "title": "Kind" }, "resource_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resource Id" }, "href": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Href" }, "content_hash": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content Hash" } }, "additionalProperties": false, "type": "object", "required": [ "id", "kind", "resource_id", "href", "content_hash" ], "title": "SourceReference" }, "StaffPage": { "properties": { "data": { "items": { "$ref": "#/components/schemas/StaffRole" }, "type": "array", "title": "Data" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "observed_at": { "type": "string", "format": "date-time", "title": "Observed At" }, "coverage": { "$ref": "#/components/schemas/app__modules__operator_console__console_schema__Coverage" } }, "additionalProperties": false, "type": "object", "required": [ "data", "next_cursor", "observed_at", "coverage" ], "title": "StaffPage" }, "StaffResponse": { "properties": { "staff": { "$ref": "#/components/schemas/StaffRole" }, "audit_id": { "type": "string", "title": "Audit Id" }, "revision": { "type": "integer", "minimum": 0.0, "title": "Revision" } }, "additionalProperties": false, "type": "object", "required": [ "staff", "audit_id", "revision" ], "title": "StaffResponse" }, "StaffRole": { "properties": { "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, "name": { "type": "string", "title": "Name" }, "email": { "type": "string", "title": "Email" }, "role": { "type": "string", "enum": [ "operator", "support" ], "title": "Role" }, "tenant_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Tenant Ids" }, "revoked_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Revoked At" }, "enrolled_at": { "type": "string", "format": "date-time", "title": "Enrolled At" }, "revision": { "type": "integer", "minimum": 0.0, "title": "Revision" } }, "additionalProperties": false, "type": "object", "required": [ "user_id", "name", "email", "role", "tenant_ids", "revoked_at", "enrolled_at", "revision" ], "title": "StaffRole" }, "StopRunRequest": { "properties": { "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" } }, "type": "object", "title": "StopRunRequest" }, "StopRunResponse": { "properties": { "run_id": { "type": "string", "title": "Run Id" }, "status": { "type": "string", "title": "Status", "default": "interrupted" }, "stop_reason": { "type": "string", "title": "Stop Reason", "default": "user_requested" }, "interrupted_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Interrupted At" } }, "type": "object", "required": [ "run_id" ], "title": "StopRunResponse" }, "SupportGrant": { "properties": { "id": { "type": "string", "title": "Id" }, "revision": { "type": "integer", "minimum": 0.0, "title": "Revision" }, "workspace_id": { "type": "string", "format": "uuid", "title": "Workspace Id" }, "conversation_id": { "type": "string", "title": "Conversation Id" }, "grantee_id": { "type": "string", "format": "uuid", "title": "Grantee Id" }, "granted_by": { "type": "string", "format": "uuid", "title": "Granted By" }, "purpose": { "type": "string", "title": "Purpose" }, "consent_reference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consent Reference" }, "legal_obligation_reference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Legal Obligation Reference" }, "notification_status": { "type": "string", "enum": [ "pending", "sent", "failed", "prohibited" ], "title": "Notification Status" }, "notification_prohibited_reference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notification Prohibited Reference" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "expires_at": { "type": "string", "format": "date-time", "title": "Expires At" }, "revoked_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Revoked At" } }, "additionalProperties": false, "type": "object", "required": [ "id", "revision", "workspace_id", "conversation_id", "grantee_id", "granted_by", "purpose", "consent_reference", "legal_obligation_reference", "notification_status", "notification_prohibited_reference", "created_at", "expires_at", "revoked_at" ], "title": "SupportGrant" }, "SuspendRequest": { "properties": { "reason": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Reason" }, "expected_revision": { "type": "integer", "minimum": 0.0, "title": "Expected Revision" }, "reason_category": { "type": "string", "enum": [ "abuse", "security", "legal", "billing", "customer_request", "operational" ], "title": "Reason Category" } }, "additionalProperties": false, "type": "object", "required": [ "reason", "expected_revision", "reason_category" ], "title": "SuspendRequest" }, "Suspension": { "properties": { "state": { "type": "string", "enum": [ "active", "suspended", "deleting" ], "title": "State" }, "suspended_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Suspended At" }, "reason_category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason Category" }, "receipt_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Receipt Id" }, "resumed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Resumed At" } }, "additionalProperties": false, "type": "object", "required": [ "state", "suspended_at", "reason_category", "receipt_id", "resumed_at" ], "title": "Suspension" }, "SyncRequest": { "properties": { "direction": { "type": "string", "title": "Direction", "default": "to" } }, "type": "object", "title": "SyncRequest", "description": "Request model for sandbox sync." }, "SyncResponse": { "properties": { "status": { "type": "string", "title": "Status" }, "direction": { "type": "string", "title": "Direction" } }, "type": "object", "required": [ "status", "direction" ], "title": "SyncResponse", "description": "Response model for sandbox sync." }, "Synthesis": { "properties": { "outcome": { "type": "string", "enum": [ "diagnosed", "inconclusive", "timed_out", "cancelled" ], "title": "Outcome" }, "accepted_source_ids": { "items": { "type": "string" }, "type": "array", "title": "Accepted Source Ids" }, "checker_report_ids": { "items": { "type": "string" }, "type": "array", "title": "Checker Report Ids" }, "summary_content_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Summary Content Id" }, "remaining_uncertainty": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Remaining Uncertainty" } }, "additionalProperties": false, "type": "object", "required": [ "outcome", "accepted_source_ids", "checker_report_ids", "summary_content_id", "remaining_uncertainty" ], "title": "Synthesis" }, "TenantApiKeyCreateRequest": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 100, "minLength": 1 }, { "type": "null" } ], "title": "Name" }, "permissions": { "items": { "type": "string" }, "type": "array", "maxItems": 15, "title": "Permissions" }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Expires At" } }, "type": "object", "title": "TenantApiKeyCreateRequest", "examples": [ { "name": "prod", "permissions": [ "*" ] } ] }, "TenantApiKeyResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "permissions": { "items": { "type": "string" }, "type": "array", "title": "Permissions" }, "key_preview": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Key Preview" }, "public_key_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Public Key Id" }, "raw_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Raw Key" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Expires At" }, "last_used_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Used At" } }, "type": "object", "required": [ "id" ], "title": "TenantApiKeyResponse" }, "TenantDetail": { "properties": { "tenant": { "$ref": "#/components/schemas/TenantIdentity" }, "classification": { "$ref": "#/components/schemas/ClassificationState" }, "people": { "items": { "$ref": "#/components/schemas/Person" }, "type": "array", "title": "People" }, "activation": { "$ref": "#/components/schemas/Activation" }, "counts": { "$ref": "#/components/schemas/Counts" }, "health": { "$ref": "#/components/schemas/Health" }, "cost": { "$ref": "#/components/schemas/Cost" }, "recent_runs": { "items": { "$ref": "#/components/schemas/RecentRun" }, "type": "array", "title": "Recent Runs" }, "bami": { "$ref": "#/components/schemas/BamiState" }, "limits": { "items": { "$ref": "#/components/schemas/Limit" }, "type": "array", "title": "Limits" }, "revision": { "type": "integer", "minimum": 0.0, "title": "Revision" }, "observed_at": { "type": "string", "format": "date-time", "title": "Observed At" }, "coverage": { "$ref": "#/components/schemas/app__modules__operator_console__console_schema__Coverage" } }, "additionalProperties": false, "type": "object", "required": [ "tenant", "classification", "people", "activation", "counts", "health", "cost", "recent_runs", "bami", "limits", "revision", "observed_at", "coverage" ], "title": "TenantDetail" }, "TenantIdentity": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "slug": { "type": "string", "title": "Slug" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Region" }, "environment_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Environment Ids" }, "suspension": { "$ref": "#/components/schemas/Suspension" } }, "additionalProperties": false, "type": "object", "required": [ "id", "name", "slug", "created_at", "updated_at", "region", "environment_ids", "suspension" ], "title": "TenantIdentity" }, "TenantLimits": { "properties": { "sessions_per_minute": { "anyOf": [ { "type": "integer", "minimum": 1.0 }, { "type": "null" } ], "title": "Sessions Per Minute" }, "runs_per_minute": { "anyOf": [ { "type": "integer", "minimum": 1.0 }, { "type": "null" } ], "title": "Runs Per Minute" }, "events_per_minute": { "anyOf": [ { "type": "integer", "minimum": 1.0 }, { "type": "null" } ], "title": "Events Per Minute" } }, "additionalProperties": false, "type": "object", "title": "TenantLimits" }, "TenantListItem": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "slug": { "type": "string", "title": "Slug" }, "classification": { "type": "string", "enum": [ "customer", "internal", "test", "demo", "unclassified" ], "title": "Classification" }, "classification_suggestion": { "anyOf": [ { "type": "string", "enum": [ "customer", "internal", "test", "demo", "unclassified" ] }, { "type": "null" } ], "title": "Classification Suggestion" }, "classification_suggestion_source": { "anyOf": [ { "type": "string", "enum": [ "smoke_harness", "demo_tenant_list", "alethi_domain", "migration_walkthrough" ] }, { "type": "null" } ], "title": "Classification Suggestion Source" }, "suspension_state": { "type": "string", "enum": [ "active", "suspended", "deleting" ], "title": "Suspension State" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "owner": { "anyOf": [ { "$ref": "#/components/schemas/TenantOwner" }, { "type": "null" } ] }, "agent_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Agent Count" }, "agent_count_unavailable_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agent Count Unavailable Reason" }, "last_success_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Success At" }, "runs_24h": { "$ref": "#/components/schemas/Runs24h" }, "activation_stage": { "type": "string", "enum": [ "signed_up", "verified", "agent_created", "run_attempted", "run_succeeded" ], "title": "Activation Stage" }, "needs_attention": { "items": { "type": "string", "enum": [ "failures_no_success_24h", "unverified_48h", "no_agent_24h", "no_run_72h", "containment_review_overdue" ] }, "type": "array", "title": "Needs Attention" }, "revision": { "type": "integer", "minimum": 0.0, "title": "Revision" }, "observed_at": { "type": "string", "format": "date-time", "title": "Observed At" } }, "additionalProperties": false, "type": "object", "required": [ "id", "name", "slug", "classification", "classification_suggestion", "classification_suggestion_source", "suspension_state", "created_at", "owner", "agent_count", "agent_count_unavailable_reason", "last_success_at", "runs_24h", "activation_stage", "needs_attention", "revision", "observed_at" ], "title": "TenantListItem" }, "TenantListResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/TenantResponse" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "TenantListResponse" }, "TenantOwner": { "properties": { "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, "email": { "type": "string", "title": "Email" }, "verified_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Verified At" } }, "additionalProperties": false, "type": "object", "required": [ "user_id", "email", "verified_at" ], "title": "TenantOwner" }, "TenantPage": { "properties": { "data": { "items": { "$ref": "#/components/schemas/TenantListItem" }, "type": "array", "title": "Data" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "observed_at": { "type": "string", "format": "date-time", "title": "Observed At" }, "coverage": { "$ref": "#/components/schemas/app__modules__operator_console__console_schema__Coverage" }, "summary": { "$ref": "#/components/schemas/ClassificationSummary" } }, "additionalProperties": false, "type": "object", "required": [ "data", "next_cursor", "observed_at", "coverage", "summary" ], "title": "TenantPage" }, "TenantRateLimitDetails": { "properties": { "limit": { "type": "integer", "title": "Limit" }, "window_seconds": { "type": "integer", "title": "Window Seconds" }, "retry_after": { "type": "integer", "title": "Retry After" } }, "type": "object", "required": [ "limit", "window_seconds", "retry_after" ], "title": "TenantRateLimitDetails" }, "TenantRateLimitEnvelope": { "properties": { "error": { "$ref": "#/components/schemas/TenantRateLimitError" } }, "type": "object", "required": [ "error" ], "title": "TenantRateLimitEnvelope" }, "TenantRateLimitError": { "properties": { "code": { "type": "string", "title": "Code", "default": "RATE_LIMITED" }, "message": { "type": "string", "title": "Message", "default": "Tenant rate limit reached." }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request Id" }, "details": { "$ref": "#/components/schemas/TenantRateLimitDetails" } }, "type": "object", "required": [ "details" ], "title": "TenantRateLimitError" }, "TenantResponse": { "properties": { "limits": { "anyOf": [ { "$ref": "#/components/schemas/TenantLimits" }, { "type": "null" } ] }, "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "slug": { "type": "string", "title": "Slug" }, "metadata": { "additionalProperties": true, "type": "object", "title": "Metadata", "default": {} }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "required": [ "id", "name", "slug" ], "title": "TenantResponse" }, "TenantSummary": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "slug": { "type": "string", "title": "Slug" } }, "type": "object", "required": [ "id", "name", "slug" ], "title": "TenantSummary" }, "TenantUpdate": { "properties": { "reason": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Reason" }, "expected_revision": { "type": "integer", "minimum": 0.0, "title": "Expected Revision" }, "settings": { "$ref": "#/components/schemas/SettingsPatch-Input" } }, "additionalProperties": false, "type": "object", "required": [ "reason", "expected_revision", "settings" ], "title": "TenantUpdate" }, "TenantUserListResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/TenantUserResponse" }, "type": "array", "title": "Data" }, "next_page": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next Page" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total" } }, "type": "object", "required": [ "data" ], "title": "TenantUserListResponse" }, "TenantUserResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" }, "name": { "type": "string", "title": "Name" }, "email": { "type": "string", "title": "Email" }, "role": { "type": "string", "title": "Role", "default": "member" }, "metadata": { "additionalProperties": true, "type": "object", "title": "Metadata" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "required": [ "id", "name", "email" ], "title": "TenantUserResponse" }, "TestCreate": { "properties": { "deployment_id": { "type": "string", "maxLength": 64, "minLength": 1, "title": "Deployment Id" }, "title": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Title" }, "input": { "title": "Input" }, "assertions": { "items": { "oneOf": [ { "$ref": "#/components/schemas/FinalTextContains" }, { "$ref": "#/components/schemas/FinalTextMatches" }, { "$ref": "#/components/schemas/ToolCalled" }, { "$ref": "#/components/schemas/ToolNotCalled" }, { "$ref": "#/components/schemas/EventPresent" }, { "$ref": "#/components/schemas/JsonPathEquals" }, { "$ref": "#/components/schemas/OutcomeIs" } ], "discriminator": { "propertyName": "kind", "mapping": { "event_present": "#/components/schemas/EventPresent", "final_text_contains": "#/components/schemas/FinalTextContains", "final_text_matches": "#/components/schemas/FinalTextMatches", "json_path_equals": "#/components/schemas/JsonPathEquals", "outcome_is": "#/components/schemas/OutcomeIs", "tool_called": "#/components/schemas/ToolCalled", "tool_not_called": "#/components/schemas/ToolNotCalled" } } }, "type": "array", "title": "Assertions" }, "executor_mode": { "type": "string", "enum": [ "application", "stubbed", "mixed" ], "title": "Executor Mode" }, "tool_stubs": { "additionalProperties": { "$ref": "#/components/schemas/ToolStub" }, "type": "object", "title": "Tool Stubs" } }, "additionalProperties": false, "type": "object", "required": [ "deployment_id", "title", "input", "assertions", "executor_mode", "tool_stubs" ], "title": "TestCreate" }, "ToolCalled": { "properties": { "kind": { "type": "string", "const": "tool_called", "title": "Kind" }, "tool_name": { "type": "string", "minLength": 1, "title": "Tool Name" }, "input_path_equals": { "anyOf": [ { "$ref": "#/components/schemas/InputPathEquals" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "kind", "tool_name" ], "title": "ToolCalled" }, "ToolDefinitionListResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ToolDefinitionResponse" }, "type": "array", "title": "Data" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "type": "object", "required": [ "data" ], "title": "ToolDefinitionListResponse" }, "ToolDefinitionResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "tool_id": { "type": "string", "title": "Tool Id" }, "name": { "type": "string", "title": "Name" }, "version": { "type": "integer", "title": "Version" }, "description": { "type": "string", "title": "Description" }, "executor": { "type": "string", "title": "Executor" }, "input_schema": { "additionalProperties": true, "type": "object", "title": "Input Schema" }, "output_schema": { "additionalProperties": true, "type": "object", "title": "Output Schema" }, "schema_profile_version": { "type": "string", "title": "Schema Profile Version" }, "side_effect": { "type": "string", "title": "Side Effect" }, "confirmation": { "type": "string", "title": "Confirmation" }, "content_hash": { "type": "string", "title": "Content Hash" }, "status": { "type": "string", "title": "Status" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "tool_id", "name", "version", "description", "executor", "input_schema", "output_schema", "schema_profile_version", "side_effect", "confirmation", "content_hash", "status", "created_at" ], "title": "ToolDefinitionResponse" }, "ToolListResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ToolResponse" }, "type": "array", "title": "Data" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "type": "object", "required": [ "data" ], "title": "ToolListResponse" }, "ToolNotCalled": { "properties": { "kind": { "type": "string", "const": "tool_not_called", "title": "Kind" }, "tool_name": { "type": "string", "minLength": 1, "title": "Tool Name" } }, "additionalProperties": false, "type": "object", "required": [ "kind", "tool_name" ], "title": "ToolNotCalled" }, "ToolPolicy": { "properties": { "mode": { "type": "string", "title": "Mode", "default": "unrestricted" }, "granted": { "items": { "type": "string" }, "type": "array", "title": "Granted" } }, "additionalProperties": false, "type": "object", "title": "ToolPolicy", "description": "What the agent's declaration actually buys it at run time." }, "ToolRequirement": { "properties": { "tool_id": { "type": "string", "title": "Tool Id" }, "required": { "type": "boolean", "title": "Required", "default": true } }, "additionalProperties": false, "type": "object", "required": [ "tool_id" ], "title": "ToolRequirement" }, "ToolResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "display_name": { "type": "string", "title": "Display Name" }, "latest_version": { "type": "integer", "title": "Latest Version" }, "status": { "type": "string", "title": "Status" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "latest_definition": { "anyOf": [ { "$ref": "#/components/schemas/ToolDefinitionResponse" }, { "type": "null" } ] } }, "type": "object", "required": [ "id", "name", "display_name", "latest_version", "status", "created_at", "updated_at" ], "title": "ToolResponse" }, "ToolResultError": { "properties": { "code": { "type": "string", "maxLength": 64, "minLength": 1, "title": "Code" }, "message": { "type": "string", "maxLength": 2000, "minLength": 1, "title": "Message" }, "retryable": { "type": "boolean", "title": "Retryable", "default": false } }, "type": "object", "required": [ "code", "message" ], "title": "ToolResultError" }, "ToolStub": { "properties": { "provenance": { "type": "string", "enum": [ "builder_declared", "definition_example" ], "title": "Provenance" }, "tool_definition_id": { "type": "string", "title": "Tool Definition Id" }, "definition_hash": { "type": "string", "title": "Definition Hash" }, "example_pointer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Example Pointer" }, "output": { "anyOf": [ {}, { "type": "null" } ], "title": "Output" } }, "additionalProperties": false, "type": "object", "required": [ "provenance", "tool_definition_id", "definition_hash" ], "title": "ToolStub" }, "TurnLimits": { "properties": { "max_tool_calls_per_turn": { "type": "integer", "title": "Max Tool Calls Per Turn", "default": 24 }, "max_concurrent_tool_calls": { "type": "integer", "title": "Max Concurrent Tool Calls", "default": 4 }, "source_deadline_seconds": { "type": "integer", "title": "Source Deadline Seconds", "default": 15 }, "turn_deadline_seconds": { "type": "integer", "title": "Turn Deadline Seconds", "default": 90 }, "synthesis_reserve_seconds": { "type": "integer", "title": "Synthesis Reserve Seconds", "default": 5 } }, "additionalProperties": false, "type": "object", "title": "TurnLimits" }, "UpdateAgentRequest": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Slug" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" }, "system_prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "System Prompt" }, "tools": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tools", "description": "Which of Pantheon's built-in tools this agent may use. The list is an allowlist over exactly these names and it is enforced at run time: web_search, web_fetch, publish_artifact, list_session_artifacts. One of these that is not listed is not attached, and a call to it is refused before it runs and recorded on the run as tool.refused. This list does not govern the sandbox. While requires_sandbox is true the agent also has a shell (execute) and the file tools, and the sandbox can reach the network, so an agent that declares no web tools can still fetch a URL from the shell. Set requires_sandbox to false to remove all of that. Writing this field opts an agent created before enforcement into it; agents created after it are governed from their first revision." }, "tool_requirements": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ToolRequirement" }, "type": "array" }, { "type": "null" } ], "title": "Tool Requirements" }, "skills": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Skills" }, "environment_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Environment Id" }, "requires_sandbox": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Requires Sandbox", "description": "Whether sessions for this agent require a provisioned sandbox. When false, sandbox tools and file operations are unavailable." }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, "type": "object", "title": "UpdateAgentRequest" }, "UpdateEnvironmentRequest": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" }, "config": { "anyOf": [ { "$ref": "#/components/schemas/EnvironmentConfig" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, "type": "object", "title": "UpdateEnvironmentRequest" }, "UpdateSecretRequest": { "properties": { "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Value", "description": "The credential. Written once and never returned: no route in this API reads it back, and list and read answer with the name, the fingerprint and who set it. The agent has a shell in its own sandbox, so it can read its own environment and its own files and print this value into its own output. Pantheon keeps the value out of every prompt, event, log and record it controls, and it cannot stop an agent from disclosing a credential it was deliberately given. Store narrow, short lived credentials only, scoped to what the agent must do, and revoke them at the source when the work ends." }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Description" } }, "type": "object", "title": "UpdateSecretRequest", "description": "Replace the value, the description, or both.\n\nReplacing a value is a rotation, not a new secret: the name and the id stay,\nso every session that already names it picks up the new value the next time\na sandbox is provisioned." }, "UpdateSessionRequest": { "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" } }, "type": "object", "title": "UpdateSessionRequest" }, "UpdateSkillRequest": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content" }, "license": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "License" }, "compatibility": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Compatibility" }, "allowed_tools": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Allowed Tools" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" } }, "type": "object", "title": "UpdateSkillRequest" }, "UpdateTenantRequest": { "properties": { "limits": { "anyOf": [ { "$ref": "#/components/schemas/TenantLimits" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Slug" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" } }, "type": "object", "title": "UpdateTenantRequest" }, "UpdateTenantUserRequest": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "current_password": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Current Password" }, "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" } }, "type": "object", "title": "UpdateTenantUserRequest" }, "Usage": { "properties": { "input_tokens": { "type": "integer", "minimum": 0.0, "title": "Input Tokens" }, "output_tokens": { "type": "integer", "minimum": 0.0, "title": "Output Tokens" }, "usd": { "anyOf": [ { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Usd" }, "unavailable_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unavailable Reason" }, "payer": { "type": "string", "enum": [ "platform", "tenant" ], "title": "Payer" } }, "additionalProperties": false, "type": "object", "required": [ "input_tokens", "output_tokens", "usd", "unavailable_reason", "payer" ], "title": "Usage" }, "UserDetail": { "properties": { "user": { "$ref": "#/components/schemas/UserOut" }, "observed_at": { "type": "string", "format": "date-time", "title": "Observed At" }, "coverage": { "$ref": "#/components/schemas/app__modules__operator_console__console_schema__Coverage" } }, "additionalProperties": false, "type": "object", "required": [ "user", "observed_at", "coverage" ], "title": "UserDetail" }, "UserOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "email": { "type": "string", "title": "Email" }, "role": { "type": "string", "title": "Role" }, "verified_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Verified At" }, "is_active": { "type": "boolean", "title": "Is Active" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "memberships": { "items": { "$ref": "#/components/schemas/Membership" }, "type": "array", "title": "Memberships" } }, "additionalProperties": false, "type": "object", "required": [ "id", "name", "email", "role", "verified_at", "is_active", "created_at", "memberships" ], "title": "UserOut" }, "UserPage": { "properties": { "data": { "items": { "$ref": "#/components/schemas/UserOut" }, "type": "array", "title": "Data" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "observed_at": { "type": "string", "format": "date-time", "title": "Observed At" }, "coverage": { "$ref": "#/components/schemas/app__modules__operator_console__console_schema__Coverage" } }, "additionalProperties": false, "type": "object", "required": [ "data", "next_cursor", "observed_at", "coverage" ], "title": "UserPage" }, "UserSummary": { "properties": { "id": { "type": "string", "title": "Id" }, "email": { "type": "string", "title": "Email" }, "email_verified_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Email Verified At" } }, "type": "object", "required": [ "id", "email" ], "title": "UserSummary" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "WorkerComponent": { "properties": { "status": { "type": "string", "enum": [ "ok", "degraded", "down" ], "title": "Status" }, "last_heartbeat_age_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Last Heartbeat Age Seconds" } }, "type": "object", "required": [ "status" ], "title": "WorkerComponent" }, "WorkspaceChangeResponse": { "properties": { "workspace": { "$ref": "#/components/schemas/WorkspaceSummary" }, "tenant": { "$ref": "#/components/schemas/TenantSummary" } }, "type": "object", "required": [ "workspace", "tenant" ], "title": "WorkspaceChangeResponse", "description": "Result of a rename, delete or restore: the same pair create returns, without a session." }, "WorkspaceCreateRequest": { "properties": { "name": { "type": "string", "maxLength": 100, "minLength": 1, "title": "Name" } }, "type": "object", "required": [ "name" ], "title": "WorkspaceCreateRequest" }, "WorkspaceCreateResponse": { "properties": { "workspace": { "$ref": "#/components/schemas/WorkspaceSummary" }, "tenant": { "$ref": "#/components/schemas/TenantSummary" }, "session": { "$ref": "#/components/schemas/app__modules__accounts__account_schema__SessionSummary" }, "switched": { "type": "boolean", "title": "Switched" } }, "type": "object", "required": [ "workspace", "tenant", "session", "switched" ], "title": "WorkspaceCreateResponse" }, "WorkspaceListResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/WorkspaceSummary" }, "type": "array", "title": "Items" }, "current_workspace_id": { "type": "string", "title": "Current Workspace Id" } }, "type": "object", "required": [ "items", "current_workspace_id" ], "title": "WorkspaceListResponse" }, "WorkspaceRenameRequest": { "properties": { "name": { "type": "string", "maxLength": 100, "minLength": 1, "title": "Name" } }, "type": "object", "required": [ "name" ], "title": "WorkspaceRenameRequest" }, "WorkspaceSummary": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "slug": { "type": "string", "title": "Slug" }, "role": { "type": "string", "title": "Role" }, "is_current": { "type": "boolean", "title": "Is Current" }, "deleted_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Deleted At" }, "purge_after": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Purge After" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "owner_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner Email" } }, "type": "object", "required": [ "id", "name", "slug", "role", "is_current" ], "title": "WorkspaceSummary" }, "WorkspaceSwitch": { "properties": { "on": { "type": "boolean", "title": "On" } }, "additionalProperties": false, "type": "object", "required": [ "on" ], "title": "WorkspaceSwitch" }, "WorkspaceSwitchResponse": { "properties": { "tenant": { "$ref": "#/components/schemas/TenantSummary" }, "session": { "$ref": "#/components/schemas/app__modules__accounts__account_schema__SessionSummary" } }, "type": "object", "required": [ "tenant", "session" ], "title": "WorkspaceSwitchResponse" }, "app__modules__accounts__account_schema__SessionSummary": { "properties": { "token": { "type": "string", "title": "Token" }, "expires_at": { "type": "string", "format": "date-time", "title": "Expires At" } }, "type": "object", "required": [ "token", "expires_at" ], "title": "SessionSummary" }, "app__modules__bami_admin__bami_admin_schema__AuditPage": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ConfigurationAudit" }, "type": "array", "title": "Data" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "data", "next_cursor" ], "title": "AuditPage" }, "app__modules__operator_console__console_schema__AuditPage": { "properties": { "data": { "items": { "$ref": "#/components/schemas/AuditRecord" }, "type": "array", "title": "Data" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "observed_at": { "type": "string", "format": "date-time", "title": "Observed At" }, "coverage": { "$ref": "#/components/schemas/app__modules__operator_console__console_schema__Coverage" } }, "additionalProperties": false, "type": "object", "required": [ "data", "next_cursor", "observed_at", "coverage" ], "title": "AuditPage" }, "app__modules__operator_console__console_schema__Coverage": { "properties": { "status": { "type": "string", "enum": [ "complete", "partial", "missing", "unavailable" ], "title": "Status" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "sources": { "items": { "$ref": "#/components/schemas/SourceCoverage" }, "type": "array", "title": "Sources" } }, "additionalProperties": false, "type": "object", "required": [ "status", "reason", "sources" ], "title": "Coverage" }, "app__modules__operator_console__console_schema__DailyUsage": { "properties": { "date": { "type": "string", "format": "date", "title": "Date" }, "runs_total": { "type": "integer", "minimum": 0.0, "title": "Runs Total" }, "runs_failed": { "type": "integer", "minimum": 0.0, "title": "Runs Failed" }, "input_tokens": { "type": "integer", "minimum": 0.0, "title": "Input Tokens" }, "output_tokens": { "type": "integer", "minimum": 0.0, "title": "Output Tokens" }, "usd": { "items": { "$ref": "#/components/schemas/CostLine" }, "type": "array", "title": "Usd" } }, "additionalProperties": false, "type": "object", "required": [ "date", "runs_total", "runs_failed", "input_tokens", "output_tokens", "usd" ], "title": "DailyUsage" }, "app__modules__operator_console__console_schema__ResumeRequest": { "properties": { "reason": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Reason" }, "expected_revision": { "type": "integer", "minimum": 0.0, "title": "Expected Revision" }, "approval_reference": { "anyOf": [ { "type": "string", "maxLength": 64, "minLength": 1 }, { "type": "null" } ], "title": "Approval Reference" } }, "additionalProperties": false, "type": "object", "required": [ "reason", "expected_revision" ], "title": "ResumeRequest" }, "app__modules__operator_console__console_schema__SessionSummary": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "tenant_id": { "type": "string", "format": "uuid", "title": "Tenant Id" }, "workspace_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Name", "description": "The workspace's display name, resolved server side. Null for a deleted or otherwise unresolvable tenant; the caller falls back to the id." }, "agent_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Agent Id" }, "agent_version": { "type": "integer", "title": "Agent Version" }, "deployment_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deployment Id" }, "environment_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Environment Id" }, "kind": { "type": "string", "title": "Kind" }, "model": { "type": "string", "title": "Model" }, "status": { "type": "string", "title": "Status" }, "requires_sandbox": { "type": "boolean", "title": "Requires Sandbox", "description": "Whether the session was admitted with a sandbox requirement." }, "sandbox_state": { "type": "string", "enum": [ "attached", "none" ], "title": "Sandbox State" }, "input_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Input Tokens" }, "output_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Output Tokens" }, "run_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Run Count" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "archived_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Archived At" }, "deleted_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Deleted At" } }, "additionalProperties": false, "type": "object", "required": [ "id", "tenant_id", "workspace_name", "agent_id", "agent_version", "deployment_id", "environment_id", "kind", "model", "status", "requires_sandbox", "sandbox_state", "input_tokens", "output_tokens", "run_count", "created_at", "updated_at", "archived_at", "deleted_at" ], "title": "SessionSummary" }, "app__modules__operator_console__console_schema__UsageResponse": { "properties": { "period": { "$ref": "#/components/schemas/DatePeriod" }, "totals": { "$ref": "#/components/schemas/app__modules__operator_console__console_schema__UsageTotals" }, "daily": { "items": { "$ref": "#/components/schemas/app__modules__operator_console__console_schema__DailyUsage" }, "type": "array", "title": "Daily" }, "by_model": { "items": { "$ref": "#/components/schemas/ModelUsage" }, "type": "array", "title": "By Model" }, "payer": { "items": { "$ref": "#/components/schemas/PayerUsage" }, "type": "array", "title": "Payer" }, "provenance": { "items": { "$ref": "#/components/schemas/ProvenanceUsage" }, "type": "array", "title": "Provenance" }, "budget": { "$ref": "#/components/schemas/Budget" }, "billing_label": { "type": "string", "const": "Free builder preview", "title": "Billing Label" }, "coverage": { "$ref": "#/components/schemas/CostCoverage" }, "observed_at": { "type": "string", "format": "date-time", "title": "Observed At" } }, "additionalProperties": false, "type": "object", "required": [ "period", "totals", "daily", "by_model", "payer", "provenance", "budget", "billing_label", "coverage", "observed_at" ], "title": "UsageResponse" }, "app__modules__operator_console__console_schema__UsageTotals": { "properties": { "sessions_created": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sessions Created" }, "runs_total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Runs Total" }, "runs_by_status": { "$ref": "#/components/schemas/RunsByStatus" }, "input_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Input Tokens" }, "output_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Output Tokens" }, "tool_calls": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Tool Calls" }, "requests": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Requests" }, "storage_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Storage Bytes" }, "sandbox_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sandbox Seconds" }, "sandbox_seconds_estimated": { "type": "boolean", "title": "Sandbox Seconds Estimated" }, "usd": { "items": { "$ref": "#/components/schemas/CostLine" }, "type": "array", "title": "Usd" }, "unavailable_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unavailable Reason" } }, "additionalProperties": false, "type": "object", "required": [ "sessions_created", "runs_total", "runs_by_status", "input_tokens", "output_tokens", "tool_calls", "requests", "storage_bytes", "sandbox_seconds", "sandbox_seconds_estimated", "usd", "unavailable_reason" ], "title": "UsageTotals" }, "app__modules__resume__resume_schema__ResumeRequest": { "properties": { "events": { "items": { "$ref": "#/components/schemas/ResumeEventInput" }, "type": "array", "maxItems": 32, "minItems": 1, "title": "Events" } }, "additionalProperties": false, "type": "object", "required": [ "events" ], "title": "ResumeRequest" }, "app__modules__usage__usage_schema__DailyUsage": { "properties": { "sessions_created": { "type": "integer", "title": "Sessions Created", "default": 0 }, "runs_total": { "type": "integer", "title": "Runs Total", "default": 0 }, "input_tokens": { "type": "integer", "title": "Input Tokens", "default": 0 }, "output_tokens": { "type": "integer", "title": "Output Tokens", "default": 0 }, "sandbox_seconds": { "type": "number", "title": "Sandbox Seconds", "default": 0 }, "tool_calls": { "type": "integer", "title": "Tool Calls", "default": 0 }, "date": { "type": "string", "format": "date", "title": "Date" } }, "type": "object", "required": [ "date" ], "title": "DailyUsage" }, "app__modules__usage__usage_schema__UsageResponse": { "properties": { "sandbox_seconds_estimated": { "type": "boolean", "title": "Sandbox Seconds Estimated", "description": "True when reported sandbox time includes an estimated end. Missing or stopped resources use the provider end timestamp when available, otherwise the observation time. Unobserved open resources are capped at last_seen_at plus the configured provider idle timeout (Daytona default: 10 minutes to stop plus 5 to delete). Legacy rows without an observation use their instance start.", "default": false }, "from": { "type": "string", "format": "date", "title": "From" }, "to": { "type": "string", "format": "date", "title": "To" }, "totals": { "$ref": "#/components/schemas/app__modules__usage__usage_schema__UsageTotals" }, "daily": { "items": { "$ref": "#/components/schemas/app__modules__usage__usage_schema__DailyUsage" }, "type": "array", "title": "Daily" } }, "type": "object", "required": [ "from", "to", "totals", "daily" ], "title": "UsageResponse" }, "app__modules__usage__usage_schema__UsageTotals": { "properties": { "sessions_created": { "type": "integer", "title": "Sessions Created", "default": 0 }, "runs_total": { "type": "integer", "title": "Runs Total", "default": 0 }, "input_tokens": { "type": "integer", "title": "Input Tokens", "default": 0 }, "output_tokens": { "type": "integer", "title": "Output Tokens", "default": 0 }, "sandbox_seconds": { "type": "number", "title": "Sandbox Seconds", "default": 0 }, "tool_calls": { "type": "integer", "title": "Tool Calls", "default": 0 }, "runs_by_status": { "additionalProperties": { "type": "integer" }, "type": "object", "title": "Runs By Status" } }, "type": "object", "title": "UsageTotals" }, "openapi__bami_foundation__Coverage": { "properties": { "status": { "type": "string", "enum": [ "complete", "partial", "missing", "unavailable", "ambiguous" ], "title": "Status" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request Id" }, "session_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Session Id" }, "run_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Run Id" }, "deployment_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deployment Id" }, "agent_revision_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agent Revision Id" }, "contract_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Contract Version" }, "from_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "From Time" }, "to_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "To Time" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Expires At" } }, "additionalProperties": false, "type": "object", "required": [ "status", "reason", "request_id", "session_id", "run_id", "deployment_id", "agent_revision_id", "contract_version", "from_time", "to_time", "next_cursor", "expires_at" ], "title": "Coverage" }, "SessionSummary": { "properties": { "token": { "type": "string", "title": "Token" }, "expires_at": { "type": "string", "format": "date-time", "title": "Expires At" } }, "type": "object", "required": [ "token", "expires_at" ], "title": "SessionSummary" }, "ResumeRequest": { "properties": { "events": { "items": { "$ref": "#/components/schemas/ResumeEventInput" }, "type": "array", "maxItems": 32, "minItems": 1, "title": "Events" } }, "additionalProperties": false, "type": "object", "required": [ "events" ], "title": "ResumeRequest" }, "AuditPage": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ConfigurationAudit" }, "type": "array", "title": "Data" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "additionalProperties": false, "type": "object", "required": [ "data", "next_cursor" ], "title": "AuditPage" }, "DailyUsage": { "properties": { "sessions_created": { "type": "integer", "title": "Sessions Created", "default": 0 }, "runs_total": { "type": "integer", "title": "Runs Total", "default": 0 }, "input_tokens": { "type": "integer", "title": "Input Tokens", "default": 0 }, "output_tokens": { "type": "integer", "title": "Output Tokens", "default": 0 }, "sandbox_seconds": { "type": "number", "title": "Sandbox Seconds", "default": 0 }, "tool_calls": { "type": "integer", "title": "Tool Calls", "default": 0 }, "date": { "type": "string", "format": "date", "title": "Date" } }, "type": "object", "required": [ "date" ], "title": "DailyUsage" }, "UsageResponse": { "properties": { "sandbox_seconds_estimated": { "type": "boolean", "title": "Sandbox Seconds Estimated", "description": "True when reported sandbox time includes an estimated end. Missing or stopped resources use the provider end timestamp when available, otherwise the observation time. Unobserved open resources are capped at last_seen_at plus the configured provider idle timeout (Daytona default: 10 minutes to stop plus 5 to delete). Legacy rows without an observation use their instance start.", "default": false }, "from": { "type": "string", "format": "date", "title": "From" }, "to": { "type": "string", "format": "date", "title": "To" }, "totals": { "$ref": "#/components/schemas/UsageTotals" }, "daily": { "items": { "$ref": "#/components/schemas/DailyUsage" }, "type": "array", "title": "Daily" } }, "type": "object", "required": [ "from", "to", "totals", "daily" ], "title": "UsageResponse" }, "UsageTotals": { "properties": { "sessions_created": { "type": "integer", "title": "Sessions Created", "default": 0 }, "runs_total": { "type": "integer", "title": "Runs Total", "default": 0 }, "input_tokens": { "type": "integer", "title": "Input Tokens", "default": 0 }, "output_tokens": { "type": "integer", "title": "Output Tokens", "default": 0 }, "sandbox_seconds": { "type": "number", "title": "Sandbox Seconds", "default": 0 }, "tool_calls": { "type": "integer", "title": "Tool Calls", "default": 0 }, "runs_by_status": { "additionalProperties": { "type": "integer" }, "type": "object", "title": "Runs By Status" } }, "type": "object", "title": "UsageTotals" }, "AdminSession": { "properties": { "id": { "type": "string", "title": "Id" }, "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, "mfa_verified_at": { "type": "string", "format": "date-time", "title": "Mfa Verified At" }, "expires_at": { "type": "string", "format": "date-time", "title": "Expires At" }, "csrf_token": { "type": "string", "title": "Csrf Token" } }, "additionalProperties": false, "type": "object", "required": [ "id", "user_id", "mfa_verified_at", "expires_at", "csrf_token" ], "title": "AdminSession" }, "Coverage": { "properties": { "status": { "type": "string", "enum": [ "complete", "partial", "missing", "unavailable", "ambiguous" ], "title": "Status" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request Id" }, "session_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Session Id" }, "run_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Run Id" }, "deployment_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deployment Id" }, "agent_revision_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agent Revision Id" }, "contract_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Contract Version" }, "from_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "From Time" }, "to_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "To Time" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Expires At" } }, "additionalProperties": false, "type": "object", "required": [ "status", "reason", "request_id", "session_id", "run_id", "deployment_id", "agent_revision_id", "contract_version", "from_time", "to_time", "next_cursor", "expires_at" ], "title": "Coverage" }, "SandboxRecreatedEventData": { "type": "object", "description": "Emitted before agent execution when a missing sandbox is replaced. The prior workspace was lost. Only artifacts already published to durable storage are restored, so unpublished files and local changes do not survive.", "properties": { "type": { "type": "string", "const": "sandbox.recreated" }, "session_id": { "type": "string" }, "run_id": { "type": "string" }, "sandbox_id": { "type": "string" }, "last_sandbox_id": { "type": "string", "nullable": true } }, "required": [ "type", "session_id", "run_id", "sandbox_id" ] }, "ErrorDetail": { "type": "object", "properties": { "path": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "path", "reason" ] }, "ErrorBody": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "invalid_cursor", "authentication_required", "permission_denied", "resource_not_found", "idempotency_conflict", "event_already_resolved", "event_expired", "run_not_resumable", "tool_input_invalid", "tool_result_invalid", "runtime_resume_unavailable", "SESSION_BUSY", "RUN_NOT_CANCELLABLE" ] }, "message": { "type": "string" }, "request_id": { "type": "string" }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorDetail" } }, "active_run_id": { "type": "string" }, "active_run_status": { "type": "string" }, "recovery": { "type": "array", "items": { "type": "string" } }, "run_id": { "type": "string" }, "run_status": { "type": "string" } }, "required": [ "code", "message" ] }, "ErrorEnvelope": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/ErrorBody" } }, "required": [ "error" ] }, "Tool": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" }, "display_name": { "type": "string" }, "latest_version": { "type": "integer" }, "status": { "type": "string", "enum": [ "active", "deprecated" ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "name", "latest_version", "status", "created_at", "updated_at" ] }, "ToolCreate": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" }, "display_name": { "type": "string" }, "description": { "type": "string", "maxLength": 4000 }, "executor": { "type": "string", "enum": [ "application" ], "default": "application" }, "input_schema": { "type": "object" }, "output_schema": { "type": "object" }, "side_effect": { "type": "string", "enum": [ "none", "workspace_write", "external_write" ], "default": "none" }, "confirmation": { "type": "string", "enum": [ "never", "policy", "always" ], "default": "never" } }, "required": [ "name", "description", "input_schema", "output_schema" ] }, "ToolDefinition": { "type": "object", "properties": { "id": { "type": "string" }, "tool_id": { "type": "string" }, "name": { "type": "string" }, "version": { "type": "integer" }, "description": { "type": "string" }, "executor": { "type": "string", "enum": [ "application" ] }, "input_schema": { "type": "object" }, "output_schema": { "type": "object" }, "side_effect": { "type": "string", "enum": [ "none", "workspace_write", "external_write" ] }, "confirmation": { "type": "string", "enum": [ "never", "policy", "always" ] }, "content_hash": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "deprecated" ] }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "tool_id", "name", "version", "description", "executor", "input_schema", "output_schema", "side_effect", "confirmation", "status", "created_at" ] }, "ToolDefinitionCreate": { "type": "object", "properties": { "description": { "type": "string", "maxLength": 4000 }, "executor": { "type": "string", "enum": [ "application" ], "default": "application" }, "input_schema": { "type": "object" }, "output_schema": { "type": "object" }, "side_effect": { "type": "string", "enum": [ "none", "workspace_write", "external_write" ], "default": "none" }, "confirmation": { "type": "string", "enum": [ "never", "policy", "always" ], "default": "never" } }, "required": [ "description", "input_schema", "output_schema" ] }, "ToolDetail": { "type": "object", "properties": { "tool": { "$ref": "#/components/schemas/Tool" }, "definition": { "$ref": "#/components/schemas/ToolDefinition" } }, "required": [ "tool", "definition" ] }, "DeploymentCreate": { "type": "object", "additionalProperties": false, "properties": { "agent_id": { "type": "string" }, "agent_version": { "type": "integer", "minimum": 1 }, "tool_definition_ids": { "type": "array", "maxItems": 64, "uniqueItems": true, "items": { "type": "string" } }, "model": { "type": "string" }, "environment_id": { "type": "string" }, "application_tool_response_deadline_seconds": { "type": "integer", "minimum": 30, "maximum": 86400, "default": 1800 } }, "required": [ "agent_id" ] }, "DeploymentToolBinding": { "type": "object", "properties": { "tool_definition_id": { "type": "string" }, "tool_id": { "type": "string" }, "name": { "type": "string" }, "version": { "type": "integer" }, "content_hash": { "type": "string" }, "description": { "type": "string" }, "executor": { "type": "string" }, "input_schema": { "type": "object" }, "output_schema": { "type": "object" }, "side_effect": { "type": "string" }, "confirmation": { "type": "string" } }, "required": [ "tool_definition_id", "tool_id", "name", "version", "content_hash", "description", "executor", "input_schema", "output_schema", "side_effect", "confirmation" ] }, "Deployment": { "type": "object", "properties": { "id": { "type": "string" }, "agent_id": { "type": "string" }, "agent_revision_id": { "type": "string" }, "agent_version": { "type": "integer" }, "model": { "type": "string" }, "environment_id": { "type": "string", "nullable": true }, "application_tool_response_deadline_seconds": { "type": "integer" }, "prompt_policy_version": { "type": "string" }, "prompt_policy_hash": { "type": "string" }, "content_hash": { "type": "string" }, "source": { "type": "string" }, "status": { "type": "string" }, "tool_bindings": { "type": "array", "items": { "$ref": "#/components/schemas/DeploymentToolBinding" } }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "agent_id", "agent_revision_id", "agent_version", "model", "application_tool_response_deadline_seconds", "prompt_policy_version", "prompt_policy_hash", "content_hash", "source", "status", "tool_bindings", "created_at" ] }, "ToolBinding": { "type": "object", "properties": { "tool_definition_id": { "type": "string" }, "name": { "type": "string" }, "version": { "type": "integer" }, "definition_content_hash": { "type": "string" } }, "required": [ "tool_definition_id", "name", "version" ] }, "ToolExecutionError": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[A-Z][A-Z0-9_]{0,63}$" }, "message": { "type": "string", "maxLength": 2000 }, "retryable": { "type": "boolean", "default": false } }, "required": [ "code", "message" ] }, "AcceptedEventSummary": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "in_reply_to_event_id": { "type": "string" } }, "required": [ "id", "type", "in_reply_to_event_id" ] }, "ResumeAcceptedResponse": { "type": "object", "properties": { "run_id": { "type": "string" }, "status": { "type": "string", "enum": [ "waiting_for_input", "queued" ] }, "accepted_events": { "type": "array", "items": { "$ref": "#/components/schemas/AcceptedEventSummary" } }, "remaining_event_ids": { "type": "array", "items": { "type": "string" } } }, "required": [ "run_id", "status", "accepted_events", "remaining_event_ids" ] }, "RunCreateRequest": { "type": "object", "properties": { "events": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "required": [ "events" ] }, "EventEnvelope": { "type": "object", "properties": { "id": { "type": "string" }, "sequence": { "type": "integer" }, "type": { "type": "string", "description": "Event name. sandbox.recreated means the previous sandbox workspace was lost and a replacement was provisioned before agent execution." }, "workspace_id": { "type": "string" }, "session_id": { "type": "string" }, "run_id": { "type": "string" }, "in_reply_to_event_id": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "content": { "description": "Text events use an array of content blocks. Structured events use an object. run.started, run.completed, run.failed, session.status_idle, session.error, tool.started, tool.completed, tool.failed, and agent.custom_tool_use carry object content.", "oneOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": true } }, { "type": "object", "additionalProperties": true } ] }, "data": { "type": "object" } }, "examples": [ { "id": "evt_run_started", "sequence": 1, "type": "run.started", "workspace_id": "workspace_123", "session_id": "session_123", "run_id": "run_123", "created_at": "2026-09-03T12:00:00Z", "content": { "run_id": "run_123", "model": "openai/gpt-5" }, "data": { "run_id": "run_123", "model": "openai/gpt-5" } }, { "id": "evt_tool_started", "sequence": 2, "type": "tool.started", "workspace_id": "workspace_123", "session_id": "session_123", "run_id": "run_123", "created_at": "2026-09-03T12:00:01Z", "content": { "tool_call_id": "call_123", "name": "todo_ops", "input": { "operations": [ { "op": "add", "title": "Buy milk" } ] } }, "data": { "tool_call_id": "call_123", "name": "todo_ops" } }, { "id": "evt_custom_tool", "sequence": 3, "type": "agent.custom_tool_use", "workspace_id": "workspace_123", "session_id": "session_123", "run_id": "run_123", "created_at": "2026-09-03T12:00:02Z", "content": { "tool_call_id": "call_123", "pending_input_id": "5d1a4608909bd2230f0c39e6f0b4875b", "execution_idempotency_key": "evt_custom_tool", "name": "todo_ops", "input": { "operations": [ { "op": "add", "title": "Buy milk" } ] } }, "data": { "tool_call_id": "call_123", "pending_input_id": "5d1a4608909bd2230f0c39e6f0b4875b", "execution_idempotency_key": "evt_custom_tool", "name": "todo_ops" } }, { "id": "evt_tool_completed", "sequence": 4, "type": "tool.completed", "workspace_id": "workspace_123", "session_id": "session_123", "run_id": "run_123", "created_at": "2026-09-03T12:00:03Z", "content": { "tool_call_id": "call_123", "pending_input_id": "5d1a4608909bd2230f0c39e6f0b4875b", "name": "todo_ops", "output": { "applied": true } }, "data": { "tool_call_id": "call_123", "pending_input_id": "5d1a4608909bd2230f0c39e6f0b4875b", "name": "todo_ops" } }, { "id": "evt_tool_failed", "sequence": 5, "type": "tool.failed", "workspace_id": "workspace_123", "session_id": "session_123", "run_id": "run_123", "created_at": "2026-09-03T12:00:04Z", "content": { "tool_call_id": "call_123", "name": "todo_ops", "error": "Application tool failed" }, "data": { "tool_call_id": "call_123", "name": "todo_ops" } }, { "id": "evt_idle", "sequence": 6, "type": "session.status_idle", "workspace_id": "workspace_123", "session_id": "session_123", "run_id": "run_123", "created_at": "2026-09-03T12:00:05Z", "content": { "stop_reason": { "type": "requires_action", "event_ids": [ "evt_custom_tool" ] } }, "data": { "stop_reason": { "type": "requires_action", "event_ids": [ "evt_custom_tool" ] } } } ], "required": [ "id", "sequence", "type", "workspace_id", "session_id", "run_id", "created_at", "data" ] }, "ToolNameConflictDetail": { "type": "object", "properties": { "path": { "type": "string" }, "reason": { "type": "string" }, "tool_id": { "type": "string", "description": "Existing tool ID when a tool name already exists." }, "latest_version": { "type": "integer", "description": "Latest version of the existing tool." } }, "required": [ "path", "reason", "tool_id", "latest_version" ] }, "ToolNameConflictEnvelope": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "idempotency_conflict" ] }, "message": { "type": "string" }, "request_id": { "type": "string" }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/ToolNameConflictDetail" } }, "active_run_id": { "type": "string" }, "active_run_status": { "type": "string" }, "recovery": { "type": "array", "items": { "type": "string" } }, "run_id": { "type": "string" }, "run_status": { "type": "string" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] }, "BamiActionData": { "additionalProperties": false, "properties": { "action": { "enum": [ "verification_target_corrected", "test_created", "activate_proposed", "delete_proposed", "deprecate_proposed", "approval_decided", "activate_executed", "delete_executed", "deprecate_executed", "action_refused", "reply_evidence_offered", "reply_evidence_decided", "reply_evidence_read", "reply_evidence_refused" ], "title": "Action", "type": "string" }, "receipt_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Receipt Id" }, "target_id": { "title": "Target Id", "type": "string" }, "before": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Before" }, "after": { "additionalProperties": true, "title": "After", "type": "object" }, "outcome": { "title": "Outcome", "type": "string" } }, "required": [ "action", "receipt_id", "target_id", "before", "after", "outcome" ], "title": "ActionData", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiActionEvent": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "sequence": { "minimum": 1, "title": "Sequence", "type": "integer" }, "conversation_id": { "title": "Conversation Id", "type": "string" }, "run_id": { "format": "uuid", "title": "Run Id", "type": "string" }, "request_id": { "title": "Request Id", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "late": { "title": "Late", "type": "boolean" }, "usable_as_evidence": { "title": "Usable As Evidence", "type": "boolean" }, "type": { "const": "assistant.action", "title": "Type", "type": "string" }, "data": { "$ref": "#/components/schemas/BamiActionData" } }, "required": [ "id", "sequence", "conversation_id", "run_id", "request_id", "created_at", "late", "usable_as_evidence", "type", "data" ], "title": "ActionEvent", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiApprovalRecord": { "additionalProperties": false, "description": "Contract v5 frozen preview approval. The id is the blocking event ID.", "properties": { "id": { "description": "Public blocking event ID", "title": "Id", "type": "string" }, "workspace_id": { "format": "uuid", "title": "Workspace Id", "type": "string" }, "conversation_id": { "title": "Conversation Id", "type": "string" }, "requester_id": { "format": "uuid", "title": "Requester Id", "type": "string" }, "run_id": { "format": "uuid", "title": "Run Id", "type": "string" }, "request_id": { "title": "Request Id", "type": "string" }, "scope_generation": { "title": "Scope Generation", "type": "integer" }, "action": { "enum": [ "activate", "delete", "deprecate" ], "title": "Action", "type": "string" }, "agent_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Agent Id" }, "targets": { "items": { "additionalProperties": true, "type": "object" }, "title": "Targets", "type": "array" }, "frozen_payload": { "additionalProperties": true, "title": "Frozen Payload", "type": "object" }, "payload_hash": { "title": "Payload Hash", "type": "string" }, "state_hash": { "title": "State Hash", "type": "string" }, "checkpoint_id": { "title": "Checkpoint Id", "type": "string" }, "pending_input_id": { "title": "Pending Input Id", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "expires_at": { "format": "date-time", "title": "Expires At", "type": "string" }, "policy": { "additionalProperties": true, "title": "Policy", "type": "object" }, "decision": { "anyOf": [ { "enum": [ "allow", "deny" ], "type": "string" }, { "type": "null" } ], "title": "Decision" }, "decider_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Decider Id" }, "decided_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Decided At" }, "decision_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Decision Reason" }, "executor_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Executor Id" }, "outcome": { "enum": [ "pending", "rejected", "expired", "stale", "executed", "failed" ], "title": "Outcome", "type": "string" }, "execution_receipt_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Execution Receipt Id" }, "executed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Executed At" }, "refusal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Refusal Code" }, "refusal_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Refusal Reason" }, "refused_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Refused At" }, "executable": { "default": false, "title": "Executable", "type": "boolean" }, "executable_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Executable Reason" } }, "required": [ "id", "workspace_id", "conversation_id", "requester_id", "run_id", "request_id", "scope_generation", "action", "agent_id", "targets", "frozen_payload", "payload_hash", "state_hash", "checkpoint_id", "pending_input_id", "created_at", "expires_at", "policy", "decision", "decider_id", "decided_at", "decision_reason", "executor_id", "outcome", "execution_receipt_id", "executed_at", "refusal_code", "refusal_reason", "refused_at" ], "title": "ApprovalRecord", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiAttempt": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "node_id": { "title": "Node Id", "type": "string" }, "call_id": { "title": "Call Id", "type": "string" }, "attempt_number": { "minimum": 1, "title": "Attempt Number", "type": "integer" }, "arguments": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Arguments" }, "original_redacted_output": { "anyOf": [ {}, { "type": "null" } ], "title": "Original Redacted Output" }, "arguments_content_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Arguments Content Id" }, "output_content_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Output Content Id" }, "source_reference": { "$ref": "#/components/schemas/BamiSourceReference" }, "coverage": { "$ref": "#/components/schemas/BamiCoverage" }, "admission_order": { "title": "Admission Order", "type": "integer" }, "start_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Start Order" }, "completion_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Completion Order" }, "admitted_at": { "format": "date-time", "title": "Admitted At", "type": "string" }, "started_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Started At" }, "completed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Completed At" }, "status": { "enum": [ "queued", "running", "completed", "failed", "skipped", "cancelled", "timed_out" ], "title": "Status", "type": "string" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "late": { "title": "Late", "type": "boolean" }, "usable_as_evidence": { "title": "Usable As Evidence", "type": "boolean" } }, "required": [ "id", "node_id", "call_id", "attempt_number", "arguments", "original_redacted_output", "arguments_content_id", "output_content_id", "source_reference", "coverage", "admission_order", "start_order", "completion_order", "admitted_at", "started_at", "completed_at", "status", "reason", "late", "usable_as_evidence" ], "title": "Attempt", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiAvailability": { "additionalProperties": false, "properties": { "available": { "title": "Available", "type": "boolean" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "content_retention_days": { "maximum": 90, "minimum": 1, "title": "Content Retention Days", "type": "integer" }, "disclosure": { "title": "Disclosure", "type": "string" } }, "required": [ "available", "reason", "content_retention_days", "disclosure" ], "title": "Availability", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiCancelledData": { "additionalProperties": false, "properties": { "graph_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Graph Id" }, "receipt_id": { "title": "Receipt Id", "type": "string" }, "reason": { "enum": [ "cancelled by operator", "cancelled by scope switch", "cancelled by deletion", "cancelled by permission loss" ], "title": "Reason", "type": "string" }, "scope_generation": { "title": "Scope Generation", "type": "integer" }, "unfinished_node_ids": { "items": { "type": "string" }, "title": "Unfinished Node Ids", "type": "array" }, "reservations_released": { "title": "Reservations Released", "type": "boolean" } }, "required": [ "graph_id", "receipt_id", "reason", "scope_generation", "unfinished_node_ids", "reservations_released" ], "title": "CancelledData", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiCancelledEvent": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "sequence": { "minimum": 1, "title": "Sequence", "type": "integer" }, "conversation_id": { "title": "Conversation Id", "type": "string" }, "run_id": { "format": "uuid", "title": "Run Id", "type": "string" }, "request_id": { "title": "Request Id", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "late": { "title": "Late", "type": "boolean" }, "usable_as_evidence": { "title": "Usable As Evidence", "type": "boolean" }, "type": { "const": "assistant.cancelled", "title": "Type", "type": "string" }, "data": { "$ref": "#/components/schemas/BamiCancelledData" } }, "required": [ "id", "sequence", "conversation_id", "run_id", "request_id", "created_at", "late", "usable_as_evidence", "type", "data" ], "title": "CancelledEvent", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiCheckerData": { "additionalProperties": false, "properties": { "graph_id": { "title": "Graph Id", "type": "string" }, "decision": { "$ref": "#/components/schemas/BamiCheckerDecision" } }, "required": [ "graph_id", "decision" ], "title": "CheckerData", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiCheckerDecision": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "attempt_id": { "title": "Attempt Id", "type": "string" }, "source_id": { "title": "Source Id", "type": "string" }, "status": { "enum": [ "accepted", "rejected" ], "title": "Status", "type": "string" }, "check_kind": { "enum": [ "deterministic", "model" ], "title": "Check Kind", "type": "string" }, "category": { "enum": [ "usable", "empty", "malformed", "off_target", "timed_out", "reply_empty", "off_topic", "contradiction", "reply_language_mismatch", "low_confidence" ], "title": "Category", "type": "string" }, "reason": { "title": "Reason", "type": "string" }, "conflicting_source_ids": { "items": { "type": "string" }, "title": "Conflicting Source Ids", "type": "array" }, "report_reference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Report Reference" }, "model_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Version" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" } }, "required": [ "id", "attempt_id", "source_id", "status", "check_kind", "category", "reason", "conflicting_source_ids", "report_reference", "model_version", "created_at" ], "title": "CheckerDecision", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiCheckerEvent": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "sequence": { "minimum": 1, "title": "Sequence", "type": "integer" }, "conversation_id": { "title": "Conversation Id", "type": "string" }, "run_id": { "format": "uuid", "title": "Run Id", "type": "string" }, "request_id": { "title": "Request Id", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "late": { "title": "Late", "type": "boolean" }, "usable_as_evidence": { "title": "Usable As Evidence", "type": "boolean" }, "type": { "const": "assistant.checker", "title": "Type", "type": "string" }, "data": { "$ref": "#/components/schemas/BamiCheckerData" } }, "required": [ "id", "sequence", "conversation_id", "run_id", "request_id", "created_at", "late", "usable_as_evidence", "type", "data" ], "title": "CheckerEvent", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiCompletedData": { "additionalProperties": false, "properties": { "graph_id": { "title": "Graph Id", "type": "string" }, "receipt_ids": { "items": { "type": "string" }, "title": "Receipt Ids", "type": "array" }, "outcome": { "enum": [ "diagnosed", "inconclusive", "passed", "failed", "waiting" ], "title": "Outcome", "type": "string" }, "summary_content_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Summary Content Id" }, "accepted_source_ids": { "items": { "type": "string" }, "title": "Accepted Source Ids", "type": "array" } }, "required": [ "graph_id", "receipt_ids", "outcome", "summary_content_id", "accepted_source_ids" ], "title": "CompletedData", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiCompletedEvent": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "sequence": { "minimum": 1, "title": "Sequence", "type": "integer" }, "conversation_id": { "title": "Conversation Id", "type": "string" }, "run_id": { "format": "uuid", "title": "Run Id", "type": "string" }, "request_id": { "title": "Request Id", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "late": { "title": "Late", "type": "boolean" }, "usable_as_evidence": { "title": "Usable As Evidence", "type": "boolean" }, "type": { "const": "assistant.completed", "title": "Type", "type": "string" }, "data": { "$ref": "#/components/schemas/BamiCompletedData" } }, "required": [ "id", "sequence", "conversation_id", "run_id", "request_id", "created_at", "late", "usable_as_evidence", "type", "data" ], "title": "CompletedEvent", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiConversation": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "workspace_id": { "format": "uuid", "title": "Workspace Id", "type": "string" }, "user_id": { "format": "uuid", "title": "User Id", "type": "string" }, "session_id": { "format": "uuid", "title": "Session Id", "type": "string" }, "scope": { "$ref": "#/components/schemas/BamiScope" }, "scope_generation": { "minimum": 0, "title": "Scope Generation", "type": "integer" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "active_run_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Active Run Id" }, "release_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Release Id" }, "model_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Version" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "deleted_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Deleted At" }, "expires_at": { "format": "date-time", "title": "Expires At", "type": "string" }, "cancellation_receipt_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cancellation Receipt Id" }, "availability": { "$ref": "#/components/schemas/BamiAvailability" } }, "required": [ "id", "workspace_id", "user_id", "session_id", "scope", "scope_generation", "title", "active_run_id", "release_id", "model_version", "created_at", "updated_at", "deleted_at", "expires_at", "cancellation_receipt_id", "availability" ], "title": "Conversation", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiConversationCreate": { "additionalProperties": false, "properties": { "title": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "default": null, "title": "Title" }, "scope": { "$ref": "#/components/schemas/BamiScope" } }, "required": [ "scope" ], "title": "ConversationCreate", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiCoverage": { "additionalProperties": false, "properties": { "status": { "enum": [ "complete", "partial", "missing", "unavailable", "ambiguous" ], "title": "Status", "type": "string" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request Id" }, "session_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Session Id" }, "run_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Run Id" }, "deployment_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deployment Id" }, "agent_revision_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agent Revision Id" }, "contract_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Contract Version" }, "from_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "From Time" }, "to_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "To Time" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expires At" } }, "required": [ "status", "reason", "request_id", "session_id", "run_id", "deployment_id", "agent_revision_id", "contract_version", "from_time", "to_time", "next_cursor", "expires_at" ], "title": "Coverage", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiDeltaData": { "additionalProperties": false, "properties": { "text": { "title": "Text", "type": "string" }, "scope_generation": { "title": "Scope Generation", "type": "integer" } }, "required": [ "text", "scope_generation" ], "title": "DeltaData", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiDeltaEvent": { "additionalProperties": false, "properties": { "conversation_id": { "title": "Conversation Id", "type": "string" }, "run_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Run Id" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request Id" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "type": { "const": "assistant.delta", "title": "Type", "type": "string" }, "data": { "$ref": "#/components/schemas/BamiDeltaData" } }, "required": [ "conversation_id", "run_id", "request_id", "created_at", "type", "data" ], "title": "DeltaEvent", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiEvaluationReceipt": { "additionalProperties": false, "properties": { "dataset_id": { "title": "Dataset Id", "type": "string" }, "dataset_hash": { "title": "Dataset Hash", "type": "string" }, "model_version": { "title": "Model Version", "type": "string" }, "checker_implementation_hash": { "title": "Checker Implementation Hash", "type": "string" }, "case_count": { "minimum": 40, "title": "Case Count", "type": "integer" }, "bad_cases": { "exclusiveMinimum": 0, "title": "Bad Cases", "type": "integer" }, "good_cases": { "exclusiveMinimum": 0, "title": "Good Cases", "type": "integer" }, "false_acceptances": { "minimum": 0, "title": "False Acceptances", "type": "integer" }, "false_rejections": { "minimum": 0, "title": "False Rejections", "type": "integer" }, "false_acceptance_rate": { "title": "False Acceptance Rate", "type": "number" }, "false_rejection_rate": { "title": "False Rejection Rate", "type": "number" }, "max_false_acceptance_rate": { "default": 0.05, "title": "Max False Acceptance Rate", "type": "number" }, "max_false_rejection_rate": { "default": 0.1, "title": "Max False Rejection Rate", "type": "number" }, "source_latency_ms": { "additionalProperties": { "type": "number" }, "title": "Source Latency Ms", "type": "object" }, "turn_latency_ms": { "additionalProperties": { "type": "number" }, "title": "Turn Latency Ms", "type": "object" }, "input_tokens": { "title": "Input Tokens", "type": "integer" }, "output_tokens": { "title": "Output Tokens", "type": "integer" }, "estimated_usd": { "anyOf": [ { "type": "number" }, { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" } ], "title": "Estimated Usd" }, "includes_parallel_checks": { "title": "Includes Parallel Checks", "type": "boolean" }, "includes_retries": { "title": "Includes Retries", "type": "boolean" }, "includes_synthesis": { "title": "Includes Synthesis", "type": "boolean" }, "source_deadline_seconds": { "default": 15, "title": "Source Deadline Seconds", "type": "integer" }, "turn_deadline_seconds": { "default": 90, "title": "Turn Deadline Seconds", "type": "integer" }, "budget_check_passed": { "title": "Budget Check Passed", "type": "boolean" }, "passed": { "title": "Passed", "type": "boolean" }, "measured_at": { "format": "date-time", "title": "Measured At", "type": "string" } }, "required": [ "dataset_id", "dataset_hash", "model_version", "checker_implementation_hash", "case_count", "bad_cases", "good_cases", "false_acceptances", "false_rejections", "false_acceptance_rate", "false_rejection_rate", "source_latency_ms", "turn_latency_ms", "input_tokens", "output_tokens", "estimated_usd", "includes_parallel_checks", "includes_retries", "includes_synthesis", "budget_check_passed", "passed", "measured_at" ], "title": "EvaluationReceipt", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiEvents": { "additionalProperties": false, "properties": { "data": { "items": { "discriminator": { "mapping": { "assistant.action": "#/components/schemas/BamiActionEvent", "assistant.cancelled": "#/components/schemas/BamiCancelledEvent", "assistant.checker": "#/components/schemas/BamiCheckerEvent", "assistant.completed": "#/components/schemas/BamiCompletedEvent", "assistant.delta": "#/components/schemas/BamiDeltaEvent", "assistant.evidence": "#/components/schemas/BamiEvidenceEvent", "assistant.failed": "#/components/schemas/BamiFailedEvent", "stream.resync": "#/components/schemas/BamiResyncEvent" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/BamiEvidenceEvent" }, { "$ref": "#/components/schemas/BamiCheckerEvent" }, { "$ref": "#/components/schemas/BamiActionEvent" }, { "$ref": "#/components/schemas/BamiCompletedEvent" }, { "$ref": "#/components/schemas/BamiFailedEvent" }, { "$ref": "#/components/schemas/BamiCancelledEvent" }, { "$ref": "#/components/schemas/BamiDeltaEvent" }, { "$ref": "#/components/schemas/BamiResyncEvent" } ] }, "title": "Data", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "data", "next_cursor" ], "title": "Events", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiEvidenceData": { "additionalProperties": false, "properties": { "graph_id": { "title": "Graph Id", "type": "string" }, "node_id": { "title": "Node Id", "type": "string" }, "attempt_id": { "title": "Attempt Id", "type": "string" }, "source": { "$ref": "#/components/schemas/BamiSourceReference" }, "coverage": { "$ref": "#/components/schemas/BamiCoverage" }, "decision_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Decision Id" }, "usable": { "title": "Usable", "type": "boolean" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "late": { "title": "Late", "type": "boolean" }, "excerpt": { "anyOf": [ { "$ref": "#/components/schemas/BamiReplyExcerpt" }, { "type": "null" } ], "default": null, "description": "Reply excerpt for a session_run evidence event. Optional and never required: null when the source carries no reply text, and absent from events recorded before contract version 5. The served response schema omits the null default that the frozen Bami component states; both leave excerpt out of required, so read it as absent or null." } }, "required": [ "graph_id", "node_id", "attempt_id", "source", "coverage", "decision_id", "usable", "reason", "late" ], "title": "EvidenceData", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiEvidenceEvent": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "sequence": { "minimum": 1, "title": "Sequence", "type": "integer" }, "conversation_id": { "title": "Conversation Id", "type": "string" }, "run_id": { "format": "uuid", "title": "Run Id", "type": "string" }, "request_id": { "title": "Request Id", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "late": { "title": "Late", "type": "boolean" }, "usable_as_evidence": { "title": "Usable As Evidence", "type": "boolean" }, "type": { "const": "assistant.evidence", "title": "Type", "type": "string" }, "data": { "$ref": "#/components/schemas/BamiEvidenceData" } }, "required": [ "id", "sequence", "conversation_id", "run_id", "request_id", "created_at", "late", "usable_as_evidence", "type", "data" ], "title": "EvidenceEvent", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiExecutorDeclaration": { "additionalProperties": false, "properties": { "tool_id": { "title": "Tool Id", "type": "string" }, "tool_definition_id": { "title": "Tool Definition Id", "type": "string" }, "definition_hash": { "title": "Definition Hash", "type": "string" }, "mode": { "enum": [ "application_live", "stubbed" ], "title": "Mode", "type": "string" }, "stub": { "anyOf": [ { "$ref": "#/components/schemas/BamiToolStub" }, { "type": "null" } ] }, "consequential": { "const": false, "default": false, "title": "Consequential", "type": "boolean" } }, "required": [ "tool_id", "tool_definition_id", "definition_hash", "mode", "stub" ], "title": "ExecutorDeclaration", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiFailedData": { "additionalProperties": false, "properties": { "graph_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Graph Id" }, "receipt_id": { "title": "Receipt Id", "type": "string" }, "code": { "title": "Code", "type": "string" }, "reason": { "title": "Reason", "type": "string" }, "retryable": { "title": "Retryable", "type": "boolean" }, "outcome": { "enum": [ "failed", "timed_out" ], "title": "Outcome", "type": "string" } }, "required": [ "graph_id", "receipt_id", "code", "reason", "retryable", "outcome" ], "title": "FailedData", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiFailedEvent": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "sequence": { "minimum": 1, "title": "Sequence", "type": "integer" }, "conversation_id": { "title": "Conversation Id", "type": "string" }, "run_id": { "format": "uuid", "title": "Run Id", "type": "string" }, "request_id": { "title": "Request Id", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "late": { "title": "Late", "type": "boolean" }, "usable_as_evidence": { "title": "Usable As Evidence", "type": "boolean" }, "type": { "const": "assistant.failed", "title": "Type", "type": "string" }, "data": { "$ref": "#/components/schemas/BamiFailedData" } }, "required": [ "id", "sequence", "conversation_id", "run_id", "request_id", "created_at", "late", "usable_as_evidence", "type", "data" ], "title": "FailedEvent", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiGraph": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "conversation_id": { "title": "Conversation Id", "type": "string" }, "run_id": { "format": "uuid", "title": "Run Id", "type": "string" }, "request_id": { "title": "Request Id", "type": "string" }, "version": { "const": 1, "title": "Version", "type": "integer" }, "scope_generation": { "title": "Scope Generation", "type": "integer" }, "target": { "$ref": "#/components/schemas/BamiScope" }, "target_coverage": { "$ref": "#/components/schemas/BamiCoverage" }, "limits": { "$ref": "#/components/schemas/BamiTurnLimits" }, "release_id": { "title": "Release Id", "type": "string" }, "model_version": { "title": "Model Version", "type": "string" }, "status": { "title": "Status", "type": "string" }, "source_deadline_seconds": { "title": "Source Deadline Seconds", "type": "integer" }, "turn_deadline_at": { "format": "date-time", "title": "Turn Deadline At", "type": "string" }, "nodes": { "items": { "$ref": "#/components/schemas/BamiNode" }, "title": "Nodes", "type": "array" }, "optional_round": { "$ref": "#/components/schemas/BamiOptionalRound" }, "synthesis": { "anyOf": [ { "$ref": "#/components/schemas/BamiSynthesis" }, { "type": "null" } ] }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "completed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Completed At" }, "expires_at": { "format": "date-time", "title": "Expires At", "type": "string" } }, "required": [ "id", "conversation_id", "run_id", "request_id", "version", "scope_generation", "target", "target_coverage", "limits", "release_id", "model_version", "status", "source_deadline_seconds", "turn_deadline_at", "nodes", "optional_round", "synthesis", "created_at", "completed_at", "expires_at" ], "title": "Graph", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiMessageAccepted": { "additionalProperties": false, "properties": { "conversation_id": { "title": "Conversation Id", "type": "string" }, "run_id": { "format": "uuid", "title": "Run Id", "type": "string" }, "status": { "enum": [ "queued", "running", "completed", "failed", "cancelled", "timed_out" ], "title": "Status", "type": "string" } }, "required": [ "conversation_id", "run_id", "status" ], "title": "MessageAccepted", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiMessageCreate": { "additionalProperties": false, "properties": { "content": { "maxLength": 32000, "minLength": 1, "title": "Content", "type": "string" }, "scope_generation": { "minimum": 0, "title": "Scope Generation", "type": "integer" }, "client_message_id": { "maxLength": 64, "minLength": 1, "title": "Client Message Id", "type": "string" } }, "required": [ "content", "scope_generation", "client_message_id" ], "title": "MessageCreate", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiNode": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "key": { "title": "Key", "type": "string" }, "kind": { "enum": [ "resolve", "gather", "checker", "optional_round", "synthesis" ], "title": "Kind", "type": "string" }, "dependencies": { "items": { "type": "string" }, "title": "Dependencies", "type": "array" }, "planned_inputs": { "additionalProperties": true, "title": "Planned Inputs", "type": "object" }, "status": { "enum": [ "planned", "running", "completed", "failed", "skipped", "cancelled", "timed_out" ], "title": "Status", "type": "string" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "source_deadline_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Source Deadline At" }, "attempts": { "items": { "$ref": "#/components/schemas/BamiAttempt" }, "title": "Attempts", "type": "array" }, "checker_decisions": { "items": { "$ref": "#/components/schemas/BamiCheckerDecision" }, "title": "Checker Decisions", "type": "array" } }, "required": [ "id", "key", "kind", "dependencies", "planned_inputs", "status", "reason", "source_deadline_at", "attempts", "checker_decisions" ], "title": "Node", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiOptionalRound": { "additionalProperties": false, "properties": { "max_rounds": { "const": 1, "default": 1, "title": "Max Rounds", "type": "integer" }, "status": { "enum": [ "planned", "chosen", "completed", "skipped", "cancelled" ], "title": "Status", "type": "string" }, "trigger_source_ids": { "items": { "type": "string" }, "title": "Trigger Source Ids", "type": "array" }, "checker_decision_ids": { "items": { "type": "string" }, "title": "Checker Decision Ids", "type": "array" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "chosen_inputs": { "additionalProperties": { "additionalProperties": true, "type": "object" }, "title": "Chosen Inputs", "type": "object" }, "recorded_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Recorded At" } }, "required": [ "status", "trigger_source_ids", "checker_decision_ids", "reason", "chosen_inputs", "recorded_at" ], "title": "OptionalRound", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiPreferences": { "additionalProperties": false, "properties": { "opted_out": { "title": "Opted Out", "type": "boolean" } }, "required": [ "opted_out" ], "title": "Preferences", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiReceipt": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "kind": { "enum": [ "verification", "cancellation", "timeout", "action" ], "title": "Kind", "type": "string" }, "workspace_id": { "format": "uuid", "title": "Workspace Id", "type": "string" }, "creator_id": { "format": "uuid", "title": "Creator Id", "type": "string" }, "conversation_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Conversation Id" }, "request_id": { "title": "Request Id", "type": "string" }, "session_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Session Id" }, "run_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Run Id" }, "via": { "anyOf": [ { "const": "assistant", "type": "string" }, { "type": "null" } ], "title": "Via" }, "label": { "title": "Label", "type": "string" }, "outcome": { "enum": [ "queued", "running", "passed", "failed", "waiting", "inconclusive", "cancelled", "timed_out" ], "title": "Outcome", "type": "string" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "agent_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Agent Id" }, "agent_revision_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agent Revision Id" }, "agent_revision": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Agent Revision" }, "deployment_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deployment Id" }, "deployment_hash": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deployment Hash" }, "draft_id": { "default": null, "title": "Draft Id", "type": "null" }, "draft_revision": { "default": null, "title": "Draft Revision", "type": "null" }, "draft_hash": { "default": null, "title": "Draft Hash", "type": "null" }, "test_snapshot_id": { "default": null, "title": "Test Snapshot Id", "type": "null" }, "test_snapshot_hash": { "default": null, "title": "Test Snapshot Hash", "type": "null" }, "runtime_profile_version": { "default": null, "title": "Runtime Profile Version", "type": "null" }, "unavailable": { "additionalProperties": { "type": "string" }, "title": "Unavailable", "type": "object" }, "effective_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Effective Model" }, "environment_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Environment Id" }, "prompt_policy_hash": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prompt Policy Hash" }, "executors": { "items": { "$ref": "#/components/schemas/BamiExecutorDeclaration" }, "title": "Executors", "type": "array" }, "input": { "anyOf": [ {}, { "type": "null" } ], "title": "Input" }, "assertions": { "anyOf": [ { "items": { "discriminator": { "mapping": { "event_present": "#/components/schemas/BamiEventPresent", "final_text_contains": "#/components/schemas/BamiFinalTextContains", "final_text_matches": "#/components/schemas/BamiFinalTextMatches", "json_path_equals": "#/components/schemas/BamiJsonPathEquals", "outcome_is": "#/components/schemas/BamiOutcomeIs", "tool_called": "#/components/schemas/BamiToolCalled", "tool_not_called": "#/components/schemas/BamiToolNotCalled" }, "propertyName": "kind" }, "oneOf": [ { "$ref": "#/components/schemas/BamiFinalTextContains" }, { "$ref": "#/components/schemas/BamiFinalTextMatches" }, { "$ref": "#/components/schemas/BamiToolCalled" }, { "$ref": "#/components/schemas/BamiToolNotCalled" }, { "$ref": "#/components/schemas/BamiEventPresent" }, { "$ref": "#/components/schemas/BamiJsonPathEquals" }, { "$ref": "#/components/schemas/BamiOutcomeIs" } ] }, "type": "array" }, { "type": "null" } ], "title": "Assertions" }, "permitted_overrides": { "additionalProperties": true, "title": "Permitted Overrides", "type": "object" }, "output_references": { "items": { "type": "string" }, "title": "Output References", "type": "array" }, "event_references": { "items": { "type": "string" }, "title": "Event References", "type": "array" }, "content_hashes": { "additionalProperties": { "type": "string" }, "title": "Content Hashes", "type": "object" }, "usage": { "$ref": "#/components/schemas/BamiUsage" }, "remaining_local_change": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Remaining Local Change" }, "proof_limits": { "items": { "type": "string" }, "title": "Proof Limits", "type": "array" }, "memory_isolated": { "const": true, "default": true, "title": "Memory Isolated", "type": "boolean" }, "usage_disclosed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Usage Disclosed At" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "completed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Completed At" }, "content_expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Content Expires At" }, "content_deleted_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Content Deleted At" }, "audit_expires_at": { "format": "date-time", "title": "Audit Expires At", "type": "string" } }, "required": [ "id", "kind", "workspace_id", "creator_id", "conversation_id", "request_id", "session_id", "run_id", "via", "label", "outcome", "reason", "agent_id", "agent_revision_id", "agent_revision", "deployment_id", "deployment_hash", "unavailable", "effective_model", "environment_id", "prompt_policy_hash", "executors", "input", "assertions", "permitted_overrides", "output_references", "event_references", "content_hashes", "usage", "remaining_local_change", "proof_limits", "usage_disclosed_at", "created_at", "completed_at", "content_expires_at", "content_deleted_at", "audit_expires_at" ], "title": "Receipt", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiResyncData": { "additionalProperties": false, "properties": { "reason": { "title": "Reason", "type": "string" }, "last_durable_event_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Durable Event Id" }, "reload_required": { "const": true, "default": true, "title": "Reload Required", "type": "boolean" } }, "required": [ "reason", "last_durable_event_id" ], "title": "ResyncData", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiResyncEvent": { "additionalProperties": false, "properties": { "conversation_id": { "title": "Conversation Id", "type": "string" }, "run_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Run Id" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request Id" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "type": { "const": "stream.resync", "title": "Type", "type": "string" }, "data": { "$ref": "#/components/schemas/BamiResyncData" } }, "required": [ "conversation_id", "run_id", "request_id", "created_at", "type", "data" ], "title": "ResyncEvent", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiScope": { "additionalProperties": false, "properties": { "workspace_id": { "format": "uuid", "title": "Workspace Id", "type": "string" }, "agent_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Agent Id" }, "deployment_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deployment Id" }, "release_stage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Release Stage" }, "release_stage_unavailable_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Release Stage Unavailable Reason" } }, "required": [ "workspace_id", "agent_id", "deployment_id", "release_stage", "release_stage_unavailable_reason" ], "title": "Scope", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiScopeSwitch": { "additionalProperties": false, "properties": { "scope": { "$ref": "#/components/schemas/BamiScope" }, "expected_generation": { "minimum": 0, "title": "Expected Generation", "type": "integer" } }, "required": [ "scope", "expected_generation" ], "title": "ScopeSwitch", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiSourceReference": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "kind": { "enum": [ "audit", "session_run", "timeline", "deployment", "error", "docs" ], "title": "Kind", "type": "string" }, "resource_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resource Id" }, "href": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Href" }, "content_hash": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content Hash" } }, "required": [ "id", "kind", "resource_id", "href", "content_hash" ], "title": "SourceReference", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiSynthesis": { "additionalProperties": false, "properties": { "outcome": { "enum": [ "diagnosed", "inconclusive", "timed_out", "cancelled" ], "title": "Outcome", "type": "string" }, "accepted_source_ids": { "items": { "type": "string" }, "title": "Accepted Source Ids", "type": "array" }, "checker_report_ids": { "items": { "type": "string" }, "title": "Checker Report Ids", "type": "array" }, "summary_content_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Summary Content Id" }, "remaining_uncertainty": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Remaining Uncertainty" } }, "required": [ "outcome", "accepted_source_ids", "checker_report_ids", "summary_content_id", "remaining_uncertainty" ], "title": "Synthesis", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiTestCreate": { "additionalProperties": false, "properties": { "deployment_id": { "maxLength": 64, "minLength": 1, "title": "Deployment Id", "type": "string" }, "title": { "maxLength": 200, "minLength": 1, "title": "Title", "type": "string" }, "input": { "title": "Input" }, "assertions": { "items": { "discriminator": { "mapping": { "event_present": "#/components/schemas/BamiEventPresent", "final_text_contains": "#/components/schemas/BamiFinalTextContains", "final_text_matches": "#/components/schemas/BamiFinalTextMatches", "json_path_equals": "#/components/schemas/BamiJsonPathEquals", "outcome_is": "#/components/schemas/BamiOutcomeIs", "tool_called": "#/components/schemas/BamiToolCalled", "tool_not_called": "#/components/schemas/BamiToolNotCalled" }, "propertyName": "kind" }, "oneOf": [ { "$ref": "#/components/schemas/BamiFinalTextContains" }, { "$ref": "#/components/schemas/BamiFinalTextMatches" }, { "$ref": "#/components/schemas/BamiToolCalled" }, { "$ref": "#/components/schemas/BamiToolNotCalled" }, { "$ref": "#/components/schemas/BamiEventPresent" }, { "$ref": "#/components/schemas/BamiJsonPathEquals" }, { "$ref": "#/components/schemas/BamiOutcomeIs" } ] }, "title": "Assertions", "type": "array" }, "executor_mode": { "enum": [ "application", "stubbed", "mixed" ], "title": "Executor Mode", "type": "string" }, "tool_stubs": { "additionalProperties": { "$ref": "#/components/schemas/BamiToolStub" }, "title": "Tool Stubs", "type": "object" } }, "required": [ "deployment_id", "title", "input", "assertions", "executor_mode", "tool_stubs" ], "title": "TestCreate", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiToolStub": { "additionalProperties": false, "properties": { "provenance": { "enum": [ "builder_declared", "definition_example" ], "title": "Provenance", "type": "string" }, "tool_definition_id": { "title": "Tool Definition Id", "type": "string" }, "definition_hash": { "title": "Definition Hash", "type": "string" }, "example_pointer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Example Pointer" }, "output": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Output" } }, "required": [ "provenance", "tool_definition_id", "definition_hash" ], "title": "ToolStub", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiTurnLimits": { "additionalProperties": false, "properties": { "max_tool_calls_per_turn": { "default": 24, "title": "Max Tool Calls Per Turn", "type": "integer" }, "max_concurrent_tool_calls": { "default": 4, "title": "Max Concurrent Tool Calls", "type": "integer" }, "source_deadline_seconds": { "default": 15, "title": "Source Deadline Seconds", "type": "integer" }, "turn_deadline_seconds": { "default": 90, "title": "Turn Deadline Seconds", "type": "integer" }, "synthesis_reserve_seconds": { "default": 5, "title": "Synthesis Reserve Seconds", "type": "integer" } }, "title": "TurnLimits", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiUsage": { "additionalProperties": false, "properties": { "input_tokens": { "minimum": 0, "title": "Input Tokens", "type": "integer" }, "output_tokens": { "minimum": 0, "title": "Output Tokens", "type": "integer" }, "usd": { "anyOf": [ { "type": "number" }, { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "title": "Usd" }, "unavailable_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unavailable Reason" }, "payer": { "enum": [ "platform", "tenant" ], "title": "Payer", "type": "string" } }, "required": [ "input_tokens", "output_tokens", "usd", "unavailable_reason", "payer" ], "title": "Usage", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiAdminSession": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "user_id": { "format": "uuid", "title": "User Id", "type": "string" }, "mfa_verified_at": { "format": "date-time", "title": "Mfa Verified At", "type": "string" }, "expires_at": { "format": "date-time", "title": "Expires At", "type": "string" }, "csrf_token": { "title": "Csrf Token", "type": "string" } }, "required": [ "id", "user_id", "mfa_verified_at", "expires_at", "csrf_token" ], "title": "AdminSession", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiArtifactResponse": { "properties": { "id": { "title": "Id", "type": "string" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tenant Id" }, "session_id": { "title": "Session Id", "type": "string" }, "run_id": { "title": "Run Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "filename": { "title": "Filename", "type": "string" }, "artifact_type": { "title": "Artifact Type", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "s3_prefix": { "title": "S3 Prefix", "type": "string" }, "is_directory": { "default": false, "title": "Is Directory", "type": "boolean" }, "entry_point": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Entry Point" }, "file_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "File Count" }, "size": { "default": 0, "title": "Size", "type": "integer" }, "content_type": { "default": "application/octet-stream", "title": "Content Type", "type": "string" }, "files": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Files" }, "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Created At" } }, "required": [ "id", "session_id", "run_id", "name", "filename", "artifact_type", "s3_prefix" ], "title": "ArtifactResponse", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiAuditRecordRead": { "properties": { "id": { "title": "Id", "type": "string" }, "workspace_id": { "title": "Workspace Id", "type": "string" }, "actor_id": { "title": "Actor Id", "type": "string" }, "action": { "title": "Action", "type": "string" }, "resource_type": { "title": "Resource Type", "type": "string" }, "resource_id": { "title": "Resource Id", "type": "string" }, "session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Session Id" }, "run_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Run Id" }, "event_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Event Id" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Request Id" }, "ip_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Ip Address" }, "details": { "additionalProperties": true, "title": "Details", "type": "object" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" } }, "required": [ "id", "workspace_id", "actor_id", "action", "resource_type", "resource_id", "created_at" ], "title": "AuditRecordRead", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiConfigurationAudit": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "actor_id": { "format": "uuid", "title": "Actor Id", "type": "string" }, "action": { "title": "Action", "type": "string" }, "resource_type": { "title": "Resource Type", "type": "string" }, "resource_id": { "title": "Resource Id", "type": "string" }, "reason": { "title": "Reason", "type": "string" }, "expected_revision": { "minimum": 0, "title": "Expected Revision", "type": "integer" }, "observed_revision": { "minimum": 0, "title": "Observed Revision", "type": "integer" }, "previous_values": { "additionalProperties": true, "title": "Previous Values", "type": "object" }, "new_values": { "additionalProperties": true, "title": "New Values", "type": "object" }, "outcome": { "enum": [ "applied", "rejected" ], "title": "Outcome", "type": "string" }, "request_id": { "title": "Request Id", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "expires_at": { "format": "date-time", "title": "Expires At", "type": "string" } }, "required": [ "id", "actor_id", "action", "resource_type", "resource_id", "reason", "expected_revision", "observed_revision", "previous_values", "new_values", "outcome", "request_id", "created_at", "expires_at" ], "title": "ConfigurationAudit", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiDiagnosticCoverage": { "additionalProperties": false, "properties": { "audit": { "$ref": "#/components/schemas/BamiCoverage" }, "sessions": { "$ref": "#/components/schemas/BamiCoverage" }, "runs": { "$ref": "#/components/schemas/BamiCoverage" }, "events": { "$ref": "#/components/schemas/BamiCoverage" } }, "required": [ "audit", "sessions", "runs", "events" ], "title": "DiagnosticCoverage", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiDiagnosticCursors": { "additionalProperties": false, "properties": { "audit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Audit" }, "sessions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sessions" }, "runs": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Runs" }, "events": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Events" } }, "required": [ "audit", "sessions", "runs", "events" ], "title": "DiagnosticCursors", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiDiagnosticLookup": { "additionalProperties": false, "properties": { "target": { "anyOf": [ { "$ref": "#/components/schemas/BamiScope" }, { "type": "null" } ] }, "audit": { "items": { "$ref": "#/components/schemas/BamiAuditRecordRead" }, "title": "Audit", "type": "array" }, "sessions": { "items": { "$ref": "#/components/schemas/BamiSessionResponse" }, "title": "Sessions", "type": "array" }, "runs": { "items": { "$ref": "#/components/schemas/BamiRunResponse" }, "title": "Runs", "type": "array" }, "events": { "items": { "$ref": "#/components/schemas/BamiEventResponse" }, "title": "Events", "type": "array" }, "coverage": { "$ref": "#/components/schemas/BamiDiagnosticCoverage" }, "next_cursors": { "$ref": "#/components/schemas/BamiDiagnosticCursors" } }, "required": [ "target", "audit", "sessions", "runs", "events", "coverage", "next_cursors" ], "title": "DiagnosticLookup", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiEventContent": { "additionalProperties": true, "properties": { "type": { "title": "Type", "type": "string" }, "text": { "default": null, "title": "Text" } }, "required": [ "type" ], "title": "EventContent", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiEventPresent": { "additionalProperties": false, "properties": { "kind": { "const": "event_present", "title": "Kind", "type": "string" }, "type": { "minLength": 1, "title": "Type", "type": "string" } }, "required": [ "kind", "type" ], "title": "EventPresent", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiEventResponse": { "examples": [ { "content": { "model": "openai/gpt-5", "run_id": "run_123" }, "id": "evt_run_started", "type": "run.started" }, { "content": { "execution_idempotency_key": "evt_custom_tool", "input": { "operations": [ { "op": "add", "title": "Buy milk" } ] }, "name": "todo_ops", "pending_input_id": "5d1a4608909bd2230f0c39e6f0b4875b", "tool_call_id": "call_123" }, "id": "evt_tool_started", "type": "tool.started" }, { "content": { "name": "todo_ops", "output": { "applied": true }, "pending_input_id": "5d1a4608909bd2230f0c39e6f0b4875b", "tool_call_id": "call_123" }, "id": "evt_tool_completed", "type": "tool.completed" }, { "content": { "error": "Application tool failed", "name": "todo_ops", "tool_call_id": "call_123" }, "id": "evt_tool_failed", "type": "tool.failed" }, { "content": { "input": { "operations": [ { "op": "add", "title": "Buy milk" } ] }, "name": "todo_ops", "tool_call_id": "call_123" }, "id": "evt_custom_tool", "type": "agent.custom_tool_use" }, { "content": { "stop_reason": { "event_ids": [ "evt_custom_tool" ], "type": "requires_action" } }, "id": "evt_idle", "type": "session.status_idle" } ], "properties": { "id": { "title": "Id", "type": "string" }, "type": { "description": "Event type. stream.resync is an ephemeral terminal signal that tells the client to reconnect and re-read the persisted session event stream.", "title": "Type", "type": "string" }, "content": { "anyOf": [ { "items": { "$ref": "#/components/schemas/BamiEventContent" }, "type": "array" }, { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Text events use a list of content blocks. Tool, run, session, and application-tool events use a JSON object.", "title": "Content" }, "parent_event_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Parent Event Id" }, "run_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Run Id" }, "model_used": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Model Used" }, "seq": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Seq" }, "metadata": { "additionalProperties": true, "title": "Metadata", "type": "object" }, "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Created At" }, "sequence": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Sequence" }, "workspace_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace Id" }, "session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Session Id" }, "in_reply_to_event_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "In Reply To Event Id" }, "data": { "default": null, "title": "Data" } }, "required": [ "id", "type" ], "title": "EventResponse", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiFailureCount": { "additionalProperties": false, "properties": { "count": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "title": "Count" }, "unavailable_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unavailable Reason" } }, "required": [ "count", "unavailable_reason" ], "title": "FailureCount", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiFinalTextContains": { "additionalProperties": false, "properties": { "kind": { "const": "final_text_contains", "title": "Kind", "type": "string" }, "text": { "minLength": 1, "title": "Text", "type": "string" } }, "required": [ "kind", "text" ], "title": "FinalTextContains", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiFinalTextMatches": { "additionalProperties": false, "properties": { "kind": { "const": "final_text_matches", "title": "Kind", "type": "string" }, "regex": { "title": "Regex", "type": "string" } }, "required": [ "kind", "regex" ], "title": "FinalTextMatches", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiGlobalSettingsPatch": { "additionalProperties": false, "properties": { "enabled": { "default": null, "title": "Enabled", "type": "boolean" }, "tenant_enabled_default": { "default": null, "title": "Tenant Enabled Default", "type": "boolean" }, "jev_enabled": { "default": null, "title": "Jev Enabled", "type": "boolean" }, "model_version": { "default": null, "title": "Model Version", "type": "string" }, "fallback_enabled": { "const": false, "default": null, "title": "Fallback Enabled", "type": "boolean" }, "release_id": { "default": null, "title": "Release Id", "type": "string" }, "max_tool_calls_per_turn": { "default": null, "exclusiveMinimum": 0, "title": "Max Tool Calls Per Turn", "type": "integer" }, "max_concurrent_tool_calls": { "default": null, "exclusiveMinimum": 0, "title": "Max Concurrent Tool Calls", "type": "integer" }, "source_deadline_seconds": { "default": null, "exclusiveMinimum": 0, "title": "Source Deadline Seconds", "type": "integer" }, "turn_deadline_seconds": { "default": null, "exclusiveMinimum": 0, "title": "Turn Deadline Seconds", "type": "integer" }, "max_active_per_conversation": { "const": 1, "default": null, "title": "Max Active Per Conversation", "type": "integer" }, "max_active_per_user": { "default": null, "exclusiveMinimum": 0, "title": "Max Active Per User", "type": "integer" }, "max_active_per_tenant": { "default": null, "exclusiveMinimum": 0, "title": "Max Active Per Tenant", "type": "integer" }, "max_active_global": { "default": null, "exclusiveMinimum": 0, "title": "Max Active Global", "type": "integer" }, "messages_per_minute": { "default": null, "exclusiveMinimum": 0, "title": "Messages Per Minute", "type": "integer" }, "messages_per_day": { "default": null, "exclusiveMinimum": 0, "title": "Messages Per Day", "type": "integer" }, "tenant_daily_tokens": { "default": null, "minimum": 0, "title": "Tenant Daily Tokens", "type": "integer" }, "tenant_daily_usd": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" } ], "default": null, "title": "Tenant Daily Usd" }, "global_daily_tokens": { "default": null, "minimum": 0, "title": "Global Daily Tokens", "type": "integer" }, "global_daily_usd": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" } ], "default": null, "title": "Global Daily Usd" }, "budget_alert_percent": { "default": null, "maximum": 100, "minimum": 1, "title": "Budget Alert Percent", "type": "integer" }, "content_retention_days": { "default": null, "maximum": 90, "minimum": 1, "title": "Content Retention Days", "type": "integer" }, "control_poll_seconds": { "default": null, "exclusiveMinimum": 0, "title": "Control Poll Seconds", "type": "integer" }, "retention_sweep_seconds": { "default": null, "exclusiveMinimum": 0, "title": "Retention Sweep Seconds", "type": "integer" }, "admin_session_ttl_seconds": { "default": null, "exclusiveMinimum": 0, "title": "Admin Session Ttl Seconds", "type": "integer" }, "admin_enrolled_user_ids": { "default": null, "items": { "format": "uuid", "type": "string" }, "title": "Admin Enrolled User Ids", "type": "array" }, "checker_min_cases": { "default": null, "minimum": 40, "title": "Checker Min Cases", "type": "integer" }, "checker_max_false_acceptance": { "anyOf": [ { "maximum": 0.05, "minimum": 0.0, "type": "number" }, { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" } ], "default": null, "title": "Checker Max False Acceptance" }, "checker_max_false_rejection": { "anyOf": [ { "maximum": 0.1, "minimum": 0.0, "type": "number" }, { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" } ], "default": null, "title": "Checker Max False Rejection" }, "action_activate_enabled": { "default": null, "title": "Action Activate Enabled", "type": "boolean" }, "action_delete_enabled": { "default": null, "title": "Action Delete Enabled", "type": "boolean" }, "action_deprecate_enabled": { "default": null, "title": "Action Deprecate Enabled", "type": "boolean" } }, "title": "GlobalSettingsPatch", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiGlobalSettingsResponse": { "additionalProperties": false, "properties": { "revision": { "minimum": 0, "title": "Revision", "type": "integer" }, "settings": { "$ref": "#/components/schemas/BamiGlobalSettingsPatch" }, "effective_settings": { "$ref": "#/components/schemas/BamiSettings" } }, "required": [ "revision", "settings", "effective_settings" ], "title": "GlobalSettingsResponse", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiGlobalSettingsUpdate": { "additionalProperties": false, "properties": { "reason": { "maxLength": 1000, "minLength": 1, "title": "Reason", "type": "string" }, "expected_revision": { "minimum": 0, "title": "Expected Revision", "type": "integer" }, "settings": { "$ref": "#/components/schemas/BamiGlobalSettingsPatch" } }, "required": [ "reason", "expected_revision", "settings" ], "title": "GlobalSettingsUpdate", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiInputPathEquals": { "additionalProperties": false, "properties": { "path": { "pattern": "^[A-Za-z_][A-Za-z0-9_]*(?:\\[[0-9]+\\])*(?:\\.[A-Za-z_][A-Za-z0-9_]*(?:\\[[0-9]+\\])*)*$", "title": "Path", "type": "string" }, "equals": { "$ref": "#/components/schemas/BamiJsonValue" } }, "required": [ "path", "equals" ], "title": "InputPathEquals", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiJsonPathEquals": { "additionalProperties": false, "properties": { "kind": { "const": "json_path_equals", "title": "Kind", "type": "string" }, "path": { "pattern": "^[A-Za-z_][A-Za-z0-9_]*(?:\\[[0-9]+\\])*(?:\\.[A-Za-z_][A-Za-z0-9_]*(?:\\[[0-9]+\\])*)*$", "title": "Path", "type": "string" }, "equals": { "$ref": "#/components/schemas/BamiJsonValue" } }, "required": [ "kind", "path", "equals" ], "title": "JsonPathEquals", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiJsonValue": { "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiKillReceipt": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "revision": { "minimum": 0, "title": "Revision", "type": "integer" }, "tenant_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Tenant Id" }, "stop_generation": { "minimum": 0, "title": "Stop Generation", "type": "integer" }, "admission_stopped_at": { "format": "date-time", "title": "Admission Stopped At", "type": "string" }, "status": { "enum": [ "cancelling", "cancelled" ], "title": "Status", "type": "string" }, "cancellation_receipt_ids": { "items": { "type": "string" }, "title": "Cancellation Receipt Ids", "type": "array" }, "pending_run_ids": { "items": { "format": "uuid", "type": "string" }, "title": "Pending Run Ids", "type": "array" }, "action": { "anyOf": [ { "enum": [ "activate", "delete", "deprecate" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "pending_approval_ids": { "items": { "type": "string" }, "title": "Pending Approval Ids", "type": "array" } }, "required": [ "id", "revision", "tenant_id", "stop_generation", "admission_stopped_at", "status", "cancellation_receipt_ids", "pending_run_ids" ], "title": "KillReceipt", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiLatencyPercentiles": { "additionalProperties": false, "properties": { "p50": { "anyOf": [ { "minimum": 0, "type": "number" }, { "type": "null" } ], "title": "P50" }, "p90": { "anyOf": [ { "minimum": 0, "type": "number" }, { "type": "null" } ], "title": "P90" }, "p95": { "anyOf": [ { "minimum": 0, "type": "number" }, { "type": "null" } ], "title": "P95" }, "p99": { "anyOf": [ { "minimum": 0, "type": "number" }, { "type": "null" } ], "title": "P99" } }, "required": [ "p50", "p90", "p95", "p99" ], "title": "LatencyPercentiles", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiMetricCounts": { "additionalProperties": false, "properties": { "turns": { "minimum": 0, "title": "Turns", "type": "integer" }, "failures": { "minimum": 0, "title": "Failures", "type": "integer" }, "checker_rejections": { "minimum": 0, "title": "Checker Rejections", "type": "integer" } }, "required": [ "turns", "failures", "checker_rejections" ], "title": "MetricCounts", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiMetricWindow": { "additionalProperties": false, "properties": { "from": { "format": "date-time", "title": "From", "type": "string" }, "to": { "format": "date-time", "title": "To", "type": "string" }, "release_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Release Id" }, "counts": { "$ref": "#/components/schemas/BamiMetricCounts" }, "latency_ms": { "$ref": "#/components/schemas/BamiLatencyPercentiles" }, "tokens": { "minimum": 0, "title": "Tokens", "type": "integer" }, "usd": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "title": "Usd" }, "unavailable_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unavailable Reason" } }, "required": [ "from", "to", "release_id", "counts", "latency_ms", "tokens", "usd", "unavailable_reason" ], "title": "MetricWindow", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiObservability": { "additionalProperties": false, "properties": { "sessions": { "items": { "$ref": "#/components/schemas/BamiSessionResponse" }, "title": "Sessions", "type": "array" }, "next_page": { "anyOf": [ { "minimum": 1, "type": "integer" }, { "type": "null" } ], "title": "Next Page" }, "failures": { "$ref": "#/components/schemas/BamiFailureCount" }, "usage": { "$ref": "#/components/schemas/BamiObservabilityUsage" }, "coverage": { "$ref": "#/components/schemas/BamiCoverage" } }, "required": [ "sessions", "next_page", "failures", "usage", "coverage" ], "title": "Observability", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiObservabilityUsage": { "additionalProperties": false, "properties": { "input_tokens": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "title": "Input Tokens" }, "output_tokens": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "title": "Output Tokens" }, "usd": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "title": "Usd" }, "unavailable_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unavailable Reason" } }, "required": [ "input_tokens", "output_tokens", "usd", "unavailable_reason" ], "title": "ObservabilityUsage", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiOutcomeIs": { "additionalProperties": false, "properties": { "kind": { "const": "outcome_is", "title": "Kind", "type": "string" }, "outcome": { "enum": [ "queued", "running", "passed", "failed", "waiting", "inconclusive", "cancelled", "timed_out" ], "title": "Outcome", "type": "string" } }, "required": [ "kind", "outcome" ], "title": "OutcomeIs", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiRelease": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "model_version": { "title": "Model Version", "type": "string" }, "prompt_hash": { "title": "Prompt Hash", "type": "string" }, "knowledge_hash": { "title": "Knowledge Hash", "type": "string" }, "prompt_reference": { "title": "Prompt Reference", "type": "string" }, "knowledge_reference": { "title": "Knowledge Reference", "type": "string" }, "evaluation": { "$ref": "#/components/schemas/BamiEvaluationReceipt" }, "created_by": { "format": "uuid", "title": "Created By", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" } }, "required": [ "id", "model_version", "prompt_hash", "knowledge_hash", "prompt_reference", "knowledge_reference", "evaluation", "created_by", "created_at" ], "title": "Release", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiRollout": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "revision": { "minimum": 0, "title": "Revision", "type": "integer" }, "release_id": { "title": "Release Id", "type": "string" }, "previous_release_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous Release Id" }, "cohort": { "enum": [ "internal", "preview", "general" ], "title": "Cohort", "type": "string" }, "tenant_ids": { "items": { "format": "uuid", "type": "string" }, "title": "Tenant Ids", "type": "array" }, "actor_id": { "format": "uuid", "title": "Actor Id", "type": "string" }, "reason": { "title": "Reason", "type": "string" }, "outcome": { "enum": [ "applied", "rejected" ], "title": "Outcome", "type": "string" }, "rollback_of": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rollback Of" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" } }, "required": [ "id", "revision", "release_id", "previous_release_id", "cohort", "tenant_ids", "actor_id", "reason", "outcome", "rollback_of", "created_at" ], "title": "Rollout", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiRunResponse": { "properties": { "run_id": { "title": "Run Id", "type": "string" }, "status": { "enum": [ "queued", "running", "waiting_for_input", "completed", "failed", "cancelled", "expired" ], "title": "Status", "type": "string" }, "record_integrity": { "default": "complete", "description": "Whether the run's history was recorded, separately from its status. complete is the normal answer, including for a turn that finished with nothing to say. lost means the run executed but its history was not recorded; an empty timeline must not be read as a silent turn.", "enum": [ "complete", "lost" ], "title": "Record Integrity", "type": "string" }, "model_used": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Model Used" }, "artifacts": { "anyOf": [ { "items": { "$ref": "#/components/schemas/BamiArtifactResponse" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Artifacts" }, "required_event_ids": { "items": { "type": "string" }, "title": "Required Event Ids", "type": "array" } }, "required": [ "run_id", "status" ], "title": "RunResponse", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiSandboxStatus": { "description": "Observed availability of the session sandbox.", "enum": [ "ready", "stopped", "missing", "none", "unknown" ], "title": "SandboxStatus", "type": "string", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiSessionAgentRef": { "properties": { "id": { "title": "Id", "type": "string" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "id", "version" ], "title": "SessionAgentRef", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiSessionDeploymentRef": { "properties": { "id": { "title": "Id", "type": "string" }, "content_hash": { "title": "Content Hash", "type": "string" } }, "required": [ "id", "content_hash" ], "title": "SessionDeploymentRef", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiSessionResponse": { "properties": { "id": { "title": "Id", "type": "string" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "User Id" }, "agent": { "anyOf": [ { "$ref": "#/components/schemas/BamiSessionAgentRef" }, { "type": "null" } ], "default": null }, "agent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Agent Id" }, "agent_slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Agent Slug" }, "deployment": { "anyOf": [ { "$ref": "#/components/schemas/BamiSessionDeploymentRef" }, { "type": "null" } ], "default": null }, "deployment_snapshot_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Identifier of the immutable deployment snapshot pinned to this session.", "title": "Deployment Snapshot Id" }, "deployment_source": { "anyOf": [ { "enum": [ "published", "legacy" ], "type": "string" }, { "type": "null" } ], "default": null, "description": "Origin of the pinned deployment snapshot, either published or legacy.", "title": "Deployment Source" }, "environment_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Environment Id" }, "requires_sandbox": { "default": true, "description": "Whether this session requires a provisioned sandbox for tools and file operations.", "title": "Requires Sandbox", "type": "boolean" }, "model": { "title": "Model", "type": "string" }, "status": { "default": "idle", "title": "Status", "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Title" }, "metadata": { "additionalProperties": true, "title": "Metadata", "type": "object" }, "secrets": { "description": "Workspace secrets delivered to this session's sandbox, by name. Values are never included.", "items": { "$ref": "#/components/schemas/BamiSessionSecretBinding" }, "title": "Secrets", "type": "array" }, "env": { "additionalProperties": { "type": "string" }, "title": "Env", "type": "object" }, "sandbox_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Sandbox Id" }, "sandbox_status": { "$ref": "#/components/schemas/BamiSandboxStatus", "default": "none", "description": "Observed sandbox availability. ready is usable, stopped can be restarted, missing means the provider no longer has it, none means no sandbox is required, and unknown means provider state could not be reached." }, "usage": { "$ref": "#/components/schemas/BamiSessionUsage" }, "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Created At" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated At" }, "archived_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Archived At" } }, "required": [ "id", "model" ], "title": "SessionResponse", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiSessionUsage": { "properties": { "input_tokens": { "default": 0, "title": "Input Tokens", "type": "integer" }, "output_tokens": { "default": 0, "title": "Output Tokens", "type": "integer" } }, "title": "SessionUsage", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiSettings": { "additionalProperties": false, "properties": { "enabled": { "default": false, "title": "Enabled", "type": "boolean" }, "tenant_enabled_default": { "default": false, "title": "Tenant Enabled Default", "type": "boolean" }, "tenant_enabled": { "default": false, "title": "Tenant Enabled", "type": "boolean" }, "reply_evidence_enabled": { "default": false, "title": "Reply Evidence Enabled", "type": "boolean" }, "jev_enabled": { "default": false, "title": "Jev Enabled", "type": "boolean" }, "model_version": { "default": "", "title": "Model Version", "type": "string" }, "fallback_enabled": { "const": false, "default": false, "title": "Fallback Enabled", "type": "boolean" }, "release_id": { "default": "", "title": "Release Id", "type": "string" }, "evaluation_passed": { "default": false, "title": "Evaluation Passed", "type": "boolean" }, "max_tool_calls_per_turn": { "default": 24, "exclusiveMinimum": 0, "title": "Max Tool Calls Per Turn", "type": "integer" }, "max_concurrent_tool_calls": { "default": 4, "exclusiveMinimum": 0, "title": "Max Concurrent Tool Calls", "type": "integer" }, "source_deadline_seconds": { "default": 15, "exclusiveMinimum": 0, "title": "Source Deadline Seconds", "type": "integer" }, "turn_deadline_seconds": { "default": 90, "exclusiveMinimum": 0, "title": "Turn Deadline Seconds", "type": "integer" }, "max_active_per_conversation": { "const": 1, "default": 1, "title": "Max Active Per Conversation", "type": "integer" }, "max_active_per_user": { "default": 2, "exclusiveMinimum": 0, "title": "Max Active Per User", "type": "integer" }, "max_active_per_tenant": { "default": 4, "exclusiveMinimum": 0, "title": "Max Active Per Tenant", "type": "integer" }, "max_active_global": { "default": 20, "exclusiveMinimum": 0, "title": "Max Active Global", "type": "integer" }, "messages_per_minute": { "default": 20, "exclusiveMinimum": 0, "title": "Messages Per Minute", "type": "integer" }, "messages_per_day": { "default": 200, "exclusiveMinimum": 0, "title": "Messages Per Day", "type": "integer" }, "tenant_daily_tokens": { "default": 250000, "minimum": 0, "title": "Tenant Daily Tokens", "type": "integer" }, "tenant_daily_usd": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" } ], "default": "2", "title": "Tenant Daily Usd" }, "global_daily_tokens": { "default": 5000000, "minimum": 0, "title": "Global Daily Tokens", "type": "integer" }, "global_daily_usd": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" } ], "default": "40", "title": "Global Daily Usd" }, "budget_alert_percent": { "default": 80, "maximum": 100, "minimum": 1, "title": "Budget Alert Percent", "type": "integer" }, "content_retention_days": { "default": 30, "maximum": 90, "minimum": 1, "title": "Content Retention Days", "type": "integer" }, "control_poll_seconds": { "default": 2, "exclusiveMinimum": 0, "title": "Control Poll Seconds", "type": "integer" }, "retention_sweep_seconds": { "default": 3600, "exclusiveMinimum": 0, "title": "Retention Sweep Seconds", "type": "integer" }, "admin_session_ttl_seconds": { "default": 3600, "exclusiveMinimum": 0, "title": "Admin Session Ttl Seconds", "type": "integer" }, "admin_enrolled_user_ids": { "items": { "format": "uuid", "type": "string" }, "title": "Admin Enrolled User Ids", "type": "array" }, "checker_min_cases": { "default": 40, "minimum": 40, "title": "Checker Min Cases", "type": "integer" }, "checker_max_false_acceptance": { "anyOf": [ { "maximum": 0.05, "minimum": 0.0, "type": "number" }, { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" } ], "default": "0.05", "title": "Checker Max False Acceptance" }, "checker_max_false_rejection": { "anyOf": [ { "maximum": 0.1, "minimum": 0.0, "type": "number" }, { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" } ], "default": "0.10", "title": "Checker Max False Rejection" }, "action_activate_enabled": { "default": false, "title": "Action Activate Enabled", "type": "boolean" }, "action_delete_enabled": { "default": false, "title": "Action Delete Enabled", "type": "boolean" }, "action_deprecate_enabled": { "default": false, "title": "Action Deprecate Enabled", "type": "boolean" } }, "title": "Settings", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiSettingsPatch": { "additionalProperties": false, "description": "Tenant allowlist. Omission leaves an override unchanged; null removes it.", "properties": { "tenant_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Tenant Enabled" }, "reply_evidence_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Reply Evidence Enabled" }, "jev_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Jev Enabled" }, "max_tool_calls_per_turn": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "title": "Max Tool Calls Per Turn" }, "max_concurrent_tool_calls": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "title": "Max Concurrent Tool Calls" }, "source_deadline_seconds": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "title": "Source Deadline Seconds" }, "turn_deadline_seconds": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "title": "Turn Deadline Seconds" }, "max_active_per_tenant": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "title": "Max Active Per Tenant" }, "messages_per_minute": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "title": "Messages Per Minute" }, "messages_per_day": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "title": "Messages Per Day" }, "tenant_daily_tokens": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "title": "Tenant Daily Tokens" }, "tenant_daily_usd": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Tenant Daily Usd" }, "content_retention_days": { "anyOf": [ { "maximum": 90, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "title": "Content Retention Days" }, "release_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Release Id" }, "action_activate_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Action Activate Enabled" }, "action_delete_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Action Delete Enabled" }, "action_deprecate_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Action Deprecate Enabled" } }, "title": "SettingsPatch", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiSettingsResponse": { "additionalProperties": false, "properties": { "revision": { "minimum": 0, "title": "Revision", "type": "integer" }, "settings": { "$ref": "#/components/schemas/BamiSettingsPatch" }, "effective_settings": { "$ref": "#/components/schemas/BamiSettings" } }, "required": [ "revision", "settings", "effective_settings" ], "title": "SettingsResponse", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiSettingsUpdate": { "additionalProperties": false, "properties": { "reason": { "maxLength": 1000, "minLength": 1, "title": "Reason", "type": "string" }, "expected_revision": { "minimum": 0, "title": "Expected Revision", "type": "integer" }, "settings": { "$ref": "#/components/schemas/BamiSettingsPatch" } }, "required": [ "reason", "expected_revision", "settings" ], "title": "SettingsUpdate", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiSupportGrant": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "revision": { "minimum": 0, "title": "Revision", "type": "integer" }, "workspace_id": { "format": "uuid", "title": "Workspace Id", "type": "string" }, "conversation_id": { "title": "Conversation Id", "type": "string" }, "grantee_id": { "format": "uuid", "title": "Grantee Id", "type": "string" }, "granted_by": { "format": "uuid", "title": "Granted By", "type": "string" }, "purpose": { "title": "Purpose", "type": "string" }, "consent_reference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consent Reference" }, "legal_obligation_reference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Legal Obligation Reference" }, "notification_status": { "enum": [ "pending", "sent", "failed", "prohibited" ], "title": "Notification Status", "type": "string" }, "notification_prohibited_reference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notification Prohibited Reference" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "expires_at": { "format": "date-time", "title": "Expires At", "type": "string" }, "revoked_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Revoked At" } }, "required": [ "id", "revision", "workspace_id", "conversation_id", "grantee_id", "granted_by", "purpose", "consent_reference", "legal_obligation_reference", "notification_status", "notification_prohibited_reference", "created_at", "expires_at", "revoked_at" ], "title": "SupportGrant", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiToolCalled": { "additionalProperties": false, "properties": { "kind": { "const": "tool_called", "title": "Kind", "type": "string" }, "tool_name": { "minLength": 1, "title": "Tool Name", "type": "string" }, "input_path_equals": { "anyOf": [ { "$ref": "#/components/schemas/BamiInputPathEquals" }, { "type": "null" } ], "default": null } }, "required": [ "kind", "tool_name" ], "title": "ToolCalled", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiToolNotCalled": { "additionalProperties": false, "properties": { "kind": { "const": "tool_not_called", "title": "Kind", "type": "string" }, "tool_name": { "minLength": 1, "title": "Tool Name", "type": "string" } }, "required": [ "kind", "tool_name" ], "title": "ToolNotCalled", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiError": { "additionalProperties": false, "properties": { "code": { "title": "Code", "type": "string" }, "message": { "title": "Message", "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request Id" }, "details": { "items": { "$ref": "#/components/schemas/BamiErrorDetail" }, "title": "Details", "type": "array" }, "active_run_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "title": "Active Run Id" }, "current_generation": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Current Generation" }, "current_revision": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Current Revision" }, "retry_after_seconds": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "title": "Retry After Seconds" } }, "required": [ "code", "message", "request_id", "details" ], "title": "BamiError", "type": "object" }, "BamiErrorDetail": { "additionalProperties": false, "properties": { "path": { "title": "Path", "type": "string" }, "reason": { "title": "Reason", "type": "string" } }, "required": [ "path", "reason" ], "title": "BamiErrorDetail", "type": "object" }, "BamiErrorEnvelope": { "additionalProperties": false, "properties": { "error": { "$ref": "#/components/schemas/BamiError" } }, "required": [ "error" ], "title": "BamiErrorEnvelope", "type": "object" }, "BamiReplyExcerpt": { "additionalProperties": false, "properties": { "message_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message Id" }, "role": { "const": "assistant", "title": "Role", "type": "string" }, "text": { "title": "Text", "type": "string" }, "truncated": { "title": "Truncated", "type": "boolean" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, "required": [ "message_id", "role", "text", "truncated", "language" ], "title": "ReplyExcerpt", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiReplyDisclosure": { "additionalProperties": false, "description": "What the person is shown before they may allow one reply read.", "properties": { "statement": { "title": "Statement", "type": "string" }, "provider_model_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider Model Version" }, "provider_calls": { "title": "Provider Calls", "type": "integer" }, "retention_days": { "title": "Retention Days", "type": "integer" }, "redaction": { "title": "Redaction", "type": "string" }, "single_use": { "const": true, "default": true, "title": "Single Use", "type": "boolean" } }, "required": [ "statement", "provider_model_version", "provider_calls", "retention_days", "redaction" ], "title": "ReplyDisclosure", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiReplyEvidenceApproval": { "additionalProperties": false, "description": "Contract v5 second gate. Bound to one actor, workspace, run and diagnosis.", "properties": { "id": { "title": "Id", "type": "string" }, "workspace_id": { "format": "uuid", "title": "Workspace Id", "type": "string" }, "conversation_id": { "title": "Conversation Id", "type": "string" }, "requester_id": { "format": "uuid", "title": "Requester Id", "type": "string" }, "offer_run_id": { "format": "uuid", "title": "Offer Run Id", "type": "string" }, "request_id": { "title": "Request Id", "type": "string" }, "scope_generation": { "title": "Scope Generation", "type": "integer" }, "target_run_id": { "format": "uuid", "title": "Target Run Id", "type": "string" }, "target_session_id": { "format": "uuid", "title": "Target Session Id", "type": "string" }, "diagnosis_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Diagnosis Id" }, "disclosure": { "$ref": "#/components/schemas/BamiReplyDisclosure" }, "decision": { "anyOf": [ { "enum": [ "allow", "deny" ], "type": "string" }, { "type": "null" } ], "title": "Decision" }, "decider_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Decider Id" }, "decided_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Decided At" }, "decision_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Decision Reason" }, "outcome": { "enum": [ "offered", "allowed", "declined", "spent", "expired" ], "title": "Outcome", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "expires_at": { "format": "date-time", "title": "Expires At", "type": "string" }, "consumed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Consumed At" }, "consumed_by_run_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Consumed By Run Id" }, "message_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Message Id" } }, "required": [ "id", "workspace_id", "conversation_id", "requester_id", "offer_run_id", "request_id", "scope_generation", "target_run_id", "target_session_id", "diagnosis_id", "disclosure", "decision", "decider_id", "decided_at", "decision_reason", "outcome", "created_at", "expires_at", "consumed_at", "consumed_by_run_id", "message_id" ], "title": "ReplyEvidenceApproval", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false }, "BamiSessionSecretBinding": { "description": "One stored secret, delivered into one session's sandbox.\n\nDelivery is by environment variable, by file, or by both, because real\ncommand line tools are split between the two. A mail client that reads its\ntoken from ``$TOKEN`` wants the variable; one that reads a file under a\ndirectory named by an environment variable wants the file, plus a plain\nnon-secret variable pointing at that directory, which\n``CreateSessionRequest.env`` supplies.", "properties": { "name": { "description": "The workspace secret to deliver.", "title": "Name", "type": "string" }, "env_var": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Environment variable to set in the sandbox. Defaults to the secret name when no file_path is given. Pass null with a file_path to deliver the value only as a file.", "title": "Env Var" }, "file_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Absolute path inside the sandbox to write the value to, created with mode 600 before the first run. Use this for tools that read a credential from a file rather than the environment.", "title": "File Path" } }, "required": [ "name" ], "title": "SessionSecretBinding", "type": "object", "x-stage": "phase-one-foundation", "x-routes-implemented": false } }, "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "description": "Super-admin `ak_...` key (grants /v1/admin/*) **or** tenant/workspace `pk_...` key (grants /v1/* tenant endpoints), or account session `ps_...` token. Paste whichever credential matches the endpoint you are testing." }, "BamiAdminSession": { "type": "apiKey", "in": "cookie", "name": "bami_admin_session", "description": "Named enrolled operator session established with password and TOTP." } }, "parameters": { "IdempotencyKeyHeader": { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 8, "maxLength": 255 } }, "RequestIdHeader": { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string" } } }, "responses": { "InvalidRequest": { "description": "Malformed request or unsupported parameter.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "AuthenticationRequired": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "PermissionDenied": { "description": "Key lacks required scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "ResourceNotFound": { "description": "Resource absent or in another workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "IdempotencyConflict": { "description": "Idempotency key reused with conflicting payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "ValidationError": { "description": "Validation failed against required schema.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "RuntimeResumeUnavailable": { "description": "Durable checkpointing or continuation is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } }, "tags": [ { "name": "admin", "description": "Administrative operations that require an admin key." }, { "name": "tenants", "description": "Tenant lifecycle management (**super-admin** only, `ak_` key)." }, { "name": "admin-api-keys", "description": "Super-admin API key management (`ak_` key)." }, { "name": "admin-tenant-api-keys", "description": "Mint/list/revoke tenant API keys for a tenant (`ak_` key)." }, { "name": "admin-users", "description": "Tenant users, admin view (**super-admin** only)." }, { "name": "admin-environments", "description": "Sandbox environment templates, admin view (**super-admin** only)." }, { "name": "admin-skills", "description": "Install builtin skills (**super-admin** only)." }, { "name": "admin-org-skills", "description": "Install skills into a tenant (**super-admin** only)." }, { "name": "accounts", "description": "Self-service signup, login, sessions, passwords, and API keys." }, { "name": "tools", "description": "Tenant application tools and immutable version definitions." }, { "name": "deployments", "description": "Immutable agent revision and application-tool deployment snapshots." }, { "name": "models", "description": "Public: list the LLM models available for agents and runs." }, { "name": "agents", "description": "Agent CRUD scoped to the authenticated tenant (`pk_` key)." }, { "name": "tenant-users", "description": "Tenant users (`pk_` key); `user_id` may attach to sessions." }, { "name": "tenant-api-keys", "description": "Self-managed tenant API keys (`pk_` key)." }, { "name": "sessions", "description": "Deep-agent sessions (LangGraph threads) from an agent slug." }, { "name": "runs", "description": "Run a session, stream SSE events, or resume runs (`pk_` key)." }, { "name": "events", "description": "Session events: send, stream, and read the persisted timeline." }, { "name": "messages", "description": "Message history for a session (user/assistant turns)." }, { "name": "artifacts", "description": "Artifacts published by agents during runs (list/download)." }, { "name": "sandbox", "description": "Sandbox lifecycle and file operations for a session." }, { "name": "tenant-skills", "description": "Tenant skill CRUD, import/validate, and file management." }, { "name": "session-skills", "description": "Per-session skill catalog and enablement." }, { "name": "environments", "description": "Environment templates, tenant view." }, { "name": "audit", "description": "Audit trail records for workspace actions and tool executions." }, { "name": "health", "description": "Public liveness of API, database, worker, and sandbox provider." } ], "servers": [ { "url": "/", "description": "Current environment" } ] }