{ "openapi": "3.1.0", "info": { "title": "Argus Council", "version": "0.1.4" }, "paths": { "/health/live": { "get": { "tags": [ "health" ], "summary": "Live", "operationId": "live_health_live_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Live Health Live Get" } } } } } } }, "/health/ready": { "get": { "tags": [ "health" ], "summary": "Ready", "operationId": "ready_health_ready_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Ready Health Ready Get" } } } } } } }, "/api/v1/auth/register": { "post": { "tags": [ "auth" ], "summary": "Register", "operationId": "register_api_v1_auth_register_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterIn" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/auth/login": { "post": { "tags": [ "auth" ], "summary": "Login", "operationId": "login_api_v1_auth_login_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginIn" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/TokenOut" }, { "$ref": "#/components/schemas/MfaChallengeOut" } ], "title": "Response Login Api V1 Auth Login Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/auth/refresh": { "post": { "tags": [ "auth" ], "summary": "Refresh", "operationId": "refresh_api_v1_auth_refresh_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefreshIn" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/auth/logout": { "post": { "tags": [ "auth" ], "summary": "Logout", "description": "End the session the refresh token belongs to (its access tokens stop working too).", "operationId": "logout_api_v1_auth_logout_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefreshIn" } } }, "required": true }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/auth/me": { "get": { "tags": [ "auth" ], "summary": "Me", "operationId": "me_api_v1_auth_me_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountOut" } } } } }, "security": [ { "HTTPBearer": [] } ] }, "patch": { "tags": [ "auth" ], "summary": "Update Me", "operationId": "update_me_api_v1_auth_me_patch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfilePatch" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/auth/api-keys": { "get": { "tags": [ "auth" ], "summary": "List Keys", "operationId": "list_keys_api_v1_auth_api_keys_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ApiKeyOut" }, "type": "array", "title": "Response List Keys Api V1 Auth Api Keys Get" } } } } }, "security": [ { "HTTPBearer": [] } ] }, "post": { "tags": [ "auth" ], "summary": "Create Key", "operationId": "create_key_api_v1_auth_api_keys_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyIn" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyCreated" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/auth/api-keys/{key_id}": { "delete": { "tags": [ "auth" ], "summary": "Revoke Key", "operationId": "revoke_key_api_v1_auth_api_keys__key_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "key_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Key Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/auth/mfa": { "get": { "tags": [ "auth" ], "summary": "Status", "operationId": "status_api_v1_auth_mfa_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MfaStatusOut" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/auth/mfa/setup": { "post": { "tags": [ "auth" ], "summary": "Setup", "description": "Start enrolment (needs the password, so a borrowed session cannot lock the owner out).", "operationId": "setup_api_v1_auth_mfa_setup_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordIn" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetupOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/auth/mfa/enable": { "post": { "tags": [ "auth" ], "summary": "Enable", "operationId": "enable_api_v1_auth_mfa_enable_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeIn" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecoveryCodesOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/auth/mfa/disable": { "post": { "tags": [ "auth" ], "summary": "Disable", "operationId": "disable_api_v1_auth_mfa_disable_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordCodeIn" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MfaStatusOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/auth/mfa/recovery-codes": { "post": { "tags": [ "auth" ], "summary": "Regenerate", "operationId": "regenerate_api_v1_auth_mfa_recovery_codes_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordCodeIn" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecoveryCodesOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/auth/mfa/verify": { "post": { "tags": [ "auth" ], "summary": "Verify", "description": "Second step of sign-in: the challenge token from /auth/login plus a code.", "operationId": "verify_api_v1_auth_mfa_verify_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyIn" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/users": { "get": { "tags": [ "admin" ], "summary": "List Users", "operationId": "list_users_api_v1_admin_users_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/AdminUserOut" }, "type": "array", "title": "Response List Users Api V1 Admin Users Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/admin/users/{user_id}": { "patch": { "tags": [ "admin" ], "summary": "Update User", "operationId": "update_user_api_v1_admin_users__user_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "User Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminUserPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminUserOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/features": { "get": { "tags": [ "admin" ], "summary": "List Features", "description": "The optional features (live browser, CLI agents): installed on the server, reachable, on or off.", "operationId": "list_features_api_v1_admin_features_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/FeatureOut" }, "type": "array", "title": "Response List Features Api V1 Admin Features Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/admin/features/{key}": { "patch": { "tags": [ "admin" ], "summary": "Update Feature", "description": "Turn an installed feature on or off for everyone, from its next use (runs in progress included).", "operationId": "update_feature_api_v1_admin_features__key__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string", "title": "Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeaturePatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/roles": { "get": { "tags": [ "councils" ], "summary": "List Roles", "operationId": "list_roles_api_v1_roles_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response List Roles Api V1 Roles Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/councils": { "get": { "tags": [ "councils" ], "summary": "List Councils", "operationId": "list_councils_api_v1_councils_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/CouncilOut" }, "type": "array", "title": "Response List Councils Api V1 Councils Get" } } } } }, "security": [ { "HTTPBearer": [] } ] }, "post": { "tags": [ "councils" ], "summary": "Create Council", "operationId": "create_council_api_v1_councils_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CouncilIn" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CouncilOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/councils/{council_id}": { "get": { "tags": [ "councils" ], "summary": "Get Council", "operationId": "get_council_api_v1_councils__council_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "council_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Council Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CouncilOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "councils" ], "summary": "Update Council", "operationId": "update_council_api_v1_councils__council_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "council_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Council Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CouncilPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CouncilOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "councils" ], "summary": "Delete Council", "operationId": "delete_council_api_v1_councils__council_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "council_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Council Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/councils/{council_id}/resize": { "post": { "tags": [ "councils" ], "summary": "Resize Council", "operationId": "resize_council_api_v1_councils__council_id__resize_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "council_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Council Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResizeIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CouncilOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/councils/{council_id}/members": { "post": { "tags": [ "councils" ], "summary": "Add Member", "operationId": "add_member_api_v1_councils__council_id__members_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "council_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Council Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberIn" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/councils/{council_id}/members/{member_id}": { "patch": { "tags": [ "councils" ], "summary": "Update Member", "operationId": "update_member_api_v1_councils__council_id__members__member_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "council_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Council Id" } }, { "name": "member_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Member Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "councils" ], "summary": "Remove Member", "operationId": "remove_member_api_v1_councils__council_id__members__member_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "council_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Council Id" } }, { "name": "member_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Member Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/providers/kinds": { "get": { "tags": [ "providers" ], "summary": "Kinds", "operationId": "kinds_api_v1_providers_kinds_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Kinds Api V1 Providers Kinds Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/providers": { "get": { "tags": [ "providers" ], "summary": "List Providers", "operationId": "list_providers_api_v1_providers_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ProviderOut" }, "type": "array", "title": "Response List Providers Api V1 Providers Get" } } } } }, "security": [ { "HTTPBearer": [] } ] }, "post": { "tags": [ "providers" ], "summary": "Create Provider", "operationId": "create_provider_api_v1_providers_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderConfigIn" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/providers/{provider_id}": { "patch": { "tags": [ "providers" ], "summary": "Update Provider", "operationId": "update_provider_api_v1_providers__provider_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "provider_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Provider Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderConfigPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "providers" ], "summary": "Delete Provider", "operationId": "delete_provider_api_v1_providers__provider_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "provider_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Provider Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/providers/{name}/models": { "get": { "tags": [ "providers" ], "summary": "List Models", "operationId": "list_models_api_v1_providers__name__models_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Models Api V1 Providers Name Models Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/providers/{name}/test": { "post": { "tags": [ "providers" ], "summary": "Test Provider", "description": "Probe a provider's connection now; persists the result on the user's config.", "operationId": "test_provider_api_v1_providers__name__test_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ProviderTestIn" }, { "type": "null" } ], "title": "Data" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderTestOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/llm/complete": { "post": { "tags": [ "providers" ], "summary": "Complete", "description": "Single completion through the router; used by the UI playground and for provider tests.", "operationId": "complete_api_v1_llm_complete_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompleteIn" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Complete Api V1 Llm Complete Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/cli-agents": { "get": { "tags": [ "cli-agents" ], "summary": "Overview", "description": "Instance switch, policy notice and, per CLI: version, this user's login/key state, login steps.", "operationId": "overview_api_v1_cli_agents_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "probe", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Probe" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Overview Api V1 Cli Agents Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/cli-agents/{cli}/key": { "put": { "tags": [ "cli-agents" ], "summary": "Set Key", "operationId": "set_key_api_v1_cli_agents__cli__key_put", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "cli", "in": "path", "required": true, "schema": { "enum": [ "claude", "codex", "gemini", "copilot", "kiro", "qwen", "opencode", "goose", "vibe" ], "type": "string", "title": "Cli" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CliKeyIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CliKeyOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "cli-agents" ], "summary": "Delete Key", "operationId": "delete_key_api_v1_cli_agents__cli__key_delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "cli", "in": "path", "required": true, "schema": { "enum": [ "claude", "codex", "gemini", "copilot", "kiro", "qwen", "opencode", "goose", "vibe" ], "type": "string", "title": "Cli" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/cli-agents/sessions": { "get": { "tags": [ "cli-agents" ], "summary": "Sessions", "description": "Sessions your seats ran in; pin one on a seat (``config.cli_session``) to resume it.", "operationId": "sessions_api_v1_cli_agents_sessions_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "cli", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "claude", "codex", "gemini", "copilot", "kiro", "qwen", "opencode", "goose", "vibe" ], "type": "string" }, { "type": "null" } ], "title": "Cli" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CliSessionOut" }, "title": "Response Sessions Api V1 Cli Agents Sessions Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/cli-agents/sessions/{session_row_id}": { "patch": { "tags": [ "cli-agents" ], "summary": "Rename Session", "operationId": "rename_session_api_v1_cli_agents_sessions__session_row_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "session_row_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Session Row Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CliSessionPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CliSessionOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/cli-agents/{cli}/login": { "get": { "tags": [ "cli-agents" ], "summary": "Login State", "description": "Your sign-in in progress for this CLI (``state: none`` when there is none).", "operationId": "login_state_api_v1_cli_agents__cli__login_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "cli", "in": "path", "required": true, "schema": { "enum": [ "claude", "codex", "gemini", "copilot", "kiro", "qwen", "opencode", "goose", "vibe" ], "type": "string", "title": "Cli" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Login State Api V1 Cli Agents Cli Login Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "cli-agents" ], "summary": "Login Start", "description": "Start the CLI's own sign-in in your runner home; returns the link (and code) to act on.", "operationId": "login_start_api_v1_cli_agents__cli__login_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "cli", "in": "path", "required": true, "schema": { "enum": [ "claude", "codex", "gemini", "copilot", "kiro", "qwen", "opencode", "goose", "vibe" ], "type": "string", "title": "Cli" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CliLoginStartIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Login Start Api V1 Cli Agents Cli Login Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "cli-agents" ], "summary": "Login Cancel", "operationId": "login_cancel_api_v1_cli_agents__cli__login_delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "cli", "in": "path", "required": true, "schema": { "enum": [ "claude", "codex", "gemini", "copilot", "kiro", "qwen", "opencode", "goose", "vibe" ], "type": "string", "title": "Cli" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Login Cancel Api V1 Cli Agents Cli Login Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/cli-agents/{cli}/login/code": { "post": { "tags": [ "cli-agents" ], "summary": "Login Code", "description": "Pass the authorization code shown by the vendor to the CLI. Never stored or logged.", "operationId": "login_code_api_v1_cli_agents__cli__login_code_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "cli", "in": "path", "required": true, "schema": { "enum": [ "claude", "codex", "gemini", "copilot", "kiro", "qwen", "opencode", "goose", "vibe" ], "type": "string", "title": "Cli" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CliLoginCodeIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Login Code Api V1 Cli Agents Cli Login Code Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/cli-agents/{cli}/logout": { "post": { "tags": [ "cli-agents" ], "summary": "Logout", "description": "Sign this CLI out of your vendor account (the CLI's own sign-out).", "operationId": "logout_api_v1_cli_agents__cli__logout_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "cli", "in": "path", "required": true, "schema": { "enum": [ "claude", "codex", "gemini", "copilot", "kiro", "qwen", "opencode", "goose", "vibe" ], "type": "string", "title": "Cli" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Logout Api V1 Cli Agents Cli Logout Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/runs": { "post": { "tags": [ "runs" ], "summary": "Create Run", "operationId": "create_run_api_v1_runs_post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunIn" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "runs" ], "summary": "List Runs", "operationId": "list_runs_api_v1_runs_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "mode", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mode" } }, { "name": "council_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Council Id" } }, { "name": "before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "Cursor: return runs created before this time", "title": "Before" }, "description": "Cursor: return runs created before this time" }, { "name": "before_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "description": "Cursor tie-breaker: with `before`, the id of the last run already seen", "title": "Before Id" }, "description": "Cursor tie-breaker: with `before`, the id of the last run already seen" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "view", "in": "query", "required": false, "schema": { "enum": [ "active", "archived", "trash", "all" ], "type": "string", "description": "active (default), archived, trash, or all (everything not in the trash)", "default": "active", "title": "View" }, "description": "active (default), archived, trash, or all (everything not in the trash)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RunOut" }, "title": "Response List Runs Api V1 Runs Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/runs/plan": { "post": { "tags": [ "runs" ], "summary": "Plan Run", "description": "Preview the council the server would compose for a task, with a model for every seat.\n\nSend the returned ``seats`` back as ``RunIn.seats`` to start exactly this council.", "operationId": "plan_run_api_v1_runs_plan_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanIn" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Plan Run Api V1 Runs Plan Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/runs/{run_id}": { "get": { "tags": [ "runs" ], "summary": "Get Run", "operationId": "get_run_api_v1_runs__run_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunDetail" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "runs" ], "summary": "Delete Run", "description": "Delete a run permanently (the UI moves runs to the trash first; see ``/trash``).", "operationId": "delete_run_api_v1_runs__run_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/runs/{run_id}/archive": { "post": { "tags": [ "runs" ], "summary": "Archive Run", "operationId": "archive_run_api_v1_runs__run_id__archive_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/runs/{run_id}/unarchive": { "post": { "tags": [ "runs" ], "summary": "Unarchive Run", "operationId": "unarchive_run_api_v1_runs__run_id__unarchive_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/runs/{run_id}/trash": { "post": { "tags": [ "runs" ], "summary": "Trash Run", "description": "Move a finished run to the trash; it is purged after ``retention_trash_days``.", "operationId": "trash_run_api_v1_runs__run_id__trash_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/runs/{run_id}/restore": { "post": { "tags": [ "runs" ], "summary": "Restore Run", "operationId": "restore_run_api_v1_runs__run_id__restore_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/runs/trash/empty": { "post": { "tags": [ "runs" ], "summary": "Empty Trash", "description": "Permanently delete every run in the caller's trash (artifact blobs are swept by retention).", "operationId": "empty_trash_api_v1_runs_trash_empty_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Empty Trash Api V1 Runs Trash Empty Post" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/runs/{run_id}/knowledge": { "get": { "tags": [ "runs" ], "summary": "Run Knowledge", "description": "Knowledge bases linked to this run.", "operationId": "run_knowledge_api_v1_runs__run_id__knowledge_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Run Knowledge Api V1 Runs Run Id Knowledge Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "runs" ], "summary": "Link Knowledge", "description": "Link knowledge bases to a run, before or while it runs; live agents use them from their next turn.", "operationId": "link_knowledge_api_v1_runs__run_id__knowledge_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeLinkIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Link Knowledge Api V1 Runs Run Id Knowledge Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/runs/{run_id}/knowledge/{kb_id}": { "delete": { "tags": [ "runs" ], "summary": "Unlink Knowledge", "operationId": "unlink_knowledge_api_v1_runs__run_id__knowledge__kb_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } }, { "name": "kb_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Kb Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Unlink Knowledge Api V1 Runs Run Id Knowledge Kb Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/runs/{run_id}/continue": { "post": { "tags": [ "runs" ], "summary": "Continue Run", "description": "Resume a halted, failed or cancelled run where it stopped, as a new run.\n\nThe new run replays every task the old one finished (no model calls) and does only the rest.", "operationId": "continue_run_api_v1_runs__run_id__continue_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ResumeIn" }, { "type": "null" } ], "title": "Data" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/runs/{run_id}/pause": { "post": { "tags": [ "runs" ], "summary": "Pause", "operationId": "pause_api_v1_runs__run_id__pause_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } } ], "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Pause Api V1 Runs Run Id Pause Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/runs/{run_id}/resume": { "post": { "tags": [ "runs" ], "summary": "Resume", "operationId": "resume_api_v1_runs__run_id__resume_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } } ], "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Resume Api V1 Runs Run Id Resume Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/runs/{run_id}/cancel": { "post": { "tags": [ "runs" ], "summary": "Cancel", "operationId": "cancel_api_v1_runs__run_id__cancel_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } } ], "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Cancel Api V1 Runs Run Id Cancel Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/runs/{run_id}/interventions": { "post": { "tags": [ "runs" ], "summary": "Intervene", "operationId": "intervene_api_v1_runs__run_id__interventions_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InterventionIn" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Intervene Api V1 Runs Run Id Interventions Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/runs/{run_id}/a2a": { "post": { "tags": [ "runs" ], "summary": "A2A Message", "description": "Talk to a live council in A2A form (the params of ``message/send``). The message reaches the\naddressed members at their next turn and stays in their instructions for the rest of the run.", "operationId": "a2a_message_api_v1_runs__run_id__a2a_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/A2ASendIn" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response A2A Message Api V1 Runs Run Id A2A Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/runs/{run_id}/approvals/{approval_id}": { "post": { "tags": [ "runs" ], "summary": "Decide", "operationId": "decide_api_v1_runs__run_id__approvals__approval_id__post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } }, { "name": "approval_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Approval Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovalDecisionIn" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Decide Api V1 Runs Run Id Approvals Approval Id Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/runs/{run_id}/auto-mode": { "post": { "tags": [ "runs" ], "summary": "Auto Mode", "operationId": "auto_mode_api_v1_runs__run_id__auto_mode_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoModeIn" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Auto Mode Api V1 Runs Run Id Auto Mode Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/runs/{run_id}/budget": { "post": { "tags": [ "runs" ], "summary": "Adjust Budget", "description": "Raise a live run's budget now and/or set the reserve it draws on instead of halting.", "operationId": "adjust_budget_api_v1_runs__run_id__budget_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BudgetIn" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Adjust Budget Api V1 Runs Run Id Budget Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/runs/{run_id}/events": { "get": { "tags": [ "runs" ], "summary": "Events", "operationId": "events_api_v1_runs__run_id__events_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } }, { "name": "after_seq", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "After Seq" } }, { "name": "before_seq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ], "title": "Before Seq" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 2000, "minimum": 1, "default": 500, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Events Api V1 Runs Run Id Events Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/runs/{run_id}/snapshot": { "get": { "tags": [ "runs" ], "summary": "Snapshot", "operationId": "snapshot_api_v1_runs__run_id__snapshot_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } }, { "name": "at_seq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "At Seq" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Snapshot Api V1 Runs Run Id Snapshot Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/runs/{run_id}/stream-ticket": { "post": { "tags": [ "runs" ], "summary": "Stream Ticket", "operationId": "stream_ticket_api_v1_runs__run_id__stream_ticket_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Stream Ticket Api V1 Runs Run Id Stream Ticket Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/runs/{run_id}/events/stream": { "get": { "tags": [ "runs" ], "summary": "Stream", "operationId": "stream_api_v1_runs__run_id__events_stream_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } }, { "name": "after_seq", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "After Seq" } }, { "name": "ticket", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ticket" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/runs/{run_id}/browser/{member_id}/frames": { "get": { "tags": [ "runs" ], "summary": "Browser Frames", "operationId": "browser_frames_api_v1_runs__run_id__browser__member_id__frames_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } }, { "name": "member_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Member Id" } }, { "name": "ticket", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ticket" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/runs/{run_id}/artifacts": { "get": { "tags": [ "runs" ], "summary": "Artifacts", "operationId": "artifacts_api_v1_runs__run_id__artifacts_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Artifacts Api V1 Runs Run Id Artifacts Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/runs/{run_id}/artifacts/content": { "get": { "tags": [ "runs" ], "summary": "Artifact Content", "operationId": "artifact_content_api_v1_runs__run_id__artifacts_content_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } }, { "name": "path", "in": "query", "required": true, "schema": { "type": "string", "maxLength": 500, "title": "Path" } }, { "name": "version", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ], "title": "Version" } } ], "responses": { "200": { "description": "Successful Response", "content": { "text/plain": { "schema": { "type": "string" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/runs/{run_id}/exports": { "post": { "tags": [ "runs" ], "summary": "Create Export", "operationId": "create_export_api_v1_runs__run_id__exports_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportIn" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Export Api V1 Runs Run Id Exports Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/runs/{run_id}/artifacts/download": { "get": { "tags": [ "runs" ], "summary": "Download Artifact", "operationId": "download_artifact_api_v1_runs__run_id__artifacts_download_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } }, { "name": "path", "in": "query", "required": true, "schema": { "type": "string", "maxLength": 500, "title": "Path" } }, { "name": "version", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ], "title": "Version" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/skills": { "get": { "tags": [ "skills" ], "summary": "List Skills", "operationId": "list_skills_api_v1_skills_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response List Skills Api V1 Skills Get" } } } } }, "security": [ { "HTTPBearer": [] } ] }, "post": { "tags": [ "skills" ], "summary": "Create Skill", "operationId": "create_skill_api_v1_skills_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillIn" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Create Skill Api V1 Skills Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/skills/validate": { "post": { "tags": [ "skills" ], "summary": "Validate", "operationId": "validate_api_v1_skills_validate_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillIn" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Validate Api V1 Skills Validate Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/skills/import": { "post": { "tags": [ "skills" ], "summary": "Import Skill", "operationId": "import_skill_api_v1_skills_import_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_import_skill_api_v1_skills_import_post" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Import Skill Api V1 Skills Import Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/skills/marketplace": { "get": { "tags": [ "skills" ], "summary": "List Marketplace", "operationId": "list_marketplace_api_v1_skills_marketplace_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response List Marketplace Api V1 Skills Marketplace Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/skills/marketplace/{name}": { "get": { "tags": [ "skills" ], "summary": "Get Marketplace Skill", "operationId": "get_marketplace_skill_api_v1_skills_marketplace__name__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Marketplace Skill Api V1 Skills Marketplace Name Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/skills/marketplace/{name}/install": { "post": { "tags": [ "skills" ], "summary": "Install Marketplace Skill", "operationId": "install_marketplace_skill_api_v1_skills_marketplace__name__install_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } } ], "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Install Marketplace Skill Api V1 Skills Marketplace Name Install Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/skills/{name}": { "get": { "tags": [ "skills" ], "summary": "Get Skill", "operationId": "get_skill_api_v1_skills__name__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Skill Api V1 Skills Name Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "skills" ], "summary": "Update Skill", "operationId": "update_skill_api_v1_skills__name__put", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Skill Api V1 Skills Name Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "skills" ], "summary": "Toggle Skill", "operationId": "toggle_skill_api_v1_skills__name__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Toggle Skill Api V1 Skills Name Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "skills" ], "summary": "Delete Skill", "operationId": "delete_skill_api_v1_skills__name__delete", "security": [ { "HTTPBearer": [] } ], "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" } } } } } } }, "/api/v1/skills/{name}/usage": { "get": { "tags": [ "skills" ], "summary": "Skill Usage", "operationId": "skill_usage_api_v1_skills__name__usage_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Skill Usage Api V1 Skills Name Usage Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/skills/{name}/export": { "get": { "tags": [ "skills" ], "summary": "Export Skill", "operationId": "export_skill_api_v1_skills__name__export_get", "security": [ { "HTTPBearer": [] } ], "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" } } } } } } }, "/api/v1/skills/{name}/versions": { "get": { "tags": [ "skills" ], "summary": "List Versions", "operationId": "list_versions_api_v1_skills__name__versions_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Versions Api V1 Skills Name Versions Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/skills/{name}/versions/{n}": { "get": { "tags": [ "skills" ], "summary": "Get Version", "operationId": "get_version_api_v1_skills__name__versions__n__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } }, { "name": "n", "in": "path", "required": true, "schema": { "type": "integer", "title": "N" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Version Api V1 Skills Name Versions N Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/skills/{name}/versions/{n}/restore": { "post": { "tags": [ "skills" ], "summary": "Restore Version", "operationId": "restore_version_api_v1_skills__name__versions__n__restore_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } }, { "name": "n", "in": "path", "required": true, "schema": { "type": "integer", "title": "N" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Restore Version Api V1 Skills Name Versions N Restore Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/mcp-servers": { "get": { "tags": [ "connections" ], "summary": "List Mcp", "operationId": "list_mcp_api_v1_mcp_servers_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response List Mcp Api V1 Mcp Servers Get" } } } } }, "security": [ { "HTTPBearer": [] } ] }, "post": { "tags": [ "connections" ], "summary": "Create Mcp", "operationId": "create_mcp_api_v1_mcp_servers_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpServerIn" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Create Mcp Api V1 Mcp Servers Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/mcp-servers/{server_id}": { "patch": { "tags": [ "connections" ], "summary": "Update Mcp", "operationId": "update_mcp_api_v1_mcp_servers__server_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Server Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpServerPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Mcp Api V1 Mcp Servers Server Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "connections" ], "summary": "Delete Mcp", "operationId": "delete_mcp_api_v1_mcp_servers__server_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Server Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/mcp-servers/{server_id}/discover": { "post": { "tags": [ "connections" ], "summary": "Discover Mcp", "operationId": "discover_mcp_api_v1_mcp_servers__server_id__discover_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Server Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Discover Mcp Api V1 Mcp Servers Server Id Discover Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/remote-agents": { "get": { "tags": [ "connections" ], "summary": "List Agents", "operationId": "list_agents_api_v1_remote_agents_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response List Agents Api V1 Remote Agents Get" } } } } }, "security": [ { "HTTPBearer": [] } ] }, "post": { "tags": [ "connections" ], "summary": "Create Agent", "operationId": "create_agent_api_v1_remote_agents_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteAgentIn" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Create Agent Api V1 Remote Agents Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/remote-agents/{agent_id}": { "patch": { "tags": [ "connections" ], "summary": "Update Agent", "operationId": "update_agent_api_v1_remote_agents__agent_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteAgentPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Agent Api V1 Remote Agents Agent Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "connections" ], "summary": "Delete Agent", "operationId": "delete_agent_api_v1_remote_agents__agent_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/remote-agents/{agent_id}/refresh": { "post": { "tags": [ "connections" ], "summary": "Refresh Agent", "description": "Fetch the A2A agent card and cache it (ledgered).", "operationId": "refresh_agent_api_v1_remote_agents__agent_id__refresh_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Refresh Agent Api V1 Remote Agents Agent Id Refresh Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/ledger": { "get": { "tags": [ "connections" ], "summary": "List Ledger", "description": "Newest first. Every filter is applied before ``limit``; page with ``next_before_seq``.", "operationId": "list_ledger_api_v1_ledger_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "protocol", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Protocol" } }, { "name": "run_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Run Id" } }, { "name": "purpose", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "run", "discover", "refresh" ], "type": "string" }, { "type": "null" } ], "title": "Purpose" } }, { "name": "before_seq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ], "title": "Before Seq" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Ledger Api V1 Ledger Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/ledger/verify": { "get": { "tags": [ "connections" ], "summary": "Verify Ledger", "operationId": "verify_ledger_api_v1_ledger_verify_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Verify Ledger Api V1 Ledger Verify Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/audit": { "get": { "tags": [ "observability" ], "summary": "Audit Log", "operationId": "audit_log_api_v1_audit_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "action", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 120 }, { "type": "null" } ], "title": "Action" } }, { "name": "success", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Success" } }, { "name": "all", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "All" } }, { "name": "before_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ], "title": "Before Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Audit Log Api V1 Audit Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/insights": { "get": { "tags": [ "observability" ], "summary": "Insights", "description": "Aggregate outcomes, spend by model, tool reliability, oversight activity and failures.\n\nTotals cover top-level runs only: a parent's ``usage`` already includes the spend charged back\nby its sub-councils. Per-model and per-tool breakdowns include the sub-runs' events, since that\nis where the sub-councils' calls are recorded.", "operationId": "insights_api_v1_insights_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "days", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 365, "minimum": 1, "default": 30, "title": "Days" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Insights Api V1 Insights Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/webhooks/events": { "get": { "tags": [ "webhooks" ], "summary": "List Events", "operationId": "list_events_api_v1_webhooks_events_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response List Events Api V1 Webhooks Events Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/webhooks": { "get": { "tags": [ "webhooks" ], "summary": "List Hooks", "operationId": "list_hooks_api_v1_webhooks_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response List Hooks Api V1 Webhooks Get" } } } } }, "security": [ { "HTTPBearer": [] } ] }, "post": { "tags": [ "webhooks" ], "summary": "Create Hook", "operationId": "create_hook_api_v1_webhooks_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookIn" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Create Hook Api V1 Webhooks Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/webhooks/{hook_id}": { "patch": { "tags": [ "webhooks" ], "summary": "Update Hook", "operationId": "update_hook_api_v1_webhooks__hook_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "hook_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Hook Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Hook Api V1 Webhooks Hook Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "webhooks" ], "summary": "Delete Hook", "operationId": "delete_hook_api_v1_webhooks__hook_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "hook_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Hook Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/webhooks/{hook_id}/rotate-secret": { "post": { "tags": [ "webhooks" ], "summary": "Rotate", "operationId": "rotate_api_v1_webhooks__hook_id__rotate_secret_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "hook_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Hook Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Rotate Api V1 Webhooks Hook Id Rotate Secret Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/webhooks/{hook_id}/test": { "post": { "tags": [ "webhooks" ], "summary": "Test Hook", "operationId": "test_hook_api_v1_webhooks__hook_id__test_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "hook_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Hook Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Test Hook Api V1 Webhooks Hook Id Test Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/webhooks/{hook_id}/deliveries": { "get": { "tags": [ "webhooks" ], "summary": "Deliveries", "operationId": "deliveries_api_v1_webhooks__hook_id__deliveries_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "hook_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Hook Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Deliveries Api V1 Webhooks Hook Id Deliveries Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/me/export": { "post": { "tags": [ "data" ], "summary": "Export Me", "description": "Download a zip of everything the signed-in user owns (secrets redacted).", "operationId": "export_me_api_v1_me_export_post", "responses": { "200": { "description": "Successful Response" } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/me": { "delete": { "tags": [ "data" ], "summary": "Delete Me", "description": "Permanently delete the signed-in account, everything it owns and its artifact blobs.", "operationId": "delete_me_api_v1_me_delete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAccountIn" } } }, "required": true }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/admin/retention": { "get": { "tags": [ "data" ], "summary": "Get Retention", "operationId": "get_retention_api_v1_admin_retention_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetentionOut" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/admin/retention/run": { "post": { "tags": [ "data" ], "summary": "Run Retention", "description": "Apply the policy now. With ``dry_run`` nothing is deleted and the counts are returned.", "operationId": "run_retention_api_v1_admin_retention_run_post", "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/RetentionRunIn" }, { "type": "null" } ], "title": "Data" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Run Retention Api V1 Admin Retention Run Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/knowledge-bases": { "get": { "tags": [ "knowledge" ], "summary": "List Kbs", "operationId": "list_kbs_api_v1_knowledge_bases_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response List Kbs Api V1 Knowledge Bases Get" } } } } }, "security": [ { "HTTPBearer": [] } ] }, "post": { "tags": [ "knowledge" ], "summary": "Create Kb", "operationId": "create_kb_api_v1_knowledge_bases_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseIn" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Create Kb Api V1 Knowledge Bases Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/knowledge-bases/search": { "get": { "tags": [ "knowledge" ], "summary": "Search All", "description": "Search across the caller's knowledge bases, optionally filtered by ``kb`` ids.", "operationId": "search_all_api_v1_knowledge_bases_search_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 500, "title": "Q" } }, { "name": "k", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 50, "minimum": 1, "default": 10, "title": "K" } }, { "name": "kb", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Kb" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Search All Api V1 Knowledge Bases Search Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/knowledge-bases/{kb_id}": { "get": { "tags": [ "knowledge" ], "summary": "Get Kb", "operationId": "get_kb_api_v1_knowledge_bases__kb_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "kb_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Kb Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Kb Api V1 Knowledge Bases Kb Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "knowledge" ], "summary": "Update Kb", "operationId": "update_kb_api_v1_knowledge_bases__kb_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "kb_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Kb Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBasePatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Kb Api V1 Knowledge Bases Kb Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "knowledge" ], "summary": "Delete Kb", "operationId": "delete_kb_api_v1_knowledge_bases__kb_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "kb_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Kb Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/knowledge-bases/{kb_id}/documents": { "get": { "tags": [ "knowledge" ], "summary": "List Documents", "operationId": "list_documents_api_v1_knowledge_bases__kb_id__documents_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "kb_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Kb Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Documents Api V1 Knowledge Bases Kb Id Documents Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "knowledge" ], "summary": "Upload Document", "operationId": "upload_document_api_v1_knowledge_bases__kb_id__documents_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "kb_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Kb Id" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_document_api_v1_knowledge_bases__kb_id__documents_post" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Upload Document Api V1 Knowledge Bases Kb Id Documents Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/knowledge-bases/{kb_id}/documents/text": { "post": { "tags": [ "knowledge" ], "summary": "Add Text Document", "description": "Add pasted text (notes, an abstract, an article) as a document.", "operationId": "add_text_document_api_v1_knowledge_bases__kb_id__documents_text_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "kb_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Kb Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextDocumentIn" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Add Text Document Api V1 Knowledge Bases Kb Id Documents Text Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/knowledge-bases/{kb_id}/documents/url": { "post": { "tags": [ "knowledge" ], "summary": "Add Url Document", "description": "Fetch a web page or text document (same SSRF checks as the agents' web_fetch) and add it.", "operationId": "add_url_document_api_v1_knowledge_bases__kb_id__documents_url_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "kb_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Kb Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UrlDocumentIn" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Add Url Document Api V1 Knowledge Bases Kb Id Documents Url Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/knowledge-bases/{kb_id}/documents/{doc_id}": { "delete": { "tags": [ "knowledge" ], "summary": "Delete Document", "operationId": "delete_document_api_v1_knowledge_bases__kb_id__documents__doc_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "kb_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Kb Id" } }, { "name": "doc_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Doc Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/knowledge-bases/{kb_id}/search": { "get": { "tags": [ "knowledge" ], "summary": "Search Kb", "operationId": "search_kb_api_v1_knowledge_bases__kb_id__search_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "kb_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Kb Id" } }, { "name": "q", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 500, "title": "Q" } }, { "name": "k", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 50, "minimum": 1, "default": 10, "title": "K" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Search Kb Api V1 Knowledge Bases Kb Id Search Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/memory": { "get": { "tags": [ "knowledge" ], "summary": "List Memory", "description": "List memory items. ``council_id`` narrows to one council; ``scope=global`` to council-less items.", "operationId": "list_memory_api_v1_memory_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "council_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Council Id" } }, { "name": "scope", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^(all|council|global)$", "default": "all", "title": "Scope" } }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 500, "default": "", "title": "Q" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 200, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Memory Api V1 Memory Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "knowledge" ], "summary": "Create Memory", "operationId": "create_memory_api_v1_memory_post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemoryIn" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Memory Api V1 Memory Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/memory/{item_id}": { "delete": { "tags": [ "knowledge" ], "summary": "Delete Memory", "operationId": "delete_memory_api_v1_memory__item_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Item Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/templates": { "get": { "tags": [ "templates" ], "summary": "List Templates", "operationId": "list_templates_api_v1_templates_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response List Templates Api V1 Templates Get" } } } } }, "security": [ { "HTTPBearer": [] } ] }, "post": { "tags": [ "templates" ], "summary": "Create Template", "operationId": "create_template_api_v1_templates_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateIn" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Create Template Api V1 Templates Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/templates/{template_id}": { "get": { "tags": [ "templates" ], "summary": "Get Template", "operationId": "get_template_api_v1_templates__template_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "template_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Template Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Template Api V1 Templates Template Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "templates" ], "summary": "Update Template", "operationId": "update_template_api_v1_templates__template_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "template_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Template Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplatePatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Template Api V1 Templates Template Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "templates" ], "summary": "Delete Template", "operationId": "delete_template_api_v1_templates__template_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "template_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Template Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/templates/{template_id}/run": { "post": { "tags": [ "templates" ], "summary": "Run Template", "operationId": "run_template_api_v1_templates__template_id__run_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "template_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Template Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateRunIn" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/notifications": { "get": { "tags": [ "notifications" ], "summary": "List Notifications", "operationId": "list_notifications_api_v1_notifications_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "unread", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Unread" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 30, "title": "Limit" } }, { "name": "before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "Cursor: notifications created before this", "title": "Before" }, "description": "Cursor: notifications created before this" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Notifications Api V1 Notifications Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/notifications/unread-count": { "get": { "tags": [ "notifications" ], "summary": "Get Unread Count", "operationId": "get_unread_count_api_v1_notifications_unread_count_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Get Unread Count Api V1 Notifications Unread Count Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/notifications/read-all": { "post": { "tags": [ "notifications" ], "summary": "Read All", "operationId": "read_all_api_v1_notifications_read_all_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Read All Api V1 Notifications Read All Post" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/notifications/{notification_id}/read": { "post": { "tags": [ "notifications" ], "summary": "Read One", "operationId": "read_one_api_v1_notifications__notification_id__read_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "notification_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Notification Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Read One Api V1 Notifications Notification Id Read Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mcp": { "get": { "tags": [ "mcp" ], "summary": "Mcp Get", "operationId": "mcp_get_mcp_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } }, "post": { "tags": [ "mcp" ], "summary": "Mcp Endpoint", "operationId": "mcp_endpoint_mcp_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/.well-known/agent.json": { "get": { "tags": [ "a2a" ], "summary": "Well Known Card", "operationId": "well_known_card__well_known_agent_json_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Well Known Card Well Known Agent Json Get" } } } } } } }, "/.well-known/agent-card.json": { "get": { "tags": [ "a2a" ], "summary": "Well Known Card", "operationId": "well_known_card__well_known_agent_card_json_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Well Known Card Well Known Agent Card Json Get" } } } } } } }, "/a2a": { "post": { "tags": [ "a2a" ], "summary": "A2A Endpoint", "operationId": "a2a_endpoint_a2a_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } } }, "components": { "schemas": { "A2APart": { "properties": { "kind": { "type": "string", "const": "text", "title": "Kind", "default": "text" }, "text": { "type": "string", "maxLength": 20000, "minLength": 1, "title": "Text" } }, "type": "object", "required": [ "text" ], "title": "A2APart" }, "A2ASendIn": { "properties": { "message": { "$ref": "#/components/schemas/A2AUserMessage" } }, "type": "object", "required": [ "message" ], "title": "A2ASendIn", "description": "The params of A2A ``message/send``." }, "A2AUserMessage": { "properties": { "kind": { "type": "string", "const": "message", "title": "Kind", "default": "message" }, "role": { "type": "string", "const": "user", "title": "Role", "default": "user" }, "parts": { "items": { "$ref": "#/components/schemas/A2APart" }, "type": "array", "maxItems": 20, "minItems": 1, "title": "Parts" }, "messageId": { "anyOf": [ { "type": "string", "maxLength": 80 }, { "type": "null" } ], "title": "Messageid" }, "metadata": { "additionalProperties": true, "type": "object", "title": "Metadata" } }, "additionalProperties": true, "type": "object", "required": [ "parts" ], "title": "A2AUserMessage", "description": "An A2A ``Message`` from the user. ``metadata.to`` names a member (name or role); omitted means\nthe whole council." }, "AccountOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "email": { "type": "string", "title": "Email" }, "display_name": { "type": "string", "title": "Display Name" }, "is_admin": { "type": "boolean", "title": "Is Admin" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "role": { "type": "string", "enum": [ "admin", "member", "viewer" ], "title": "Role" }, "mfa_enabled": { "type": "boolean", "title": "Mfa Enabled", "default": false } }, "type": "object", "required": [ "id", "email", "display_name", "is_admin", "created_at", "role" ], "title": "AccountOut", "description": "UserOut plus the RBAC role (\"admin\" | \"member\" | \"viewer\"); `is_admin` mirrors role == \"admin\"." }, "AdminUserOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "email": { "type": "string", "title": "Email" }, "display_name": { "type": "string", "title": "Display Name" }, "role": { "type": "string", "enum": [ "admin", "member", "viewer" ], "title": "Role" }, "is_admin": { "type": "boolean", "title": "Is Admin" }, "is_active": { "type": "boolean", "title": "Is Active" }, "mfa_enabled": { "type": "boolean", "title": "Mfa Enabled", "default": false }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "last_login_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Login At" }, "run_count": { "type": "integer", "title": "Run Count" } }, "type": "object", "required": [ "id", "email", "display_name", "role", "is_admin", "is_active", "created_at", "last_login_at", "run_count" ], "title": "AdminUserOut" }, "AdminUserPatch": { "properties": { "role": { "anyOf": [ { "type": "string", "enum": [ "admin", "member", "viewer" ] }, { "type": "null" } ], "title": "Role" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active" }, "reset_mfa": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Reset Mfa" } }, "additionalProperties": false, "type": "object", "title": "AdminUserPatch" }, "ApiKeyCreated": { "properties": { "id": { "type": "string", "format": "uuid", "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" }, "last_used_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Used At" }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Expires At" }, "revoked": { "type": "boolean", "title": "Revoked" }, "key": { "type": "string", "title": "Key", "description": "Plaintext key. Shown exactly once." } }, "type": "object", "required": [ "id", "name", "prefix", "scopes", "created_at", "last_used_at", "expires_at", "revoked", "key" ], "title": "ApiKeyCreated" }, "ApiKeyIn": { "properties": { "name": { "type": "string", "maxLength": 120, "minLength": 1, "title": "Name" }, "scopes": { "items": { "type": "string" }, "type": "array", "maxItems": 20, "title": "Scopes" }, "expires_in_days": { "anyOf": [ { "type": "integer", "maximum": 3650.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Expires In Days" } }, "type": "object", "required": [ "name" ], "title": "ApiKeyIn" }, "ApiKeyOut": { "properties": { "id": { "type": "string", "format": "uuid", "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" }, "last_used_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Used At" }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Expires At" }, "revoked": { "type": "boolean", "title": "Revoked" } }, "type": "object", "required": [ "id", "name", "prefix", "scopes", "created_at", "last_used_at", "expires_at", "revoked" ], "title": "ApiKeyOut" }, "ApprovalDecisionIn": { "properties": { "decision": { "type": "string", "enum": [ "approve", "reject" ], "title": "Decision" }, "edited_args": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Edited Args" }, "reason": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ], "title": "Reason" } }, "type": "object", "required": [ "decision" ], "title": "ApprovalDecisionIn" }, "AutoModeIn": { "properties": { "tools": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Tools" }, "extensions": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Extensions" } }, "type": "object", "title": "AutoModeIn", "description": "Switch a live run's auto mode; a flag left out keeps its current value." }, "Body_import_skill_api_v1_skills_import_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_import_skill_api_v1_skills_import_post" }, "Body_upload_document_api_v1_knowledge_bases__kb_id__documents_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_upload_document_api_v1_knowledge_bases__kb_id__documents_post" }, "BudgetIn": { "properties": { "add_usd": { "anyOf": [ { "type": "number", "maximum": 10000.0, "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "Add Usd" }, "add_tokens": { "anyOf": [ { "type": "integer", "maximum": 1000000000.0, "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "Add Tokens" }, "buffer_usd": { "anyOf": [ { "type": "number", "maximum": 10000.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Buffer Usd" }, "buffer_tokens": { "anyOf": [ { "type": "integer", "maximum": 1000000000.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Buffer Tokens" } }, "type": "object", "title": "BudgetIn", "description": "Change a live run's budget: raise it now (``add_*``) and/or set its reserve (``buffer_*``)." }, "ChatMessageIn": { "properties": { "role": { "type": "string", "enum": [ "system", "user", "assistant" ], "title": "Role" }, "content": { "type": "string", "maxLength": 200000, "title": "Content" } }, "type": "object", "required": [ "role", "content" ], "title": "ChatMessageIn" }, "CliKeyIn": { "properties": { "api_key": { "type": "string", "maxLength": 512, "minLength": 8, "title": "Api Key" }, "provider": { "anyOf": [ { "type": "string", "maxLength": 32, "pattern": "^[a-z0-9_]+$" }, { "type": "null" } ], "title": "Provider" } }, "type": "object", "required": [ "api_key" ], "title": "CliKeyIn" }, "CliKeyOut": { "properties": { "cli": { "type": "string", "title": "Cli" }, "has_api_key": { "type": "boolean", "title": "Has Api Key" }, "key_hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Key Hint" }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" } }, "type": "object", "required": [ "cli", "has_api_key" ], "title": "CliKeyOut" }, "CliLoginCodeIn": { "properties": { "code": { "type": "string", "maxLength": 512, "minLength": 1, "title": "Code" } }, "type": "object", "required": [ "code" ], "title": "CliLoginCodeIn" }, "CliLoginStartIn": { "properties": { "method": { "anyOf": [ { "type": "string", "maxLength": 32, "pattern": "^[a-z_]+$" }, { "type": "null" } ], "title": "Method" } }, "type": "object", "title": "CliLoginStartIn" }, "CliSessionOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "cli": { "type": "string", "title": "Cli" }, "session_id": { "type": "string", "title": "Session Id" }, "label": { "type": "string", "title": "Label" }, "run_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Run Id" }, "member_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Member Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "last_used_at": { "type": "string", "format": "date-time", "title": "Last Used At" } }, "type": "object", "required": [ "id", "cli", "session_id", "label", "run_id", "member_id", "created_at", "last_used_at" ], "title": "CliSessionOut" }, "CliSessionPatch": { "properties": { "label": { "type": "string", "maxLength": 120, "pattern": "^[\\w .:\\-]*$", "title": "Label" } }, "type": "object", "required": [ "label" ], "title": "CliSessionPatch" }, "CodeIn": { "properties": { "code": { "type": "string", "maxLength": 32, "minLength": 6, "title": "Code", "description": "Authenticator code or recovery code" } }, "type": "object", "required": [ "code" ], "title": "CodeIn" }, "CompleteIn": { "properties": { "provider": { "type": "string", "maxLength": 64, "title": "Provider", "default": "mock" }, "model": { "type": "string", "maxLength": 120, "title": "Model", "default": "mock-1" }, "messages": { "items": { "$ref": "#/components/schemas/ChatMessageIn" }, "type": "array", "maxItems": 200, "minItems": 1, "title": "Messages" }, "max_tokens": { "type": "integer", "maximum": 128000.0, "minimum": 1.0, "title": "Max Tokens", "default": 4096 }, "temperature": { "anyOf": [ { "type": "number", "maximum": 2.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Temperature" }, "effort": { "anyOf": [ { "type": "string", "enum": [ "low", "medium", "high", "xhigh", "max" ] }, { "type": "null" } ], "title": "Effort" }, "cache": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Cache" }, "fallbacks": { "items": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": "array", "maxItems": 5, "title": "Fallbacks" } }, "type": "object", "required": [ "messages" ], "title": "CompleteIn" }, "CouncilIn": { "properties": { "name": { "type": "string", "maxLength": 80, "minLength": 1, "pattern": "^[\\w .\\-]+$", "title": "Name" }, "description": { "type": "string", "maxLength": 4000, "title": "Description", "default": "" }, "mode": { "type": "string", "enum": [ "general", "research", "coding", "chat" ], "title": "Mode", "default": "general" }, "min_size": { "type": "integer", "maximum": 64.0, "minimum": 1.0, "title": "Min Size", "default": 1 }, "max_size": { "type": "integer", "maximum": 64.0, "minimum": 1.0, "title": "Max Size", "default": 12 }, "guardrails": { "additionalProperties": true, "type": "object", "title": "Guardrails" }, "members": { "anyOf": [ { "items": { "$ref": "#/components/schemas/MemberIn" }, "type": "array" }, { "type": "null" } ], "title": "Members", "description": "Explicit seats. Omit to seat the default roster for the mode." }, "size": { "anyOf": [ { "type": "integer", "maximum": 64.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Size", "description": "Seats to fill from the default roster." }, "default_provider": { "type": "string", "title": "Default Provider", "default": "mock" }, "default_model": { "type": "string", "title": "Default Model", "default": "mock-1" } }, "type": "object", "required": [ "name" ], "title": "CouncilIn" }, "CouncilOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "mode": { "type": "string", "title": "Mode" }, "min_size": { "type": "integer", "title": "Min Size" }, "max_size": { "type": "integer", "title": "Max Size" }, "guardrails": { "additionalProperties": true, "type": "object", "title": "Guardrails" }, "parent_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Parent Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "members": { "items": { "$ref": "#/components/schemas/MemberOut" }, "type": "array", "title": "Members" } }, "type": "object", "required": [ "id", "name", "description", "mode", "min_size", "max_size", "guardrails", "parent_id", "created_at", "updated_at", "members" ], "title": "CouncilOut" }, "CouncilPatch": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 80, "minLength": 1, "pattern": "^[\\w .\\-]+$" }, { "type": "null" } ], "title": "Name" }, "description": { "anyOf": [ { "type": "string", "maxLength": 4000 }, { "type": "null" } ], "title": "Description" }, "mode": { "anyOf": [ { "type": "string", "enum": [ "general", "research", "coding", "chat" ] }, { "type": "null" } ], "title": "Mode" }, "min_size": { "anyOf": [ { "type": "integer", "maximum": 64.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Min Size" }, "max_size": { "anyOf": [ { "type": "integer", "maximum": 64.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Max Size" }, "guardrails": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Guardrails" } }, "type": "object", "title": "CouncilPatch" }, "DeleteAccountIn": { "properties": { "password": { "type": "string", "maxLength": 256, "minLength": 1, "title": "Password" } }, "type": "object", "required": [ "password" ], "title": "DeleteAccountIn" }, "ExportIn": { "properties": { "format": { "type": "string", "enum": [ "txt", "md", "latex", "pdf", "html", "docx", "json" ], "title": "Format" } }, "type": "object", "required": [ "format" ], "title": "ExportIn" }, "FeatureOut": { "properties": { "key": { "type": "string", "enum": [ "browser", "cli_agents" ], "title": "Key" }, "label": { "type": "string", "title": "Label" }, "installed": { "type": "boolean", "title": "Installed" }, "status": { "type": "string", "enum": [ "reachable", "unreachable", "not_installed" ], "title": "Status" }, "enabled": { "type": "boolean", "title": "Enabled" }, "active": { "type": "boolean", "title": "Active" }, "install_command": { "type": "string", "title": "Install Command" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated By" } }, "type": "object", "required": [ "key", "label", "installed", "status", "enabled", "active", "install_command", "updated_at", "updated_by" ], "title": "FeatureOut" }, "FeaturePatch": { "properties": { "enabled": { "type": "boolean", "title": "Enabled" } }, "additionalProperties": false, "type": "object", "required": [ "enabled" ], "title": "FeaturePatch" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "InterventionIn": { "properties": { "kind": { "type": "string", "enum": [ "message", "intercept", "hold", "release", "correct", "halt_all", "release_all" ], "title": "Kind" }, "target": { "additionalProperties": true, "type": "object", "title": "Target" }, "text": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ], "title": "Text" }, "scope": { "anyOf": [ { "type": "string", "enum": [ "thought", "member", "council" ] }, { "type": "null" } ], "title": "Scope" } }, "type": "object", "required": [ "kind" ], "title": "InterventionIn" }, "KnowledgeBaseIn": { "properties": { "name": { "type": "string", "maxLength": 120, "minLength": 1, "title": "Name" }, "description": { "type": "string", "maxLength": 2000, "title": "Description", "default": "" } }, "type": "object", "required": [ "name" ], "title": "KnowledgeBaseIn" }, "KnowledgeBasePatch": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 120, "minLength": 1 }, { "type": "null" } ], "title": "Name" }, "description": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ], "title": "Description" } }, "type": "object", "title": "KnowledgeBasePatch" }, "KnowledgeLinkIn": { "properties": { "knowledge_base_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "maxItems": 20, "minItems": 1, "title": "Knowledge Base Ids" } }, "type": "object", "required": [ "knowledge_base_ids" ], "title": "KnowledgeLinkIn" }, "LoginIn": { "properties": { "email": { "type": "string", "format": "email", "title": "Email" }, "password": { "type": "string", "maxLength": 256, "title": "Password" } }, "type": "object", "required": [ "email", "password" ], "title": "LoginIn" }, "McpServerIn": { "properties": { "name": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": "^[a-z0-9][a-z0-9_\\-]*$", "title": "Name" }, "transport": { "type": "string", "enum": [ "http", "stdio" ], "title": "Transport", "default": "http" }, "url": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Url" }, "command": { "items": { "type": "string" }, "type": "array", "maxItems": 50, "title": "Command" }, "headers": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Headers", "description": "Extra headers (e.g. Authorization); for stdio, environment variables. Stored encrypted, never returned." }, "tool_allow": { "items": { "type": "string" }, "type": "array", "maxItems": 200, "title": "Tool Allow" }, "risk": { "items": { "type": "string" }, "type": "array", "maxItems": 20, "title": "Risk" }, "trust": { "type": "string", "enum": [ "trusted", "ask", "blocked" ], "title": "Trust", "description": "trusted: tools run without extra approval; ask: every tool call needs approval; blocked: the server's tools are never attached to runs", "default": "ask" }, "require_approval": { "items": { "type": "string", "maxLength": 200, "minLength": 1 }, "type": "array", "maxItems": 200, "title": "Require Approval", "description": "Tool names that always need approval" }, "enabled": { "type": "boolean", "title": "Enabled", "default": true } }, "type": "object", "required": [ "name" ], "title": "McpServerIn" }, "McpServerPatch": { "properties": { "url": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Url" }, "headers": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Headers" }, "tool_allow": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 200 }, { "type": "null" } ], "title": "Tool Allow" }, "risk": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 20 }, { "type": "null" } ], "title": "Risk" }, "trust": { "anyOf": [ { "type": "string", "enum": [ "trusted", "ask", "blocked" ] }, { "type": "null" } ], "title": "Trust" }, "require_approval": { "anyOf": [ { "items": { "type": "string", "maxLength": 200, "minLength": 1 }, "type": "array", "maxItems": 200 }, { "type": "null" } ], "title": "Require Approval" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" } }, "type": "object", "title": "McpServerPatch" }, "MemberIn": { "properties": { "name": { "type": "string", "maxLength": 80, "minLength": 1, "pattern": "^[\\w .\\-]+$", "title": "Name" }, "role": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": "^[a-z][a-z0-9_]*$", "title": "Role" }, "provider": { "type": "string", "maxLength": 40, "title": "Provider", "default": "mock" }, "model": { "type": "string", "maxLength": 120, "title": "Model", "default": "mock-1" }, "system_prompt": { "type": "string", "maxLength": 20000, "title": "System Prompt", "default": "" }, "temperature": { "type": "number", "maximum": 2.0, "minimum": 0.0, "title": "Temperature", "default": 0.3 }, "enabled": { "type": "boolean", "title": "Enabled", "default": true }, "config": { "additionalProperties": true, "type": "object", "title": "Config" } }, "type": "object", "required": [ "name", "role" ], "title": "MemberIn" }, "MemberOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "role": { "type": "string", "title": "Role" }, "provider": { "type": "string", "title": "Provider" }, "model": { "type": "string", "title": "Model" }, "system_prompt": { "type": "string", "title": "System Prompt" }, "temperature": { "type": "number", "title": "Temperature" }, "position": { "type": "integer", "title": "Position" }, "enabled": { "type": "boolean", "title": "Enabled" }, "config": { "additionalProperties": true, "type": "object", "title": "Config" } }, "type": "object", "required": [ "id", "name", "role", "provider", "model", "system_prompt", "temperature", "position", "enabled", "config" ], "title": "MemberOut" }, "MemberPatch": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 80, "minLength": 1, "pattern": "^[\\w .\\-]+$" }, { "type": "null" } ], "title": "Name" }, "role": { "anyOf": [ { "type": "string", "maxLength": 40, "pattern": "^[a-z][a-z0-9_]*$" }, { "type": "null" } ], "title": "Role" }, "provider": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ], "title": "Provider" }, "model": { "anyOf": [ { "type": "string", "maxLength": 120 }, { "type": "null" } ], "title": "Model" }, "system_prompt": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ], "title": "System Prompt" }, "temperature": { "anyOf": [ { "type": "number", "maximum": 2.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Temperature" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" }, "position": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Position" }, "config": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Config" } }, "type": "object", "title": "MemberPatch" }, "MemoryIn": { "properties": { "text": { "type": "string", "maxLength": 4000, "minLength": 1, "title": "Text" }, "key": { "type": "string", "maxLength": 120, "title": "Key", "default": "" }, "tags": { "items": { "type": "string" }, "type": "array", "maxItems": 20, "title": "Tags" }, "council_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Council Id" } }, "type": "object", "required": [ "text" ], "title": "MemoryIn" }, "MfaChallengeOut": { "properties": { "mfa_required": { "type": "boolean", "const": true, "title": "Mfa Required", "default": true }, "mfa_token": { "type": "string", "title": "Mfa Token" }, "expires_in": { "type": "integer", "title": "Expires In" } }, "type": "object", "required": [ "mfa_token", "expires_in" ], "title": "MfaChallengeOut" }, "MfaStatusOut": { "properties": { "enabled": { "type": "boolean", "title": "Enabled" }, "pending": { "type": "boolean", "title": "Pending" }, "recovery_codes_left": { "type": "integer", "title": "Recovery Codes Left" } }, "type": "object", "required": [ "enabled", "pending", "recovery_codes_left" ], "title": "MfaStatusOut" }, "PasswordCodeIn": { "properties": { "code": { "type": "string", "maxLength": 32, "minLength": 6, "title": "Code", "description": "Authenticator code or recovery code" }, "password": { "type": "string", "maxLength": 256, "minLength": 1, "title": "Password" } }, "type": "object", "required": [ "code", "password" ], "title": "PasswordCodeIn" }, "PasswordIn": { "properties": { "password": { "type": "string", "maxLength": 256, "minLength": 1, "title": "Password" } }, "type": "object", "required": [ "password" ], "title": "PasswordIn" }, "PlanIn": { "properties": { "topic": { "type": "string", "maxLength": 500, "minLength": 1, "title": "Topic" }, "description": { "type": "string", "maxLength": 20000, "title": "Description", "default": "" }, "mode": { "type": "string", "enum": [ "general", "research", "coding", "chat" ], "title": "Mode", "default": "general" }, "max_size": { "type": "integer", "maximum": 12.0, "minimum": 1.0, "title": "Max Size", "default": 12 }, "provider": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "Provider", "description": "The user's preferred provider" }, "model": { "anyOf": [ { "type": "string", "maxLength": 120 }, { "type": "null" } ], "title": "Model" }, "auto_council": { "type": "boolean", "title": "Auto Council", "default": true }, "auto_models": { "type": "boolean", "title": "Auto Models", "default": true }, "roles": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 64 }, { "type": "null" } ], "title": "Roles", "description": "Fixed roles (only pick models)" }, "model_strategy": { "type": "string", "enum": [ "quality", "balanced", "economy" ], "title": "Model Strategy", "description": "How model choice trades competence against cost", "default": "balanced" }, "budget_usd": { "anyOf": [ { "type": "number", "minimum": 0.0 }, { "type": "null" } ], "title": "Budget Usd", "description": "The run's dollar budget the council is fitted to (null: none)", "default": 5.0 } }, "type": "object", "required": [ "topic" ], "title": "PlanIn" }, "ProfilePatch": { "properties": { "display_name": { "anyOf": [ { "type": "string", "maxLength": 120 }, { "type": "null" } ], "title": "Display Name" }, "current_password": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ], "title": "Current Password" }, "new_password": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 12 }, { "type": "null" } ], "title": "New Password" } }, "type": "object", "title": "ProfilePatch" }, "ProviderConfigIn": { "properties": { "name": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[a-z0-9][a-z0-9_\\-]*$", "title": "Name" }, "kind": { "type": "string", "maxLength": 40, "title": "Kind" }, "base_url": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Base Url" }, "api_key": { "anyOf": [ { "type": "string", "maxLength": 4000 }, { "type": "null" } ], "title": "Api Key" }, "default_model": { "anyOf": [ { "type": "string", "maxLength": 120 }, { "type": "null" } ], "title": "Default Model" }, "enabled": { "type": "boolean", "title": "Enabled", "default": true }, "options": { "additionalProperties": true, "type": "object", "title": "Options" } }, "type": "object", "required": [ "name", "kind" ], "title": "ProviderConfigIn" }, "ProviderConfigPatch": { "properties": { "base_url": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Base Url" }, "api_key": { "anyOf": [ { "type": "string", "maxLength": 4000 }, { "type": "null" } ], "title": "Api Key" }, "default_model": { "anyOf": [ { "type": "string", "maxLength": 120 }, { "type": "null" } ], "title": "Default Model" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" }, "options": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Options" } }, "type": "object", "title": "ProviderConfigPatch" }, "ProviderOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "kind": { "type": "string", "title": "Kind" }, "base_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Base Url" }, "default_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Default Model" }, "enabled": { "type": "boolean", "title": "Enabled" }, "options": { "additionalProperties": true, "type": "object", "title": "Options" }, "has_api_key": { "type": "boolean", "title": "Has Api Key", "default": false }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "key_hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Key Hint" }, "health_status": { "type": "string", "enum": [ "unknown", "ok", "unreachable", "auth_failed", "rate_limited", "error" ], "title": "Health Status", "default": "unknown" }, "health_detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Health Detail" }, "health_checked_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Health Checked At" }, "health_latency_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Health Latency Ms" } }, "type": "object", "required": [ "id", "name", "kind", "base_url", "default_model", "enabled", "options", "created_at", "updated_at" ], "title": "ProviderOut", "description": "Provider config as returned by the API: never the key, only a masked hint plus health." }, "ProviderTestIn": { "properties": { "model": { "anyOf": [ { "type": "string", "maxLength": 120 }, { "type": "null" } ], "title": "Model" } }, "type": "object", "title": "ProviderTestIn" }, "ProviderTestOut": { "properties": { "provider": { "type": "string", "title": "Provider" }, "ok": { "type": "boolean", "title": "Ok" }, "status": { "type": "string", "enum": [ "unknown", "ok", "unreachable", "auth_failed", "rate_limited", "error" ], "title": "Status" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Detail" }, "latency_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Latency Ms" }, "checked_at": { "type": "string", "format": "date-time", "title": "Checked At" }, "probe": { "type": "string", "title": "Probe" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" }, "model_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Model Count" }, "persisted": { "type": "boolean", "title": "Persisted" }, "config": { "anyOf": [ { "$ref": "#/components/schemas/ProviderOut" }, { "type": "null" } ] } }, "type": "object", "required": [ "provider", "ok", "status", "checked_at", "probe", "persisted" ], "title": "ProviderTestOut" }, "RecoveryCodesOut": { "properties": { "recovery_codes": { "items": { "type": "string" }, "type": "array", "title": "Recovery Codes" } }, "type": "object", "required": [ "recovery_codes" ], "title": "RecoveryCodesOut" }, "RefreshIn": { "properties": { "refresh_token": { "type": "string", "title": "Refresh Token" } }, "type": "object", "required": [ "refresh_token" ], "title": "RefreshIn" }, "RegisterIn": { "properties": { "email": { "type": "string", "format": "email", "title": "Email" }, "password": { "type": "string", "maxLength": 256, "minLength": 12, "title": "Password" }, "display_name": { "type": "string", "maxLength": 120, "title": "Display Name", "default": "" } }, "type": "object", "required": [ "email", "password" ], "title": "RegisterIn" }, "RemoteAgentIn": { "properties": { "name": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": "^[a-z0-9][a-z0-9_\\-]*$", "title": "Name" }, "protocol": { "type": "string", "const": "a2a", "title": "Protocol" }, "url": { "type": "string", "maxLength": 500, "title": "Url", "description": "A2A JSON-RPC endpoint" }, "token": { "anyOf": [ { "type": "string", "maxLength": 4000 }, { "type": "null" } ], "title": "Token" }, "description": { "type": "string", "maxLength": 2000, "title": "Description", "default": "" }, "enabled": { "type": "boolean", "title": "Enabled", "default": true }, "requires_approval": { "type": "boolean", "title": "Requires Approval", "description": "Delegating to this agent needs approval", "default": true } }, "type": "object", "required": [ "name", "protocol", "url" ], "title": "RemoteAgentIn" }, "RemoteAgentPatch": { "properties": { "url": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Url" }, "token": { "anyOf": [ { "type": "string", "maxLength": 4000 }, { "type": "null" } ], "title": "Token" }, "description": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ], "title": "Description" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" }, "requires_approval": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Requires Approval" } }, "additionalProperties": false, "type": "object", "title": "RemoteAgentPatch" }, "ResizeIn": { "properties": { "size": { "type": "integer", "maximum": 64.0, "minimum": 1.0, "title": "Size" }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" } }, "type": "object", "required": [ "size" ], "title": "ResizeIn" }, "ResumeIn": { "properties": { "guardrails": { "additionalProperties": true, "type": "object", "title": "Guardrails" } }, "type": "object", "title": "ResumeIn", "description": "Options for resuming a run; ``guardrails`` are merged over the old run's (e.g. a higher limit)." }, "RetentionOut": { "properties": { "policy": { "additionalProperties": true, "type": "object", "title": "Policy" }, "last_run": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Last Run" }, "enabled": { "type": "boolean", "title": "Enabled" } }, "type": "object", "required": [ "policy", "last_run", "enabled" ], "title": "RetentionOut" }, "RetentionRunIn": { "properties": { "dry_run": { "type": "boolean", "title": "Dry Run", "default": false } }, "type": "object", "title": "RetentionRunIn" }, "RunDetail": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "council_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Council Id" }, "parent_run_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Parent Run Id" }, "topic": { "type": "string", "title": "Topic" }, "description": { "type": "string", "title": "Description" }, "mode": { "type": "string", "title": "Mode" }, "status": { "type": "string", "title": "Status" }, "outputs": { "items": { "type": "string" }, "type": "array", "title": "Outputs" }, "guardrails": { "additionalProperties": true, "type": "object", "title": "Guardrails" }, "usage": { "additionalProperties": true, "type": "object", "title": "Usage" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "last_seq": { "type": "integer", "title": "Last Seq" }, "created_at": { "type": "string", "format": "date-time", "title": "Created 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" }, "archived_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Archived At" }, "trashed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Trashed At" }, "knowledge_base_ids": { "items": { "type": "string" }, "type": "array", "title": "Knowledge Base Ids" }, "resumed_from_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Resumed From Id" }, "pending_approvals": { "type": "integer", "title": "Pending Approvals", "default": 0 }, "result": { "type": "string", "title": "Result" }, "council_snapshot": { "additionalProperties": true, "type": "object", "title": "Council Snapshot" } }, "type": "object", "required": [ "id", "council_id", "parent_run_id", "topic", "description", "mode", "status", "outputs", "guardrails", "usage", "error", "last_seq", "created_at", "started_at", "finished_at", "result", "council_snapshot" ], "title": "RunDetail" }, "RunIn": { "properties": { "topic": { "type": "string", "maxLength": 500, "minLength": 1, "title": "Topic" }, "description": { "type": "string", "maxLength": 20000, "title": "Description", "default": "" }, "mode": { "type": "string", "enum": [ "general", "research", "coding", "chat" ], "title": "Mode", "default": "general" }, "council_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Council Id" }, "size": { "anyOf": [ { "type": "integer", "maximum": 64.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Size" }, "provider": { "type": "string", "maxLength": 64, "title": "Provider", "default": "mock" }, "model": { "type": "string", "maxLength": 120, "title": "Model", "default": "mock-1" }, "outputs": { "items": { "type": "string", "enum": [ "txt", "md", "latex", "pdf", "html", "docx", "json" ] }, "type": "array", "maxItems": 7, "title": "Outputs" }, "guardrails": { "additionalProperties": true, "type": "object", "title": "Guardrails" }, "knowledge_base_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "maxItems": 20, "title": "Knowledge Base Ids", "description": "Knowledge bases to link to the run from the start" }, "seats": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SeatIn" }, "type": "array", "maxItems": 64, "minItems": 1 }, { "type": "null" } ], "title": "Seats" }, "auto_council": { "type": "boolean", "title": "Auto Council", "description": "Compose the council's roles for this task", "default": false }, "auto_models": { "type": "boolean", "title": "Auto Models", "description": "Pick a model for every seat by its role", "default": false }, "model_strategy": { "type": "string", "enum": [ "quality", "balanced", "economy" ], "title": "Model Strategy", "description": "With auto_models: quality, balanced or economy (competence against cost)", "default": "balanced" } }, "type": "object", "required": [ "topic" ], "title": "RunIn" }, "RunOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "council_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Council Id" }, "parent_run_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Parent Run Id" }, "topic": { "type": "string", "title": "Topic" }, "description": { "type": "string", "title": "Description" }, "mode": { "type": "string", "title": "Mode" }, "status": { "type": "string", "title": "Status" }, "outputs": { "items": { "type": "string" }, "type": "array", "title": "Outputs" }, "guardrails": { "additionalProperties": true, "type": "object", "title": "Guardrails" }, "usage": { "additionalProperties": true, "type": "object", "title": "Usage" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "last_seq": { "type": "integer", "title": "Last Seq" }, "created_at": { "type": "string", "format": "date-time", "title": "Created 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" }, "archived_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Archived At" }, "trashed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Trashed At" }, "knowledge_base_ids": { "items": { "type": "string" }, "type": "array", "title": "Knowledge Base Ids" }, "resumed_from_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Resumed From Id" }, "pending_approvals": { "type": "integer", "title": "Pending Approvals", "default": 0 } }, "type": "object", "required": [ "id", "council_id", "parent_run_id", "topic", "description", "mode", "status", "outputs", "guardrails", "usage", "error", "last_seq", "created_at", "started_at", "finished_at" ], "title": "RunOut" }, "SeatIn": { "properties": { "role": { "type": "string", "maxLength": 40, "minLength": 1, "title": "Role" }, "name": { "anyOf": [ { "type": "string", "maxLength": 120 }, { "type": "null" } ], "title": "Name" }, "focus": { "type": "string", "maxLength": 300, "title": "Focus", "default": "" }, "provider": { "type": "string", "maxLength": 64, "minLength": 1, "title": "Provider" }, "model": { "type": "string", "maxLength": 120, "minLength": 1, "title": "Model" } }, "type": "object", "required": [ "role", "provider", "model" ], "title": "SeatIn" }, "SetupOut": { "properties": { "secret": { "type": "string", "title": "Secret" }, "otpauth_uri": { "type": "string", "title": "Otpauth Uri" } }, "type": "object", "required": [ "secret", "otpauth_uri" ], "title": "SetupOut" }, "SkillIn": { "properties": { "skill_md": { "type": "string", "maxLength": 400000, "minLength": 1, "title": "Skill Md" }, "files": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Files" }, "enabled": { "type": "boolean", "title": "Enabled", "default": true } }, "type": "object", "required": [ "skill_md" ], "title": "SkillIn" }, "SkillPatch": { "properties": { "enabled": { "type": "boolean", "title": "Enabled" } }, "type": "object", "required": [ "enabled" ], "title": "SkillPatch" }, "TemplateIn": { "properties": { "name": { "type": "string", "maxLength": 120, "minLength": 1, "title": "Name" }, "summary": { "type": "string", "maxLength": 500, "title": "Summary", "default": "" }, "topic": { "type": "string", "maxLength": 500, "minLength": 1, "title": "Topic" }, "description": { "type": "string", "maxLength": 20000, "title": "Description", "default": "" }, "mode": { "type": "string", "enum": [ "general", "research", "coding", "chat" ], "title": "Mode", "default": "general" }, "council_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Council Id" }, "size": { "anyOf": [ { "type": "integer", "maximum": 64.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Size" }, "provider": { "type": "string", "maxLength": 64, "title": "Provider", "default": "mock" }, "model": { "type": "string", "maxLength": 120, "title": "Model", "default": "mock-1" }, "outputs": { "items": { "type": "string", "enum": [ "txt", "md", "latex", "pdf", "html", "docx", "json" ] }, "type": "array", "maxItems": 7, "title": "Outputs" }, "guardrails": { "additionalProperties": true, "type": "object", "title": "Guardrails" } }, "type": "object", "required": [ "name", "topic" ], "title": "TemplateIn" }, "TemplatePatch": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 120, "minLength": 1 }, { "type": "null" } ], "title": "Name" }, "summary": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Summary" }, "topic": { "anyOf": [ { "type": "string", "maxLength": 500, "minLength": 1 }, { "type": "null" } ], "title": "Topic" }, "description": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ], "title": "Description" }, "mode": { "anyOf": [ { "type": "string", "enum": [ "general", "research", "coding", "chat" ] }, { "type": "null" } ], "title": "Mode" }, "council_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Council Id" }, "size": { "anyOf": [ { "type": "integer", "maximum": 64.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Size" }, "provider": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "Provider" }, "model": { "anyOf": [ { "type": "string", "maxLength": 120 }, { "type": "null" } ], "title": "Model" }, "outputs": { "anyOf": [ { "items": { "type": "string", "enum": [ "txt", "md", "latex", "pdf", "html", "docx", "json" ] }, "type": "array", "maxItems": 7 }, { "type": "null" } ], "title": "Outputs" }, "guardrails": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Guardrails" } }, "type": "object", "title": "TemplatePatch" }, "TemplateRunIn": { "properties": { "variables": { "additionalProperties": { "type": "string" }, "type": "object", "maxProperties": 50, "title": "Variables" } }, "type": "object", "title": "TemplateRunIn" }, "TextDocumentIn": { "properties": { "title": { "type": "string", "maxLength": 300, "minLength": 1, "title": "Title" }, "text": { "type": "string", "maxLength": 1000000, "minLength": 1, "title": "Text" }, "source_url": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ], "title": "Source Url" } }, "type": "object", "required": [ "title", "text" ], "title": "TextDocumentIn" }, "TokenOut": { "properties": { "access_token": { "type": "string", "title": "Access Token" }, "refresh_token": { "type": "string", "title": "Refresh Token" }, "token_type": { "type": "string", "title": "Token Type", "default": "bearer" }, "expires_in": { "type": "integer", "title": "Expires In" } }, "type": "object", "required": [ "access_token", "refresh_token", "expires_in" ], "title": "TokenOut" }, "UrlDocumentIn": { "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "title": "Url" }, "title": { "anyOf": [ { "type": "string", "maxLength": 300 }, { "type": "null" } ], "title": "Title" } }, "type": "object", "required": [ "url" ], "title": "UrlDocumentIn" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "VerifyIn": { "properties": { "code": { "type": "string", "maxLength": 32, "minLength": 6, "title": "Code", "description": "Authenticator code or recovery code" }, "mfa_token": { "type": "string", "maxLength": 4096, "minLength": 1, "title": "Mfa Token" } }, "type": "object", "required": [ "code", "mfa_token" ], "title": "VerifyIn" }, "WebhookIn": { "properties": { "url": { "type": "string", "maxLength": 500, "title": "Url" }, "events": { "items": { "type": "string" }, "type": "array", "maxItems": 20, "minItems": 1, "title": "Events" }, "description": { "type": "string", "maxLength": 200, "title": "Description", "default": "" }, "enabled": { "type": "boolean", "title": "Enabled", "default": true } }, "type": "object", "required": [ "url", "events" ], "title": "WebhookIn" }, "WebhookPatch": { "properties": { "url": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Url" }, "events": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 20, "minItems": 1 }, { "type": "null" } ], "title": "Events" }, "description": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "title": "Description" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" } }, "type": "object", "title": "WebhookPatch" } }, "securitySchemes": { "HTTPBearer": { "type": "http", "scheme": "bearer" } } } }