{ "components": { "schemas": { "ActiveSubtasksResponse": { "description": "Response for `GET .../sessions/{session_id}/subtasks/active` (#3124).", "properties": { "count": { "title": "Count", "type": "integer" }, "subtasks": { "items": { "$ref": "#/components/schemas/SubtaskSummary" }, "title": "Subtasks", "type": "array" } }, "required": [ "subtasks", "count" ], "title": "ActiveSubtasksResponse", "type": "object" }, "AdminMailHealRequest": { "description": "Body for ``POST /admin/mail/heal``.\n\n``service`` selects which mailbox kind to reconcile: ``internal`` (the\ndefault, for backward compatibility with the existing Internal-tab button)\nprovisions an internal mailbox for every agent that lacks one; ``external``\nconverges external mailboxes onto the tenant + per-agent enablement flags\n(see docs/content/mail.md \"External mailbox enablement\").", "properties": { "service": { "enum": [ "internal", "external" ], "title": "Service", "type": "string" } }, "title": "AdminMailHealRequest", "type": "object" }, "AdminMailHealResult": { "description": "Result of a mailbox heal (backfill) run.", "properties": { "provisioned": { "title": "Provisioned", "type": "integer" }, "provisioning_enabled": { "default": true, "title": "Provisioning Enabled", "type": "boolean" } }, "required": [ "provisioned" ], "title": "AdminMailHealResult", "type": "object" }, "AdminMailboxRow": { "description": "One mailbox row in the SuperAdmin cluster-wide roster.\n\n`is_paused` is the documented field name in `docs/content/mail.md`. The\nunderlying column today is `mailbox.is_active` (default true); the read\nsurface inverts it so paused == not active. Pause/resume mutation\nendpoints have their own tracking issue.", "properties": { "address": { "title": "Address", "type": "string" }, "agent_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agent Name" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "is_paused": { "title": "Is Paused", "type": "boolean" }, "last_message_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Last Message At" }, "message_count": { "title": "Message Count", "type": "integer" }, "tenant_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Tenant Id", "type": "string" }, "tenant_name": { "title": "Tenant Name", "type": "string" } }, "required": [ "id", "address", "tenant_id", "tenant_name", "agent_name", "message_count", "last_message_at", "is_paused" ], "title": "AdminMailboxRow", "type": "object" }, "AdminModelUpdate": { "description": "SuperAdmin-only patch: allows setting `is_free`, `failover_chain`, and\n`available_to_all_tenants` (the \"available to every tenant\" switch).", "properties": { "available_to_all_tenants": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Available To All Tenants" }, "config": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Config" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "failover_chain": { "anyOf": [ { "items": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Failover Chain" }, "is_free": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Free" }, "name": { "anyOf": [ { "maxLength": 128, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Name" }, "pricing": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Pricing" }, "status": { "anyOf": [ { "enum": [ "active", "disabled", "experimental", "deprecated" ], "type": "string" }, { "type": "null" } ], "title": "Status" } }, "title": "AdminModelUpdate", "type": "object" }, "AdminTenantDetailRead": { "description": "Full per-tenant detail for SuperAdmin: includes plan, 30-day aggregates.", "properties": { "abandoned_warning_sent_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Abandoned Warning Sent At" }, "agent_count": { "title": "Agent Count", "type": "integer" }, "allow_superadmin_access": { "default": true, "title": "Allow Superadmin Access", "type": "boolean" }, "billing_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Billing Email" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "default_skill_visibility_scope": { "enum": [ "private_only", "tenant_allowed" ], "title": "Default Skill Visibility Scope", "type": "string" }, "external_mail_enabled": { "default": false, "title": "External Mail Enabled", "type": "boolean" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "is_suspended": { "default": false, "title": "Is Suspended", "type": "boolean" }, "last_active_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Last Active At" }, "member_count": { "title": "Member Count", "type": "integer" }, "name": { "title": "Name", "type": "string" }, "paid": { "default": false, "title": "Paid", "type": "boolean" }, "plan": { "$ref": "#/components/schemas/PlanRead" }, "plan_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Plan Id", "type": "string" }, "plan_status": { "enum": [ "trialing", "active", "past_due", "canceled" ], "title": "Plan Status", "type": "string" }, "slug": { "title": "Slug", "type": "string" }, "status": { "$ref": "#/components/schemas/TenantStatus", "default": "active" }, "task_summary_30d": { "$ref": "#/components/schemas/TaskSummary30d" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "usage_summary_30d": { "$ref": "#/components/schemas/UsageSummary30d" }, "voicebox_enabled": { "default": false, "title": "Voicebox Enabled", "type": "boolean" } }, "required": [ "id", "name", "slug", "plan_id", "billing_email", "created_at", "updated_at", "member_count", "agent_count", "plan", "plan_status", "usage_summary_30d", "task_summary_30d", "last_active_at" ], "title": "AdminTenantDetailRead", "type": "object" }, "AdminTenantRead": { "description": "TenantRead with computed counts for the super-admin listing.", "properties": { "abandoned_warning_sent_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Abandoned Warning Sent At" }, "agent_count": { "title": "Agent Count", "type": "integer" }, "allow_superadmin_access": { "default": true, "title": "Allow Superadmin Access", "type": "boolean" }, "billing_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Billing Email" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "default_skill_visibility_scope": { "enum": [ "private_only", "tenant_allowed" ], "title": "Default Skill Visibility Scope", "type": "string" }, "external_mail_enabled": { "default": false, "title": "External Mail Enabled", "type": "boolean" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "is_suspended": { "default": false, "title": "Is Suspended", "type": "boolean" }, "member_count": { "title": "Member Count", "type": "integer" }, "name": { "title": "Name", "type": "string" }, "paid": { "default": false, "title": "Paid", "type": "boolean" }, "plan_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Plan Id", "type": "string" }, "slug": { "title": "Slug", "type": "string" }, "status": { "$ref": "#/components/schemas/TenantStatus", "default": "active" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "voicebox_enabled": { "default": false, "title": "Voicebox Enabled", "type": "boolean" } }, "required": [ "id", "name", "slug", "plan_id", "billing_email", "created_at", "updated_at", "member_count", "agent_count" ], "title": "AdminTenantRead", "type": "object" }, "AdminUserPrimaryTenant": { "description": "Lightweight tenant reference for the SuperAdmin users listing.", "properties": { "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "role": { "title": "Role", "type": "string" } }, "required": [ "id", "name", "role" ], "title": "AdminUserPrimaryTenant", "type": "object" }, "AdminUserRow": { "description": "One row in the SuperAdmin \"Users\" listing (``GET /api/v1/admin/users``).", "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "email": { "title": "Email", "type": "string" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "is_super_admin": { "title": "Is Super Admin", "type": "boolean" }, "is_suspended": { "title": "Is Suspended", "type": "boolean" }, "last_login_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Last Login At" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "primary_tenant": { "anyOf": [ { "$ref": "#/components/schemas/AdminUserPrimaryTenant" }, { "type": "null" } ] }, "tenant_count": { "title": "Tenant Count", "type": "integer" } }, "required": [ "id", "email", "name", "is_super_admin", "is_suspended", "tenant_count", "primary_tenant", "created_at", "last_login_at" ], "title": "AdminUserRow", "type": "object" }, "AgentAttachmentRow": { "description": "Attachment metadata returned by the list/get endpoints.", "properties": { "content_type": { "title": "Content Type", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "filename": { "title": "Filename", "type": "string" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "message_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Message Id", "type": "string" }, "size_bytes": { "title": "Size Bytes", "type": "integer" } }, "required": [ "id", "message_id", "filename", "content_type", "size_bytes", "created_at" ], "title": "AgentAttachmentRow", "type": "object" }, "AgentAvatarRead": { "properties": { "agent_id": { "title": "Agent Id", "type": "string" }, "avatar_sha256": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "sha256 of the stored 192x192 PNG; cache-busting token.", "title": "Avatar Sha256" }, "avatar_size_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Avatar Size Bytes" }, "avatar_updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Avatar Updated At" }, "gitlab_synced": { "description": "Whether the agent's GitLab user shows this avatar. False after a failed or pending push (retried by the tenant reconcile) and after removal, which leaves the last-synced GitLab avatar in place.", "title": "Gitlab Synced", "type": "boolean" }, "has_avatar": { "title": "Has Avatar", "type": "boolean" } }, "required": [ "agent_id", "has_avatar", "gitlab_synced" ], "title": "AgentAvatarRead", "type": "object" }, "AgentBudgetRead": { "properties": { "hourly_limit_usd": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Hourly Limit Usd" } }, "required": [ "hourly_limit_usd" ], "title": "AgentBudgetRead", "type": "object" }, "AgentBudgetUpdate": { "properties": { "hourly_limit_usd": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "type": "null" } ], "title": "Hourly Limit Usd" } }, "title": "AgentBudgetUpdate", "type": "object" }, "AgentCanAuthorSkillsUpdate": { "description": "Toggle the agent-level ``can_author_skills`` flag.\n\nField name matches the underlying column (``agent.can_author_skills``)\nand the read-side schema (``AgentRead.can_author_skills``), so operators\nnever see a second name for the same boolean.", "properties": { "can_author_skills": { "title": "Can Author Skills", "type": "boolean" } }, "required": [ "can_author_skills" ], "title": "AgentCanAuthorSkillsUpdate", "type": "object" }, "AgentCatalogModel": { "description": "One tenant-reachable chat model, annotated with the agent's grant.", "properties": { "access": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Effective access of the direct grant: full | read_only.", "title": "Access" }, "callable": { "description": "Reconciled truth of the broker invoke gate (``check_model_access``) for this agent driven by the viewing user. Pickers gate selection on this.", "title": "Callable", "type": "boolean" }, "callable_via_router": { "description": "OpenRouter model callable through the agent's Auto Router grant (#3095).", "title": "Callable Via Router", "type": "boolean" }, "completion_price_usd_per_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Completion Price Usd Per Token" }, "context_window": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Context Window" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "enabled": { "description": "A direct ``agent_model`` grant exists (the toggle).", "title": "Enabled", "type": "boolean" }, "is_free": { "title": "Is Free", "type": "boolean" }, "kind": { "description": "Model kind: openrouter, ifm, local, anthropic, bedrock, \u2026", "title": "Kind", "type": "string" }, "model_id": { "title": "Model Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "priority": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Position of the direct grant in the agent's chain.", "title": "Priority" }, "prompt_price_usd_per_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prompt Price Usd Per Token" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Provider slug (``openrouter_slug`` / ``model_slug``).", "title": "Slug" }, "status": { "description": "Global model status (active or experimental).", "title": "Status", "type": "string" }, "supports_tools": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Supports Tools" }, "supports_vision": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Supports Vision" }, "uncallable_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Uncallable Reason" }, "user_granted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Non-OpenRouter kinds only: whether the *viewing* user holds the ``user_model`` grant the broker requires when a user drives the agent. ``null`` when the layer doesn't apply.", "title": "User Granted" } }, "required": [ "model_id", "name", "kind", "status", "is_free", "enabled", "callable_via_router", "callable" ], "title": "AgentCatalogModel", "type": "object" }, "AgentCatalogToggle": { "properties": { "agent_id": { "title": "Agent Id", "type": "string" }, "enabled": { "title": "Enabled", "type": "boolean" }, "model_id": { "title": "Model Id", "type": "string" } }, "required": [ "model_id", "agent_id", "enabled" ], "title": "AgentCatalogToggle", "type": "object" }, "AgentClone": { "description": "Request body for ``POST /agents/{source_id}/clone``.", "properties": { "name": { "maxLength": 255, "minLength": 1, "pattern": "^[A-Za-z0-9 -]+$", "title": "Name", "type": "string" } }, "required": [ "name" ], "title": "AgentClone", "type": "object" }, "AgentCodeRefUpdate": { "description": "PATCH body for pinning ``agent.code_ref``.\n\nThe value is validated server-side against the project's real branch +\ntag set; an unknown ref returns 422. Length matches the DB column\n(``agent.code_ref VARCHAR(128)``).", "properties": { "code_ref": { "maxLength": 128, "minLength": 1, "title": "Code Ref", "type": "string" } }, "required": [ "code_ref" ], "title": "AgentCodeRefUpdate", "type": "object" }, "AgentCostRow": { "description": "One row in the per-agent cost breakdown table.", "properties": { "agent_id": { "title": "Agent Id", "type": "string" }, "agent_name": { "title": "Agent Name", "type": "string" }, "anomaly": { "default": false, "title": "Anomaly", "type": "boolean" }, "byok_cost_usd": { "default": 0.0, "title": "Byok Cost Usd", "type": "number" }, "cache_hit_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cache Hit Rate" }, "cache_read_tokens": { "default": 0, "title": "Cache Read Tokens", "type": "integer" }, "cache_write_tokens": { "default": 0, "title": "Cache Write Tokens", "type": "integer" }, "cost_usd": { "title": "Cost Usd", "type": "number" }, "input_tokens": { "title": "Input Tokens", "type": "integer" }, "models": { "default": [], "items": { "$ref": "#/components/schemas/AgentModelCostRow" }, "title": "Models", "type": "array" }, "output_tokens": { "title": "Output Tokens", "type": "integer" }, "provider_cost_usd": { "default": 0.0, "title": "Provider Cost Usd", "type": "number" }, "requests": { "title": "Requests", "type": "integer" }, "top_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Top Model" } }, "required": [ "agent_id", "agent_name", "requests", "input_tokens", "output_tokens", "cost_usd" ], "title": "AgentCostRow", "type": "object" }, "AgentCostsResponse": { "description": "Full response for ``GET /tenant/{tenant_id}/billing/agent-costs``.", "properties": { "agents": { "items": { "$ref": "#/components/schemas/AgentCostRow" }, "title": "Agents", "type": "array" }, "period": { "$ref": "#/components/schemas/CostPeriod" }, "total_byok_cost_usd": { "default": 0.0, "title": "Total Byok Cost Usd", "type": "number" }, "total_cost_usd": { "title": "Total Cost Usd", "type": "number" }, "total_provider_cost_usd": { "default": 0.0, "title": "Total Provider Cost Usd", "type": "number" } }, "required": [ "period", "agents", "total_cost_usd" ], "title": "AgentCostsResponse", "type": "object" }, "AgentCreate": { "properties": { "can_author_skills": { "default": false, "title": "Can Author Skills", "type": "boolean" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "description_prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description Prompt" }, "environment_mode": { "enum": [ "shared", "isolated" ], "title": "Environment Mode", "type": "string" }, "hidden": { "default": false, "title": "Hidden", "type": "boolean" }, "image_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image Ref" }, "initial_greeting": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Initial Greeting" }, "is_admin_only": { "default": false, "title": "Is Admin Only", "type": "boolean" }, "iteration_warn_threshold": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Iteration Warn Threshold" }, "kind": { "enum": [ "user", "coding", "analyst", "dba", "schroeder" ], "title": "Kind", "type": "string" }, "name": { "maxLength": 255, "minLength": 1, "pattern": "^[A-Za-z0-9 -]+$", "title": "Name", "type": "string" }, "resource_class": { "default": "small", "title": "Resource Class", "type": "string" }, "slug": { "maxLength": 64, "minLength": 1, "pattern": "^[a-z0-9][a-z0-9-]{0,63}$", "title": "Slug", "type": "string" }, "voice": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "title": "Voice" } }, "required": [ "name", "slug" ], "title": "AgentCreate", "type": "object" }, "AgentDefaultRoleRead": { "description": "Whether the per-agent tenant defaults (``AGENT_DEFAULT`` + ``AGENT_DEFAULT_GUEST``)\nare enabled.\n\n``enabled`` True means every tenant MEMBER reaches this agent's member baseline via\nmatcher branch 5 and every tenant GUEST reaches the narrower GUEST baseline via branch\n6 (the two edges are toggled together, #479); False means the agent is *tightened* \u2014\nonly named per-agent roles (or OWNER/ADMIN/SuperAdmin) reach it (issue #476).", "properties": { "agent_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Agent Id", "type": "string" }, "enabled": { "title": "Enabled", "type": "boolean" } }, "required": [ "agent_id", "enabled" ], "title": "AgentDefaultRoleRead", "type": "object" }, "AgentDefaultRoleUpdate": { "description": "Enable or tighten the per-agent tenant default on an agent.", "properties": { "enabled": { "title": "Enabled", "type": "boolean" } }, "required": [ "enabled" ], "title": "AgentDefaultRoleUpdate", "type": "object" }, "AgentFavoriteRead": { "properties": { "agent_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Agent Id", "type": "string" }, "user_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "User Id", "type": "string" } }, "required": [ "user_id", "agent_id" ], "title": "AgentFavoriteRead", "type": "object" }, "AgentGrantRequest": { "properties": { "agent_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Agent Id", "type": "string" }, "role": { "anyOf": [ { "enum": [ "VIEWER", "EDITOR" ], "type": "string" }, { "type": "null" } ], "title": "Role" }, "user_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "User Id", "type": "string" } }, "required": [ "user_id", "agent_id" ], "title": "AgentGrantRequest", "type": "object" }, "AgentImageRepoRead": { "description": "Result of scaffolding an agent's custom-image GitLab repo (GitLab #49).\n\nThe repo lives at ``good-place/tenants//agent-images/``\n(the 4th per-tenant subgroup, decision #9) and is seeded with a deps-only\n``Dockerfile`` extending the platform base image, plus ``requirements.txt``,\n``.dockerignore``, and a build+push ``.gitlab-ci.yml``. ``repo_url`` is the\nHTTP clone URL; the tenant admin fills in the deps and the pipeline pushes\nthe built image to the tenant's own GCR namespace.", "properties": { "agent_id": { "title": "Agent Id", "type": "string" }, "agent_slug": { "title": "Agent Slug", "type": "string" }, "repo_url": { "title": "Repo Url", "type": "string" } }, "required": [ "agent_id", "agent_slug", "repo_url" ], "title": "AgentImageRepoRead", "type": "object" }, "AgentImportFromGcsRequest": { "description": "JSON body for the service-to-service import path.\n\n``gcs_uri`` must point inside the calling tenant's own workspace bucket;\nthe route enforces that, so this path can't be used to pull bytes from\nelsewhere in GCS (same rule the memory import applies).", "properties": { "gcs_uri": { "maxLength": 2048, "minLength": 1, "title": "Gcs Uri", "type": "string" }, "name": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "description": "Override the agent name from the bundle's manifest.", "title": "Name" } }, "required": [ "gcs_uri" ], "title": "AgentImportFromGcsRequest", "type": "object" }, "AgentImportResult": { "description": "What an import actually produced.\n\nDeliberately reports observed counts rather than a bare success flag: an\nimport is all-or-nothing up to the point the agent exists and best-effort\nper row after that, so the operator needs to see what landed. ``warnings``\nis the list to surface in the UI \u2014 a model that fell back to the tenant\ndefault, tools this deployment doesn't have, budget caps that didn't carry\nover.", "properties": { "agent_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Agent Id", "type": "string" }, "agent_name": { "title": "Agent Name", "type": "string" }, "agent_slug": { "title": "Agent Slug", "type": "string" }, "idempotent_reuse": { "default": false, "description": "True when this call resolved to an agent a previous import already created (a retry, e.g. after a gateway 502): no new agent was made and the per-row counts are zero. The UI should treat this as success and show the existing agent, not an error.", "title": "Idempotent Reuse", "type": "boolean" }, "memories_failed": { "default": 0, "title": "Memories Failed", "type": "integer" }, "memories_imported": { "default": 0, "title": "Memories Imported", "type": "integer" }, "messages_imported": { "default": 0, "title": "Messages Imported", "type": "integer" }, "model_fallback_used": { "default": false, "description": "True when no exported slug was available and the tenant default was used.", "title": "Model Fallback Used", "type": "boolean" }, "model_slug_requested": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The model slug recorded in the bundle.", "title": "Model Slug Requested" }, "model_slug_resolved": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The slug actually matched here; null when the fallback was used.", "title": "Model Slug Resolved" }, "model_warning": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Warning" }, "sessions_imported": { "default": 0, "title": "Sessions Imported", "type": "integer" }, "skills_failed": { "default": 0, "title": "Skills Failed", "type": "integer" }, "skills_imported": { "default": 0, "title": "Skills Imported", "type": "integer" }, "source_platform": { "description": "Platform the bundle was exported from, per its manifest.", "title": "Source Platform", "type": "string" }, "tools_attached": { "items": { "type": "string" }, "title": "Tools Attached", "type": "array" }, "tools_unmatched": { "items": { "type": "string" }, "title": "Tools Unmatched", "type": "array" }, "warnings": { "items": { "type": "string" }, "title": "Warnings", "type": "array" } }, "required": [ "agent_id", "agent_slug", "agent_name", "source_platform" ], "title": "AgentImportResult", "type": "object" }, "AgentIntegrationRead": { "description": "Public projection of a per-agent integration.", "properties": { "connected": { "title": "Connected", "type": "boolean" }, "label": { "title": "Label", "type": "string" }, "provider": { "title": "Provider", "type": "string" } }, "required": [ "provider", "label", "connected" ], "title": "AgentIntegrationRead", "type": "object" }, "AgentListRead": { "properties": { "can_author_skills": { "title": "Can Author Skills", "type": "boolean" }, "code_ref": { "title": "Code Ref", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "created_by_agent_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Created By Agent Id" }, "created_by_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Created By Id" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "editor_enabled": { "default": false, "title": "Editor Enabled", "type": "boolean" }, "hidden": { "default": false, "title": "Hidden", "type": "boolean" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "image_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image Ref" }, "initial_greeting": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Initial Greeting" }, "is_active": { "title": "Is Active", "type": "boolean" }, "is_admin_only": { "title": "Is Admin Only", "type": "boolean" }, "is_favorite": { "default": false, "title": "Is Favorite", "type": "boolean" }, "is_seed": { "title": "Is Seed", "type": "boolean" }, "name": { "title": "Name", "type": "string" }, "plan_read_only": { "default": false, "title": "Plan Read Only", "type": "boolean" }, "repo_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Repo Url" }, "resource_class": { "title": "Resource Class", "type": "string" }, "slug": { "title": "Slug", "type": "string" }, "tenant_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Tenant Id", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "voice": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Voice" }, "zoom_managed": { "default": false, "title": "Zoom Managed", "type": "boolean" } }, "required": [ "id", "tenant_id", "name", "slug", "description", "initial_greeting", "is_active", "is_admin_only", "is_seed", "can_author_skills", "image_ref", "resource_class", "repo_url", "code_ref", "created_at", "updated_at" ], "title": "AgentListRead", "type": "object" }, "AgentMailboxRow": { "description": "One mailbox belonging to an agent.", "properties": { "address": { "title": "Address", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "is_active": { "title": "Is Active", "type": "boolean" }, "kind": { "enum": [ "internal", "external" ], "title": "Kind", "type": "string" } }, "required": [ "id", "address", "kind", "is_active", "created_at" ], "title": "AgentMailboxRow", "type": "object" }, "AgentModelChainUpdate": { "description": "PUT body for setting the ordered model chain on an agent (#614).\n\n``model_ids`` is the ordered list of model CUIDs. The first element is\npriority 0 (primary), the second priority 1, etc. Minimum 1, maximum\n``MAX_AGENT_MODEL_CHAIN_LEN``.", "properties": { "model_ids": { "items": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, "maxItems": 5, "minItems": 1, "title": "Model Ids", "type": "array" } }, "required": [ "model_ids" ], "title": "AgentModelChainUpdate", "type": "object" }, "AgentModelCostRow": { "description": "One model an agent's spend went to (issue #347).", "properties": { "cache_read_tokens": { "default": 0, "title": "Cache Read Tokens", "type": "integer" }, "cache_write_tokens": { "default": 0, "title": "Cache Write Tokens", "type": "integer" }, "cost_usd": { "title": "Cost Usd", "type": "number" }, "input_tokens": { "title": "Input Tokens", "type": "integer" }, "model_id": { "title": "Model Id", "type": "string" }, "output_tokens": { "title": "Output Tokens", "type": "integer" }, "requests": { "title": "Requests", "type": "integer" } }, "required": [ "model_id", "requests", "input_tokens", "output_tokens", "cost_usd" ], "title": "AgentModelCostRow", "type": "object" }, "AgentModelGrant": { "properties": { "access": { "enum": [ "full", "read_only" ], "title": "Access", "type": "string" }, "agent_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Agent Id", "type": "string" }, "priority": { "default": 0, "maximum": 4.0, "minimum": 0.0, "title": "Priority", "type": "integer" } }, "required": [ "agent_id" ], "title": "AgentModelGrant", "type": "object" }, "AgentModelRead": { "properties": { "access": { "title": "Access", "type": "string" }, "agent_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Agent Id", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "model_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Model Id", "type": "string" }, "priority": { "default": 0, "title": "Priority", "type": "integer" } }, "required": [ "agent_id", "model_id", "access", "created_at" ], "title": "AgentModelRead", "type": "object" }, "AgentOwnershipTransfer": { "properties": { "new_owner_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "New Owner Id", "type": "string" } }, "required": [ "new_owner_id" ], "title": "AgentOwnershipTransfer", "type": "object" }, "AgentPromptCommitRead": { "description": "One commit that touched a prompt file, as GitLab reports it.\n\nMetadata only \u2014 no diff and no file body. ``author_name`` / ``author_email``\nare real identities because agents commit as their own Keycloak user\n(decision #39), which is what makes this history worth reading.\n\n``web_url`` is GitLab's own link to the commit and is therefore off-origin:\nthe UI must render it through ````.", "properties": { "author_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author Email" }, "author_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author Name" }, "committed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Committed At" }, "id": { "title": "Id", "type": "string" }, "short_id": { "title": "Short Id", "type": "string" }, "title": { "title": "Title", "type": "string" }, "web_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Web Url" } }, "required": [ "id", "short_id", "title" ], "title": "AgentPromptCommitRead", "type": "object" }, "AgentPromptFileProvenanceRead": { "description": "Repo state for one prompt file and the live column it projects onto.\n\n``diverged`` is the \"this differs from the repository\" signal: the live\ncolumn is not equal to the projection of the file currently on ``main``,\ni.e. somebody has overridden the prompt through the API or the panel and the\nconvergence sweep will never take it back. It is ``False`` when the file\ncould not be read at all \u2014 absence of evidence, and the enclosing\n``available`` flag says so.\n\n``pending_projection`` is the other not-equal case, and it is *not* an\noverride: the live column is still unprojected (empty, or the pre-#291 seed\ninput), so the convergence sweep will replace it with this file on its next\npass. The two are never both ``True``. It is a boolean for the same reason\n``diverged`` is \u2014 the comparison against the seed happens server-side. (When\nit is ``True`` on a non-empty column, the live value *is* the seed input, so\nan admin who can already read the live prompt learns nothing new that arms\nanything: in that state the reconciler is armed already, which is the point\nof the flag.)", "properties": { "commits": { "items": { "$ref": "#/components/schemas/AgentPromptCommitRead" }, "title": "Commits", "type": "array" }, "diverged": { "title": "Diverged", "type": "boolean" }, "field": { "title": "Field", "type": "string" }, "file": { "title": "File", "type": "string" }, "pending_projection": { "default": false, "title": "Pending Projection", "type": "boolean" }, "repo_present": { "title": "Repo Present", "type": "boolean" } }, "required": [ "file", "field", "repo_present", "diverged", "commits" ], "title": "AgentPromptFileProvenanceRead", "type": "object" }, "AgentPromptProvenanceRead": { "description": "Provenance for both prompt files, or an honest \"GitLab didn't answer\".\n\n``available=False`` is a **200**, not a 5xx: a GitLab outage must degrade the\nsettings panel to \"history unavailable\" rather than break the page.\n``unavailable_reason`` is operator-facing copy, not an exception string.", "properties": { "available": { "title": "Available", "type": "boolean" }, "files": { "items": { "$ref": "#/components/schemas/AgentPromptFileProvenanceRead" }, "title": "Files", "type": "array" }, "repo_web_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Repo Web Url" }, "unavailable_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unavailable Reason" } }, "required": [ "available", "files" ], "title": "AgentPromptProvenanceRead", "type": "object" }, "AgentRead": { "properties": { "avatar_sha256": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avatar Sha256" }, "bootstrap_instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bootstrap Instructions" }, "can_author_skills": { "title": "Can Author Skills", "type": "boolean" }, "code_ref": { "title": "Code Ref", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "created_by_agent_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Created By Agent Id" }, "created_by_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Created By Id" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "description_prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description Prompt" }, "editor_enabled": { "default": false, "title": "Editor Enabled", "type": "boolean" }, "environment_mode": { "enum": [ "shared", "isolated" ], "title": "Environment Mode", "type": "string" }, "external_mail_enabled": { "default": true, "title": "External Mail Enabled", "type": "boolean" }, "hidden": { "default": false, "title": "Hidden", "type": "boolean" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "image_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image Ref" }, "initial_greeting": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Initial Greeting" }, "is_active": { "title": "Is Active", "type": "boolean" }, "is_admin_only": { "title": "Is Admin Only", "type": "boolean" }, "is_seed": { "title": "Is Seed", "type": "boolean" }, "iteration_warn_threshold": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Iteration Warn Threshold" }, "name": { "title": "Name", "type": "string" }, "plan_read_only": { "default": false, "title": "Plan Read Only", "type": "boolean" }, "repo_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Repo Url" }, "resource_class": { "title": "Resource Class", "type": "string" }, "skill_visibility_scope": { "enum": [ "private_only", "tenant_allowed" ], "title": "Skill Visibility Scope", "type": "string" }, "slug": { "title": "Slug", "type": "string" }, "ssh_public_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ssh Public Key" }, "tenant_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Tenant Id", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "voice": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Voice" }, "zoom_managed": { "default": false, "title": "Zoom Managed", "type": "boolean" } }, "required": [ "id", "tenant_id", "name", "slug", "description", "initial_greeting", "is_active", "is_admin_only", "is_seed", "can_author_skills", "image_ref", "resource_class", "repo_url", "code_ref", "created_at", "updated_at" ], "title": "AgentRead", "type": "object" }, "AgentRepoRefs": { "description": "Branches + tags on the agent's GitLab project.\n\nFeeds the code-tab ``code_ref`` typeahead so the operator can only pin\n``agent.code_ref`` to a ref that actually exists. See issue #1835.\n\nBoth lists may be empty when GitLab is unreachable or the project is\nmissing \u2014 the front-end falls back to a free-form input with a clear\n\"couldn't load refs\" banner in that case.\n\n``complete`` is ``True`` only when both branch and tag listings finished\nwithout error and without hitting their hard-cap walk. When ``False``,\nthe cached set is partial; the front-end treats it as \"refs unavailable\"\nfor typeahead-strict purposes, and the PATCH ``code_ref`` route falls\nback to a direct single-ref GitLab lookup rather than 422-rejecting a\nvalid ref that was simply truncated.", "properties": { "branches": { "items": { "type": "string" }, "title": "Branches", "type": "array" }, "complete": { "default": false, "title": "Complete", "type": "boolean" }, "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" } }, "required": [ "branches", "tags" ], "title": "AgentRepoRefs", "type": "object" }, "AgentRoleAssignmentCreate": { "description": "Set a user's role for a specific agent.", "properties": { "role": { "enum": [ "VIEWER", "MANAGER", "OWNER" ], "title": "Role", "type": "string" } }, "required": [ "role" ], "title": "AgentRoleAssignmentCreate", "type": "object" }, "AgentRoleAssignmentRead": { "description": "Response for a role assignment.", "properties": { "agent_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Agent Id", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "role": { "enum": [ "VIEWER", "MANAGER", "OWNER" ], "title": "Role", "type": "string" }, "tenant_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Tenant Id", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "user_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Email" }, "user_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "User Id", "type": "string" }, "user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Name" } }, "required": [ "agent_id", "user_id", "tenant_id", "role", "created_at", "updated_at" ], "title": "AgentRoleAssignmentRead", "type": "object" }, "AgentRoleGroupGrantCreate": { "description": "Grant a tenant group a per-agent role (VIEWER/MANAGER/OWNER).\n\n``role`` is an ``AgentRole`` only \u2014 a tenant role (OWNER/ADMIN/MEMBER/GUEST) is\nnot group-grantable (owner decision), so anything else 422s here.", "properties": { "role": { "enum": [ "VIEWER", "MANAGER", "OWNER" ], "title": "Role", "type": "string" } }, "required": [ "role" ], "title": "AgentRoleGroupGrantCreate", "type": "object" }, "AgentRoleGroupGrantRead": { "description": "Response for a group's per-agent role grant.", "properties": { "agent_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Agent Id", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "group_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Group Id", "type": "string" }, "group_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Group Name" }, "role": { "enum": [ "VIEWER", "MANAGER", "OWNER" ], "title": "Role", "type": "string" }, "tenant_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Tenant Id", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "agent_id", "group_id", "tenant_id", "role", "created_at", "updated_at" ], "title": "AgentRoleGroupGrantRead", "type": "object" }, "AgentRolePermissionGrid": { "description": "The full permissions grid for the frontend.", "properties": { "roles": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "default": { "MANAGER": [ "View", "Chat (read-only)", "Assign work", "Edit settings", "Edit skills", "Edit tools" ], "OWNER": [ "View", "Chat (read-only)", "Assign work", "Edit settings", "Edit skills", "Edit tools", "Transfer ownership", "Delete agent", "Manage roles" ], "VIEWER": [ "View", "Chat (read-only)" ] }, "title": "Roles", "type": "object" } }, "title": "AgentRolePermissionGrid", "type": "object" }, "AgentSkillConfigRead": { "description": "Decrypted config readback. Issued under the same write RBAC gate\n(``agent:skills:write``) since the blob may contain sensitive settings.", "properties": { "agent_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Agent Id", "type": "string" }, "config": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Config" }, "skill_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Skill Id", "type": "string" } }, "required": [ "agent_id", "skill_id" ], "title": "AgentSkillConfigRead", "type": "object" }, "AgentSkillConfigUpdate": { "description": "PATCH body for ``/skills/{skill_id}/config`` \u2014 replaces the whole blob.\n\nA ``None`` (or absent) ``config`` clears the column. Any JSON-serialisable\ndict is accepted; the route encrypts before writing.", "properties": { "config": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Config" } }, "title": "AgentSkillConfigUpdate", "type": "object" }, "AgentSkillGrant": { "properties": { "is_enabled": { "default": true, "title": "Is Enabled", "type": "boolean" }, "skill_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Skill Id", "type": "string" } }, "required": [ "skill_id" ], "title": "AgentSkillGrant", "type": "object" }, "AgentSkillPermissionEntry": { "description": "One skill+action permission row.\n\n``action`` is ``\"use\"`` \u2014 the only currently supported per-skill action.\n``create`` would be semantically incoherent on a row keyed by\n``skill_id``, so authoring stays gated on ``agent.can_author_skills``.", "properties": { "action": { "default": "use", "title": "Action", "type": "string" }, "allowed": { "default": true, "title": "Allowed", "type": "boolean" }, "skill_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Skill Id", "type": "string" } }, "required": [ "skill_id" ], "title": "AgentSkillPermissionEntry", "type": "object" }, "AgentSkillPermissionRead": { "properties": { "action": { "title": "Action", "type": "string" }, "agent_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Agent Id", "type": "string" }, "allowed": { "title": "Allowed", "type": "boolean" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "skill_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Skill Id", "type": "string" } }, "required": [ "agent_id", "skill_id", "action", "allowed", "created_at" ], "title": "AgentSkillPermissionRead", "type": "object" }, "AgentSkillPermissionUpdate": { "description": "Bulk-replace the skill permission allowlist for an agent.\n\nThe ``permissions`` list is a complete replacement: any existing rows not\nin the list are removed. This keeps the API surface simple and avoids\npartial-update ambiguity.", "properties": { "permissions": { "items": { "$ref": "#/components/schemas/AgentSkillPermissionEntry" }, "title": "Permissions", "type": "array" } }, "required": [ "permissions" ], "title": "AgentSkillPermissionUpdate", "type": "object" }, "AgentSkillRead": { "properties": { "agent_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Agent Id", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "has_config": { "default": false, "title": "Has Config", "type": "boolean" }, "is_enabled": { "title": "Is Enabled", "type": "boolean" }, "skill_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Skill Id", "type": "string" } }, "required": [ "agent_id", "skill_id", "is_enabled", "created_at" ], "title": "AgentSkillRead", "type": "object" }, "AgentSkillVisibilityScopeUpdate": { "description": "PUT body for ``/tenant/{id}/agents/{id}/skill-visibility-scope``.\n\n``private_only`` \u2014 agent may only author ``visibility='private'`` skills.\n``tenant_allowed`` \u2014 agent may also author ``visibility='public'`` skills.\nSee issue #550 and SkillVisibilityScope in models/agent.py.", "properties": { "skill_visibility_scope": { "enum": [ "private_only", "tenant_allowed" ], "title": "Skill Visibility Scope", "type": "string" } }, "required": [ "skill_visibility_scope" ], "title": "AgentSkillVisibilityScopeUpdate", "type": "object" }, "AgentSlackConfigRead": { "properties": { "slack_rph_limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Slack Rph Limit" }, "slack_rpm_limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Slack Rpm Limit" }, "working_hours_days": { "anyOf": [ { "items": { "enum": [ "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun" ], "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Working Hours Days" }, "working_hours_enabled": { "default": false, "title": "Working Hours Enabled", "type": "boolean" }, "working_hours_end": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Working Hours End" }, "working_hours_start": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Working Hours Start" }, "working_hours_tz": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Working Hours Tz" } }, "title": "AgentSlackConfigRead", "type": "object" }, "AgentSlackConfigUpdate": { "description": "Partial update body for `PUT /slack-config`.\n\nFields are forwarded only when the client included them in the request\nbody (see the route handler's use of ``model_fields_set``). Sending a\nfield as ``null`` clears the corresponding column; omitting a field\nleaves the column untouched. ``working_hours_days`` is constrained to\n3-letter English weekday codes (Mon\u2013Sun); ``working_hours_end`` must be\nstrictly after ``working_hours_start`` because the schedule gate does\nnot support overnight windows.", "properties": { "slack_rph_limit": { "anyOf": [ { "maximum": 86400.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Slack Rph Limit" }, "slack_rpm_limit": { "anyOf": [ { "maximum": 3600.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Slack Rpm Limit" }, "working_hours_days": { "anyOf": [ { "items": { "enum": [ "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun" ], "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Working Hours Days" }, "working_hours_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Working Hours Enabled" }, "working_hours_end": { "anyOf": [ { "pattern": "^\\d{2}:\\d{2}$", "type": "string" }, { "type": "null" } ], "title": "Working Hours End" }, "working_hours_start": { "anyOf": [ { "pattern": "^\\d{2}:\\d{2}$", "type": "string" }, { "type": "null" } ], "title": "Working Hours Start" }, "working_hours_tz": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Working Hours Tz" } }, "title": "AgentSlackConfigUpdate", "type": "object" }, "AgentToolBundleGrantCreate": { "description": "Body for ``POST /tenant/{tenant_id}/agents/{agent_id}/tool-bundles``.\n\nOnly the bundle. The agent and the tenant come from the path (already\nCasbin-checked) and the acting user from the request context.", "properties": { "bundle_id": { "description": "Id of the bundle to grant to this agent.", "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Bundle Id", "type": "string" } }, "required": [ "bundle_id" ], "title": "AgentToolBundleGrantCreate", "type": "object" }, "AgentToolBundleRead": { "description": "One bundle an agent holds, with the grant's provenance.", "properties": { "bundle": { "$ref": "#/components/schemas/ToolBundleRead" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "granted_by_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Granted By User Id" } }, "required": [ "bundle", "granted_by_user_id", "created_at" ], "title": "AgentToolBundleRead", "type": "object" }, "AgentToolGrant": { "properties": { "configuration": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Configuration" }, "is_enabled": { "default": true, "title": "Is Enabled", "type": "boolean" }, "tool_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Tool Id", "type": "string" } }, "required": [ "tool_id" ], "title": "AgentToolGrant", "type": "object" }, "AgentToolRead": { "properties": { "agent_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Agent Id", "type": "string" }, "configuration": { "title": "Configuration", "type": "object" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "is_enabled": { "title": "Is Enabled", "type": "boolean" }, "tool_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Tool Id", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "agent_id", "tool_id", "configuration", "is_enabled", "created_at", "updated_at" ], "title": "AgentToolRead", "type": "object" }, "AgentUpdate": { "properties": { "bootstrap_instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bootstrap Instructions" }, "can_author_skills": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Can Author Skills" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "description_prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description Prompt" }, "editor_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Editor Enabled" }, "environment_mode": { "anyOf": [ { "enum": [ "shared", "isolated" ], "type": "string" }, { "type": "null" } ], "title": "Environment Mode" }, "external_mail_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "External Mail Enabled" }, "hidden": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Hidden" }, "image_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image Ref" }, "initial_greeting": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Initial Greeting" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active" }, "is_admin_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Admin Only" }, "iteration_warn_threshold": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Iteration Warn Threshold" }, "name": { "anyOf": [ { "maxLength": 255, "minLength": 1, "pattern": "^[A-Za-z0-9 -]+$", "type": "string" }, { "type": "null" } ], "title": "Name" }, "resource_class": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resource Class" }, "ssh_public_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ssh Public Key" }, "voice": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "title": "Voice" } }, "title": "AgentUpdate", "type": "object" }, "AgentUserGrant": { "properties": { "role": { "default": "VIEWER", "title": "Role", "type": "string" }, "user_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "User Id", "type": "string" } }, "required": [ "user_id" ], "title": "AgentUserGrant", "type": "object" }, "AgentUserGrantRead": { "properties": { "agent_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Agent Id", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "role": { "title": "Role", "type": "string" }, "user_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "User Id", "type": "string" } }, "required": [ "agent_id", "user_id", "role", "created_at" ], "title": "AgentUserGrantRead", "type": "object" }, "AllowedAccountCreate": { "properties": { "email": { "format": "email", "maxLength": 253, "minLength": 3, "title": "Email", "type": "string" } }, "required": [ "email" ], "title": "AllowedAccountCreate", "type": "object" }, "AllowedAccountRead": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "email": { "title": "Email", "type": "string" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" } }, "required": [ "id", "email", "created_at" ], "title": "AllowedAccountRead", "type": "object" }, "ApiKeyCreate": { "properties": { "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "name": { "title": "Name", "type": "string" }, "scopes": { "items": { "type": "string" }, "title": "Scopes", "type": "array" } }, "required": [ "name" ], "title": "ApiKeyCreate", "type": "object" }, "ApiKeyCreated": { "description": "Returned once, on creation. `key` is the one chance to copy it.", "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "key": { "title": "Key", "type": "string" }, "last_used_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Last Used At" }, "name": { "title": "Name", "type": "string" }, "scopes": { "items": { "type": "string" }, "title": "Scopes", "type": "array" } }, "required": [ "id", "name", "created_at", "last_used_at", "expires_at", "key" ], "title": "ApiKeyCreated", "type": "object" }, "ApiKeyRead": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "last_used_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Last Used At" }, "name": { "title": "Name", "type": "string" }, "scopes": { "items": { "type": "string" }, "title": "Scopes", "type": "array" } }, "required": [ "id", "name", "created_at", "last_used_at", "expires_at" ], "title": "ApiKeyRead", "type": "object" }, "ApprovalDecision": { "properties": { "approved": { "title": "Approved", "type": "boolean" } }, "required": [ "approved" ], "title": "ApprovalDecision", "type": "object" }, "AssistantList": { "properties": { "data": { "items": { "$ref": "#/components/schemas/AssistantObject" }, "title": "Data", "type": "array" }, "first_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First Id" }, "has_more": { "default": false, "title": "Has More", "type": "boolean" }, "last_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Id" }, "object": { "const": "list", "title": "Object", "type": "string" } }, "required": [ "data" ], "title": "AssistantList", "type": "object" }, "AssistantObject": { "properties": { "created_at": { "title": "Created At", "type": "integer" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "id": { "title": "Id", "type": "string" }, "instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instructions" }, "metadata": { "title": "Metadata", "type": "object" }, "model": { "default": "good-place-agent", "title": "Model", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "object": { "const": "assistant", "title": "Object", "type": "string" } }, "required": [ "id", "created_at" ], "title": "AssistantObject", "type": "object" }, "AtdGrantCreate": { "description": "Body for ``POST /tenant/{tenant_id}/agents/{agent_id}/atd-grants``.", "properties": { "repo_name": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "atd repository name to narrow this grant to. Omit (or null) to grant the whole organization bound to this tenant.", "title": "Repo Name" } }, "title": "AtdGrantCreate", "type": "object" }, "AtdGrantRead": { "description": "One grant row as returned to an admin.", "properties": { "agent_id": { "title": "Agent Id", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "granted_by_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Granted By User Id" }, "id": { "title": "Id", "type": "string" }, "repo_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Repo Name" }, "revoked_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Revoked At" }, "tenant_id": { "title": "Tenant Id", "type": "string" } }, "required": [ "id", "tenant_id", "agent_id", "repo_name", "granted_by_user_id", "revoked_at", "created_at" ], "title": "AtdGrantRead", "type": "object" }, "AtdRepositoryListResponse": { "description": "Response shape \u2014 a wrapped list so we can add pagination/filter fields\nlater without a breaking change.", "properties": { "repositories": { "items": { "$ref": "#/components/schemas/AtdRepositoryOption" }, "title": "Repositories", "type": "array" } }, "required": [ "repositories" ], "title": "AtdRepositoryListResponse", "type": "object" }, "AtdRepositoryOption": { "description": "One row rendered by the typeahead.\n\nDeliberately narrow: everything the picker needs to render an option and\nsubmit an identifier, and nothing else. Wider data lives on the ATD-native\n``get_repository`` MCP tool behind the same gate.", "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "scanned_branch": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scanned Branch" } }, "required": [ "id", "name" ], "title": "AtdRepositoryOption", "type": "object" }, "AuditLogRead": { "properties": { "action": { "title": "Action", "type": "string" }, "agent_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Agent Id" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "ip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ip" }, "meta": { "title": "Meta", "type": "object" }, "resource_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resource Id" }, "resource_type": { "title": "Resource Type", "type": "string" }, "tenant_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Tenant Id" }, "user_agent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Agent" }, "user_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "User Id" } }, "required": [ "id", "tenant_id", "user_id", "agent_id", "action", "resource_type", "resource_id", "ip", "user_agent", "meta", "created_at" ], "title": "AuditLogRead", "type": "object" }, "AuditSessionDetailResponse": { "description": "Full debug data for a single session (issue #513).\n\nWraps the existing ``TaskSessionDebugRead`` fields plus ``user_name``\nso the admin view can render without a second lookup.", "properties": { "completion_tokens": { "default": 0, "title": "Completion Tokens", "type": "integer" }, "messages": { "items": { "$ref": "#/components/schemas/TaskMessageRead" }, "title": "Messages", "type": "array" }, "prompt_tokens": { "default": 0, "title": "Prompt Tokens", "type": "integer" }, "session": { "$ref": "#/components/schemas/TaskSessionRead" }, "total_cost_cents": { "default": 0, "title": "Total Cost Cents", "type": "integer" }, "total_tokens": { "title": "Total Tokens", "type": "integer" }, "user_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Email" }, "user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Name" } }, "required": [ "session", "messages", "total_tokens" ], "title": "AuditSessionDetailResponse", "type": "object" }, "AuditSessionListItem": { "description": "One row in the paginated session audit list.\n\nCarries the agent name and user name so the audit table can render them\nwithout N+1 lookups. ``message_count`` is the total message count in the\nsession \u2014 useful for at-a-glance triaging.", "properties": { "agent_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Agent Id", "type": "string" }, "agent_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agent Name" }, "completed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Completed At" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "created_by_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Created By Id" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "message_count": { "default": 0, "title": "Message Count", "type": "integer" }, "started_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Started At" }, "status": { "title": "Status", "type": "string" }, "tenant_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Tenant Id", "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "user_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Email" }, "user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Name" } }, "required": [ "id", "tenant_id", "agent_id", "status", "created_at" ], "title": "AuditSessionListItem", "type": "object" }, "AuditSessionListResponse": { "description": "Paginated response for ``GET /v1/tenants/{tenant_id}/sessions``.", "properties": { "items": { "items": { "$ref": "#/components/schemas/AuditSessionListItem" }, "title": "Items", "type": "array" }, "page": { "title": "Page", "type": "integer" }, "per_page": { "title": "Per Page", "type": "integer" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "items", "total", "page", "per_page" ], "title": "AuditSessionListResponse", "type": "object" }, "AutocompleteItem": { "description": "A single autocomplete suggestion returned by the mention search endpoints.", "properties": { "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Detail" }, "id": { "title": "Id", "type": "string" }, "label": { "title": "Label", "type": "string" }, "type": { "$ref": "#/components/schemas/MentionType" } }, "required": [ "id", "label", "type" ], "title": "AutocompleteItem", "type": "object" }, "BenchmarkCreate": { "properties": { "dataset_uri": { "maxLength": 512, "minLength": 1, "title": "Dataset Uri", "type": "string" }, "default_harness": { "$ref": "#/components/schemas/BenchmarkHarness", "default": "claude_code" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "display_name": { "maxLength": 128, "minLength": 1, "title": "Display Name", "type": "string" }, "evaluator_config": { "title": "Evaluator Config", "type": "object" }, "evaluator_strategy": { "maxLength": 64, "minLength": 1, "title": "Evaluator Strategy", "type": "string" }, "is_active": { "default": true, "title": "Is Active", "type": "boolean" }, "read_only": { "default": false, "title": "Read Only", "type": "boolean" }, "slug": { "maxLength": 64, "minLength": 1, "pattern": "^[a-z0-9-]+$", "title": "Slug", "type": "string" }, "trajectory_builder": { "$ref": "#/components/schemas/TrajectoryBuilder", "default": "prefix_merging" } }, "required": [ "slug", "display_name", "dataset_uri", "evaluator_strategy" ], "title": "BenchmarkCreate", "type": "object" }, "BenchmarkHarness": { "description": "Polar's built-in agent harnesses. See ``src/polar/agent/factory.py`` upstream.", "enum": [ "claude_code", "codex", "qwen_code", "opencode", "pi", "gemini_cli", "openhands_sdk", "shell" ], "title": "BenchmarkHarness", "type": "string" }, "BenchmarkRead": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "dataset_uri": { "maxLength": 512, "minLength": 1, "title": "Dataset Uri", "type": "string" }, "default_harness": { "$ref": "#/components/schemas/BenchmarkHarness", "default": "claude_code" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "display_name": { "maxLength": 128, "minLength": 1, "title": "Display Name", "type": "string" }, "evaluator_config": { "title": "Evaluator Config", "type": "object" }, "evaluator_strategy": { "maxLength": 64, "minLength": 1, "title": "Evaluator Strategy", "type": "string" }, "id": { "title": "Id", "type": "string" }, "is_active": { "default": true, "title": "Is Active", "type": "boolean" }, "read_only": { "default": false, "title": "Read Only", "type": "boolean" }, "slug": { "maxLength": 64, "minLength": 1, "pattern": "^[a-z0-9-]+$", "title": "Slug", "type": "string" }, "trajectory_builder": { "$ref": "#/components/schemas/TrajectoryBuilder", "default": "prefix_merging" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "slug", "display_name", "dataset_uri", "evaluator_strategy", "id", "created_at", "updated_at" ], "title": "BenchmarkRead", "type": "object" }, "BenchmarkUpdate": { "properties": { "dataset_uri": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "title": "Dataset Uri" }, "default_harness": { "anyOf": [ { "$ref": "#/components/schemas/BenchmarkHarness" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "display_name": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "evaluator_config": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Evaluator Config" }, "evaluator_strategy": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Evaluator Strategy" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active" }, "read_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Read Only" }, "trajectory_builder": { "anyOf": [ { "$ref": "#/components/schemas/TrajectoryBuilder" }, { "type": "null" } ] } }, "title": "BenchmarkUpdate", "type": "object" }, "BillingPortalRedirect": { "description": "Stripe Billing Portal Session URL \u2014 front-end redirects to ``url``.", "properties": { "url": { "title": "Url", "type": "string" } }, "required": [ "url" ], "title": "BillingPortalRedirect", "type": "object" }, "Body_MCP_OAuth_revoke": { "properties": { "token": { "title": "Token", "type": "string" }, "token_type_hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Token Type Hint" } }, "required": [ "token" ], "title": "Body_MCP OAuth_revoke", "type": "object" }, "Body_MCP_OAuth_token": { "properties": { "client_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Id" }, "client_secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Secret" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "code_verifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code Verifier" }, "grant_type": { "title": "Grant Type", "type": "string" }, "redirect_uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Redirect Uri" }, "refresh_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Refresh Token" }, "scope": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scope" } }, "required": [ "grant_type" ], "title": "Body_MCP OAuth_token", "type": "object" }, "Body_admin_upload_platform_favicon": { "properties": { "upload": { "contentMediaType": "application/octet-stream", "title": "Upload", "type": "string" } }, "required": [ "upload" ], "title": "Body_admin_upload_platform_favicon", "type": "object" }, "Body_admin_upload_use_case_icon": { "properties": { "upload": { "contentMediaType": "application/octet-stream", "title": "Upload", "type": "string" } }, "required": [ "upload" ], "title": "Body_admin_upload_use_case_icon", "type": "object" }, "Body_agent_import_import_agent": { "properties": { "file": { "contentMediaType": "application/octet-stream", "title": "File", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" } }, "required": [ "file" ], "title": "Body_agent_import_import_agent", "type": "object" }, "Body_agents_upload_avatar": { "properties": { "upload": { "contentMediaType": "application/octet-stream", "title": "Upload", "type": "string" } }, "required": [ "upload" ], "title": "Body_agents_upload_avatar", "type": "object" }, "Body_documents_upload_tenant_file": { "properties": { "file": { "contentMediaType": "application/octet-stream", "title": "File", "type": "string" }, "project_id": { "title": "Project Id", "type": "string" } }, "required": [ "project_id", "file" ], "title": "Body_documents_upload_tenant_file", "type": "object" }, "Body_files_scan_upload": { "properties": { "resource_type": { "default": "file", "title": "Resource Type", "type": "string" }, "upload": { "contentMediaType": "application/octet-stream", "title": "Upload", "type": "string" } }, "required": [ "upload" ], "title": "Body_files_scan_upload", "type": "object" }, "Body_mail_upload_attachment": { "properties": { "file": { "contentMediaType": "application/octet-stream", "title": "File", "type": "string" } }, "required": [ "file" ], "title": "Body_mail_upload_attachment", "type": "object" }, "Body_marketplace_publish_version": { "properties": { "bundle": { "contentMediaType": "application/octet-stream", "title": "Bundle", "type": "string" }, "version": { "title": "Version", "type": "string" } }, "required": [ "bundle", "version" ], "title": "Body_marketplace_publish_version", "type": "object" }, "Body_memory_export_import_import_memory": { "properties": { "file": { "anyOf": [ { "contentMediaType": "application/octet-stream", "type": "string" }, { "type": "null" } ], "title": "File" }, "gcs_uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gcs Uri" } }, "title": "Body_memory_export_import_import_memory", "type": "object" }, "Body_skills_import_skill": { "properties": { "upload": { "contentMediaType": "application/octet-stream", "title": "Upload", "type": "string" } }, "required": [ "upload" ], "title": "Body_skills_import_skill", "type": "object" }, "Body_tasks_upload_session_attachment": { "properties": { "upload": { "contentMediaType": "application/octet-stream", "title": "Upload", "type": "string" } }, "required": [ "upload" ], "title": "Body_tasks_upload_session_attachment", "type": "object" }, "Body_tenant_brand_upload_favicon": { "properties": { "upload": { "contentMediaType": "application/octet-stream", "title": "Upload", "type": "string" } }, "required": [ "upload" ], "title": "Body_tenant_brand_upload_favicon", "type": "object" }, "Body_tenant_brand_upload_logo": { "properties": { "upload": { "contentMediaType": "application/octet-stream", "title": "Upload", "type": "string" } }, "required": [ "upload" ], "title": "Body_tenant_brand_upload_logo", "type": "object" }, "BriefingToday": { "description": "The calling user's NewsBot thread for their local *today* (issue #500).\n\nNewsBot has one briefing thread per user per local day; opening the page\nresolves (creating + briefing if needed) that thread and shows it. ``date``\nis the user's local calendar date the thread belongs to (ISO ``YYYY-MM-DD``).", "properties": { "date": { "title": "Date", "type": "string" }, "session_id": { "title": "Session Id", "type": "string" } }, "required": [ "session_id", "date" ], "title": "BriefingToday", "type": "object" }, "BuiltInDefaults": { "description": "Built-in detector toggle defaults.", "properties": { "max_bytes": { "default": 1048576, "minimum": 0.0, "title": "Max Bytes", "type": "integer" }, "pii_scrub": { "default": true, "title": "Pii Scrub", "type": "boolean" }, "secret_scrub": { "default": true, "title": "Secret Scrub", "type": "boolean" } }, "title": "BuiltInDefaults", "type": "object" }, "BuiltInDetectorConfigRead": { "description": "Nested read schema for built-in detector toggles.", "properties": { "max_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Bytes" }, "pii_scrub": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Pii Scrub" }, "secret_scrub": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Secret Scrub" } }, "title": "BuiltInDetectorConfigRead", "type": "object" }, "CategoryCostRow": { "description": "Spend attributed to one Julia-1 session category in the window.", "properties": { "byok_cost_usd": { "default": 0.0, "title": "Byok Cost Usd", "type": "number" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" }, "cost_usd": { "title": "Cost Usd", "type": "number" }, "input_tokens": { "title": "Input Tokens", "type": "integer" }, "output_tokens": { "title": "Output Tokens", "type": "integer" }, "provider_cost_usd": { "default": 0.0, "title": "Provider Cost Usd", "type": "number" }, "requests": { "title": "Requests", "type": "integer" }, "sessions": { "title": "Sessions", "type": "integer" } }, "required": [ "sessions", "requests", "input_tokens", "output_tokens", "cost_usd" ], "title": "CategoryCostRow", "type": "object" }, "CategoryCostsResponse": { "description": "Response for ``GET /tenant/{tenant_id}/billing/category-costs`` (issue #458).\n\nEnriches usage attribution with the Julia-1 session tag: spend grouped by the\nkind of work each session was, so billing can be reported by category. Rows\nwith ``category=None`` are sessions not yet tagged by the background pass.", "properties": { "categories": { "items": { "$ref": "#/components/schemas/CategoryCostRow" }, "title": "Categories", "type": "array" }, "period": { "$ref": "#/components/schemas/CostPeriod" }, "total_byok_cost_usd": { "default": 0.0, "title": "Total Byok Cost Usd", "type": "number" }, "total_cost_usd": { "title": "Total Cost Usd", "type": "number" }, "total_provider_cost_usd": { "default": 0.0, "title": "Total Provider Cost Usd", "type": "number" } }, "required": [ "period", "categories", "total_cost_usd" ], "title": "CategoryCostsResponse", "type": "object" }, "Changeset": { "description": "The reviewable proposal for one session, across both lanes.", "properties": { "can_fast_forward": { "default": true, "description": "True iff no staged path's live file diverged \u2014 a `select` would succeed", "title": "Can Fast Forward", "type": "boolean" }, "fork_basis_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When the run's fork basis was captured (ISO-8601)", "title": "Fork Basis At" }, "read_only": { "description": "Whether this session refuses settlement (decision #32)", "title": "Read Only", "type": "boolean" }, "repo_revisions": { "items": { "$ref": "#/components/schemas/RepoRevision" }, "title": "Repo Revisions", "type": "array" }, "retained_mode": { "description": "Whether this session captures writes as proposals", "title": "Retained Mode", "type": "boolean" }, "session_id": { "title": "Session Id", "type": "string" }, "statuses": { "items": { "$ref": "#/components/schemas/SettlementStatus" }, "title": "Statuses", "type": "array" }, "workspace_files": { "items": { "$ref": "#/components/schemas/ChangesetFile" }, "title": "Workspace Files", "type": "array" } }, "required": [ "session_id", "retained_mode", "read_only" ], "title": "Changeset", "type": "object" }, "ChangesetFile": { "description": "One staged file in a retained-output changeset (workspace lane).", "properties": { "diff": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Unified diff (live\u2192staged) for small text files; None for binary/large", "title": "Diff" }, "live_diverged": { "description": "True when the *live* file at this path changed since the run's fork basis \u2014 a `select` (fast-forward) is refused while any path diverges; `apply` is refused only when a diverged path overlaps the staged set", "title": "Live Diverged", "type": "boolean" }, "op": { "description": "added = no live file at the run's fork basis; modified = there was one", "enum": [ "added", "modified" ], "title": "Op", "type": "string" }, "path": { "description": "Path relative to the workspace root", "title": "Path", "type": "string" }, "staged_size": { "description": "Size of the staged (proposed) content in bytes", "title": "Staged Size", "type": "integer" } }, "required": [ "path", "op", "staged_size", "live_diverged" ], "title": "ChangesetFile", "type": "object" }, "CheckoutSessionRedirect": { "description": "Stripe Checkout Session URL \u2014 front-end issues a 303 to ``url``.", "properties": { "session_id": { "title": "Session Id", "type": "string" }, "url": { "title": "Url", "type": "string" } }, "required": [ "url", "session_id" ], "title": "CheckoutSessionRedirect", "type": "object" }, "CodeFindingRead": { "properties": { "agent_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Agent Id" }, "commit_sha": { "title": "Commit Sha", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "file_path": { "title": "File Path", "type": "string" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "line": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Line" }, "message": { "title": "Message", "type": "string" }, "repo_url": { "title": "Repo Url", "type": "string" }, "rule_id": { "title": "Rule Id", "type": "string" }, "sarif_blob_uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sarif Blob Uri" }, "scanner": { "title": "Scanner", "type": "string" }, "severity": { "title": "Severity", "type": "string" }, "source": { "title": "Source", "type": "string" }, "suppressed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Suppressed At" }, "suppressed_by_user_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Suppressed By User Id" }, "suppressed_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Suppressed Reason" }, "tenant_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Tenant Id" } }, "required": [ "id", "tenant_id", "agent_id", "source", "repo_url", "commit_sha", "file_path", "line", "scanner", "rule_id", "severity", "message", "sarif_blob_uri", "suppressed_at", "suppressed_by_user_id", "suppressed_reason", "created_at" ], "title": "CodeFindingRead", "type": "object" }, "CodeFindingSuppressRequest": { "properties": { "reason": { "maxLength": 2000, "minLength": 1, "title": "Reason", "type": "string" } }, "required": [ "reason" ], "title": "CodeFindingSuppressRequest", "type": "object" }, "CodeSearchHit": { "properties": { "end_line": { "title": "End Line", "type": "integer" }, "path": { "title": "Path", "type": "string" }, "score": { "title": "Score", "type": "number" }, "snippet": { "title": "Snippet", "type": "string" }, "start_line": { "title": "Start Line", "type": "integer" }, "symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Symbol" } }, "required": [ "path", "start_line", "end_line", "snippet", "score" ], "title": "CodeSearchHit", "type": "object" }, "CodeSearchRequest": { "properties": { "mode": { "default": "hybrid", "pattern": "^(semantic|hybrid)$", "title": "Mode", "type": "string" }, "path": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "title": "Path" }, "query": { "maxLength": 2000, "minLength": 1, "title": "Query", "type": "string" }, "top_k": { "default": 10, "maximum": 50.0, "minimum": 1.0, "title": "Top K", "type": "integer" } }, "required": [ "query" ], "title": "CodeSearchRequest", "type": "object" }, "CodeSearchResponse": { "properties": { "hits": { "items": { "$ref": "#/components/schemas/CodeSearchHit" }, "title": "Hits", "type": "array" }, "ingested_sha": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ingested Sha" }, "truncated": { "title": "Truncated", "type": "boolean" } }, "required": [ "hits", "truncated", "ingested_sha" ], "title": "CodeSearchResponse", "type": "object" }, "ConnectAgentIntegrationResponse": { "description": "Returned by ``connect``/``rotate``; ``url`` is what the browser redirects to.", "properties": { "url": { "title": "Url", "type": "string" } }, "required": [ "url" ], "title": "ConnectAgentIntegrationResponse", "type": "object" }, "ConnectIntegrationResponse": { "description": "Returned by ``connect``/``rotate``. ``url`` is what the front-end's\nsubmit handler redirects the browser to.", "properties": { "url": { "title": "Url", "type": "string" } }, "required": [ "url" ], "title": "ConnectIntegrationResponse", "type": "object" }, "ConnectOnboardingLink": { "description": "One-shot Stripe onboarding URL \u2014 opaque, expires per Stripe's TTL.", "properties": { "url": { "title": "Url", "type": "string" } }, "required": [ "url" ], "title": "ConnectOnboardingLink", "type": "object" }, "ConnectStatusRead": { "description": "Marketplace seller Connect Express status for the calling user.", "properties": { "charges_enabled": { "title": "Charges Enabled", "type": "boolean" }, "connected": { "title": "Connected", "type": "boolean" }, "payouts_enabled": { "title": "Payouts Enabled", "type": "boolean" }, "stripe_account_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stripe Account Id" } }, "required": [ "connected", "stripe_account_id", "charges_enabled", "payouts_enabled" ], "title": "ConnectStatusRead", "type": "object" }, "ConnectorToolSync": { "properties": { "description": { "title": "Description", "type": "string" }, "description_long": { "title": "Description Long", "type": "string" }, "display_name": { "title": "Display Name", "type": "string" }, "name": { "title": "Name", "type": "string" } }, "required": [ "name", "display_name", "description", "description_long" ], "title": "ConnectorToolSync", "type": "object" }, "CostPeriod": { "description": "Inclusive start, exclusive end. UTC.", "properties": { "end": { "format": "date-time", "title": "End", "type": "string" }, "start": { "format": "date-time", "title": "Start", "type": "string" } }, "required": [ "start", "end" ], "title": "CostPeriod", "type": "object" }, "CredentialSubmit": { "description": "Body the browser sends to store the credential value.\n\nSubmitted directly to the skill-config encryption endpoint. The value\nMUST NOT be written to ``session_message`` or conversation history.", "properties": { "config_key": { "maxLength": 128, "minLength": 1, "title": "Config Key", "type": "string" }, "request_id": { "minLength": 1, "title": "Request Id", "type": "string" }, "skill_id": { "minLength": 1, "title": "Skill Id", "type": "string" }, "value": { "description": "The raw credential value. Encrypted immediately; never persisted in cleartext.", "minLength": 1, "title": "Value", "type": "string" } }, "required": [ "request_id", "skill_id", "config_key", "value" ], "title": "CredentialSubmit", "type": "object" }, "CronBlackoutCreate": { "properties": { "agent_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Agent Id" }, "end_date": { "format": "date", "title": "End Date", "type": "string" }, "name": { "maxLength": 128, "minLength": 1, "title": "Name", "type": "string" }, "reason": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "title": "Reason" }, "recurring_yearly": { "default": false, "title": "Recurring Yearly", "type": "boolean" }, "start_date": { "format": "date", "title": "Start Date", "type": "string" }, "timezone": { "default": "UTC", "maxLength": 64, "title": "Timezone", "type": "string" } }, "required": [ "name", "start_date", "end_date" ], "title": "CronBlackoutCreate", "type": "object" }, "CronBlackoutRead": { "properties": { "agent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agent Id" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "created_by_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By User Id" }, "end_date": { "format": "date", "title": "End Date", "type": "string" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "recurring_yearly": { "title": "Recurring Yearly", "type": "boolean" }, "start_date": { "format": "date", "title": "Start Date", "type": "string" }, "tenant_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Tenant Id", "type": "string" }, "timezone": { "title": "Timezone", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "tenant_id", "agent_id", "name", "reason", "start_date", "end_date", "timezone", "recurring_yearly", "created_by_user_id", "created_at", "updated_at" ], "title": "CronBlackoutRead", "type": "object" }, "CronBlackoutUpdate": { "properties": { "agent_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Agent Id" }, "end_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "End Date" }, "name": { "anyOf": [ { "maxLength": 128, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Name" }, "reason": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "title": "Reason" }, "recurring_yearly": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Recurring Yearly" }, "start_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "Start Date" }, "timezone": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Timezone" } }, "title": "CronBlackoutUpdate", "type": "object" }, "CronJobCreate": { "properties": { "body_bytes": { "anyOf": [ { "contentMediaType": "application/octet-stream", "type": "string" }, { "type": "null" } ], "title": "Body Bytes" }, "cron_expr": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "title": "Cron Expr" }, "fire_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Fire At" }, "headers": { "title": "Headers", "type": "object" }, "interval_minutes": { "anyOf": [ { "maximum": 525960.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Interval Minutes" }, "kind": { "pattern": "^(one_shot|recurring)$", "title": "Kind", "type": "string" }, "max_retries": { "default": 3, "maximum": 10.0, "minimum": 0.0, "title": "Max Retries", "type": "integer" }, "method": { "default": "POST", "pattern": "^(GET|POST|PUT|DELETE|PATCH)$", "title": "Method", "type": "string" }, "name": { "maxLength": 128, "minLength": 1, "title": "Name", "type": "string" }, "retry_backoff": { "default": "exponential", "maxLength": 32, "title": "Retry Backoff", "type": "string" }, "schedule_type": { "default": "interval", "pattern": "^(interval|daily)$", "title": "Schedule Type", "type": "string" }, "start_time": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Start Time" }, "target": { "minLength": 1, "title": "Target", "type": "string" }, "target_kind": { "pattern": "^(internal_agent|external_url)$", "title": "Target Kind", "type": "string" }, "timezone": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Timezone" } }, "required": [ "name", "kind", "target_kind", "target" ], "title": "CronJobCreate", "type": "object" }, "CronJobDetail": { "description": "``CronJobRead`` plus the request body, for the detail view (#216).\n\nThe body is stored in GCS, not on the row, so it is fetched from the cron\nservice on demand (``?include_body=true``) rather than being returned by\nevery list call. For a ``target_kind=internal_agent`` routine this **is the\nprompt the agent will be handed**, which is why the tab needs it \u2014 a\nschedule with an invisible payload isn't reviewable.\n\n``body`` is None when the routine has no body, and also when the cron\nservice could not be reached: the schedule is still worth rendering when\nthe body fetch fails, so the failure is reported as absence plus\n``body_available=False`` rather than by failing the whole request.", "properties": { "agent_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Agent Id", "type": "string" }, "body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Body" }, "body_available": { "default": true, "title": "Body Available", "type": "boolean" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "created_by_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By User Id" }, "cron_expr": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cron Expr" }, "fire_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Fire At" }, "headers": { "title": "Headers", "type": "object" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "kind": { "title": "Kind", "type": "string" }, "last_fired_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Last Fired At" }, "last_status_code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Last Status Code" }, "max_retries": { "title": "Max Retries", "type": "integer" }, "method": { "title": "Method", "type": "string" }, "name": { "title": "Name", "type": "string" }, "next_fire_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Next Fire At" }, "retry_backoff": { "title": "Retry Backoff", "type": "string" }, "status": { "title": "Status", "type": "string" }, "target": { "title": "Target", "type": "string" }, "target_kind": { "title": "Target Kind", "type": "string" }, "tenant_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Tenant Id", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Timezone" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "tenant_id", "agent_id", "created_by_user_id", "name", "kind", "fire_at", "cron_expr", "timezone", "next_fire_at", "method", "target_kind", "target", "headers", "max_retries", "retry_backoff", "status", "last_fired_at", "last_status_code", "created_at", "updated_at" ], "title": "CronJobDetail", "type": "object" }, "CronJobRead": { "properties": { "agent_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Agent Id", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "created_by_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By User Id" }, "cron_expr": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cron Expr" }, "fire_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Fire At" }, "headers": { "title": "Headers", "type": "object" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "kind": { "title": "Kind", "type": "string" }, "last_fired_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Last Fired At" }, "last_status_code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Last Status Code" }, "max_retries": { "title": "Max Retries", "type": "integer" }, "method": { "title": "Method", "type": "string" }, "name": { "title": "Name", "type": "string" }, "next_fire_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Next Fire At" }, "retry_backoff": { "title": "Retry Backoff", "type": "string" }, "status": { "title": "Status", "type": "string" }, "target": { "title": "Target", "type": "string" }, "target_kind": { "title": "Target Kind", "type": "string" }, "tenant_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Tenant Id", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Timezone" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "tenant_id", "agent_id", "created_by_user_id", "name", "kind", "fire_at", "cron_expr", "timezone", "next_fire_at", "method", "target_kind", "target", "headers", "max_retries", "retry_backoff", "status", "last_fired_at", "last_status_code", "created_at", "updated_at" ], "title": "CronJobRead", "type": "object" }, "CronJobUpdate": { "properties": { "body_bytes": { "anyOf": [ { "contentMediaType": "application/octet-stream", "type": "string" }, { "type": "null" } ], "title": "Body Bytes" }, "cron_expr": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "title": "Cron Expr" }, "headers": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Headers" }, "interval_minutes": { "anyOf": [ { "maximum": 525960.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Interval Minutes" }, "max_retries": { "anyOf": [ { "maximum": 10.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Max Retries" }, "method": { "anyOf": [ { "pattern": "^(GET|POST|PUT|DELETE|PATCH)$", "type": "string" }, { "type": "null" } ], "title": "Method" }, "name": { "anyOf": [ { "maxLength": 128, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Name" }, "retry_backoff": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "title": "Retry Backoff" }, "schedule_type": { "anyOf": [ { "pattern": "^(interval|daily)$", "type": "string" }, { "type": "null" } ], "title": "Schedule Type" }, "start_time": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Start Time" }, "target": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Target" }, "timezone": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Timezone" } }, "title": "CronJobUpdate", "type": "object" }, "CronRunNowRequest": { "description": "Body of the public run-now route (#216).\n\n``override_blackout`` is refused for an own-scoped caller (a MEMBER holding\nonly ``cron:own:write``); overriding a tenant-wide control is an admin act.", "properties": { "override_blackout": { "default": false, "title": "Override Blackout", "type": "boolean" } }, "title": "CronRunNowRequest", "type": "object" }, "CronRunRead": { "description": "One fire attempt (#216). Rows are written by the cron service after every\nattempt, retries included, so a routine that has been failing all week shows\nas a run of non-2xx ``status_code`` values rather than a single stale\n``last_status_code`` on the job.", "properties": { "attempt": { "title": "Attempt", "type": "integer" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "fired_at": { "format": "date-time", "title": "Fired At", "type": "string" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "job_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Job Id", "type": "string" }, "status_code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Status Code" } }, "required": [ "id", "job_id", "attempt", "status_code", "error", "fired_at", "created_at" ], "title": "CronRunRead", "type": "object" }, "CustomHttpModelCreate": { "description": "Body for ``POST /tenant/{tenant_id}/models/custom-http`` (BYOM, #507).\n\nDeliberately narrow: ``kind`` is forced to ``custom_http`` server-side and\nthe tenant/owner come from the path + auth context, so a caller cannot\nsmuggle ``tenant_id`` / ``owner_user_id`` / ``kind`` / ``status`` /\n``is_super_admin`` (mass-assignment defense). ``auth_token`` is the secret\nbearer token; it is stored encrypted via BYOK and never echoed back.", "properties": { "auth_token": { "maxLength": 4096, "minLength": 1, "title": "Auth Token", "type": "string" }, "base_url": { "maxLength": 2048, "minLength": 1, "title": "Base Url", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "extra_headers": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Extra Headers" }, "model_slug": { "maxLength": 256, "minLength": 1, "title": "Model Slug", "type": "string" }, "name": { "maxLength": 128, "minLength": 1, "title": "Name", "type": "string" }, "pricing": { "title": "Pricing", "type": "object" } }, "required": [ "name", "base_url", "model_slug", "auth_token" ], "title": "CustomHttpModelCreate", "type": "object" }, "CustomRedactionPattern": { "description": "A tenant-supplied regex pattern + replacement tag.", "properties": { "pattern": { "maxLength": 1024, "minLength": 1, "title": "Pattern", "type": "string" }, "tag": { "maxLength": 64, "minLength": 1, "title": "Tag", "type": "string" } }, "required": [ "pattern", "tag" ], "title": "CustomRedactionPattern", "type": "object" }, "DatabaseCredentialAdd": { "description": "Request body for adding or rotating a PostgreSQL database credential.\n\nThe password is encrypted immediately and never returned via the API.\nProvider is stored as ``db:postgres:`` so each target host has a\ndistinct linked_identity row.", "properties": { "database": { "description": "Database name to connect to. Colons are not allowed.", "maxLength": 63, "minLength": 1, "pattern": "^[^:]+$", "title": "Database", "type": "string" }, "host": { "description": "Hostname or IP address of the database server. Only letters, digits, dots, hyphens, and underscores are allowed \u2014 must match what the `db_query` connector accepts.", "maxLength": 52, "minLength": 1, "pattern": "^[A-Za-z0-9._-]+$", "title": "Host", "type": "string" }, "label": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "description": "Human-readable label (defaults to username@host:port/database)", "title": "Label" }, "password": { "description": "Database password. Encrypted at rest; never returned.", "minLength": 1, "title": "Password", "type": "string" }, "port": { "default": 5432, "description": "PostgreSQL port (default 5432)", "maximum": 65535.0, "minimum": 1.0, "title": "Port", "type": "integer" }, "ssl_mode": { "description": "SSL mode: 'require' (SSL mandatory), 'prefer' (try SSL, fall back to plaintext), or 'disable' (plaintext). Default: 'prefer'.", "enum": [ "require", "prefer", "disable" ], "title": "Ssl Mode", "type": "string" }, "username": { "description": "Database username.", "maxLength": 64, "minLength": 1, "pattern": "^[A-Za-z0-9._@-]+$", "title": "Username", "type": "string" } }, "required": [ "host", "username", "database", "password" ], "title": "DatabaseCredentialAdd", "type": "object" }, "DecisionLogEntry": { "properties": { "agent_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Agent Id", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "decision": { "title": "Decision", "type": "string" }, "detector": { "title": "Detector", "type": "string" }, "direction": { "title": "Direction", "type": "string" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "meta": { "title": "Meta", "type": "object" }, "reason": { "title": "Reason", "type": "string" }, "session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Session Id" }, "tenant_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Tenant Id", "type": "string" } }, "required": [ "id", "tenant_id", "agent_id", "direction", "detector", "decision", "reason", "created_at" ], "title": "DecisionLogEntry", "type": "object" }, "DecisionLogResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/DecisionLogEntry" }, "title": "Items", "type": "array" }, "next_page_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Page Token" } }, "required": [ "items" ], "title": "DecisionLogResponse", "type": "object" }, "DefaultPermissionsRead": { "description": "Tenant-wide default permissions.", "properties": { "can_create_agents": { "default": true, "title": "Can Create Agents", "type": "boolean" }, "can_create_skills": { "default": true, "title": "Can Create Skills", "type": "boolean" }, "can_invite_users": { "default": false, "title": "Can Invite Users", "type": "boolean" }, "can_manage_settings": { "default": false, "title": "Can Manage Settings", "type": "boolean" }, "can_view_billing": { "default": false, "title": "Can View Billing", "type": "boolean" } }, "title": "DefaultPermissionsRead", "type": "object" }, "DefaultPermissionsUpdate": { "description": "Update body for tenant default permissions.", "properties": { "can_create_agents": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Can Create Agents" }, "can_create_skills": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Can Create Skills" }, "can_invite_users": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Can Invite Users" }, "can_manage_settings": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Can Manage Settings" }, "can_view_billing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Can View Billing" } }, "title": "DefaultPermissionsUpdate", "type": "object" }, "DelegationCreate": { "description": "Request body for granting an agent read-only delegation.", "properties": { "agent_id": { "maxLength": 25, "minLength": 1, "title": "Agent Id", "type": "string" }, "channels": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "description": "Optional channel/folder filter. E.g. {'channels': ['#general', '#eng']} for Slack, or {'folders': ['INBOX']} for email.", "title": "Channels" }, "provider": { "description": "Provider slug matching the user's linked_identity (e.g. 'slack', 'email:google').", "maxLength": 64, "minLength": 1, "title": "Provider", "type": "string" }, "scope": { "const": "read", "description": "Delegation scope. Only 'read' is supported in this release.", "title": "Scope", "type": "string" } }, "required": [ "agent_id", "provider" ], "title": "DelegationCreate", "type": "object" }, "DelegationRead": { "description": "Public projection of a delegation (linked_identity with delegated_agent_id set).", "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "delegated_agent_id": { "title": "Delegated Agent Id", "type": "string" }, "delegated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Delegated At" }, "delegation_channels": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Delegation Channels" }, "delegation_scope": { "title": "Delegation Scope", "type": "string" }, "display_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Label" }, "id": { "title": "Id", "type": "string" }, "provider": { "title": "Provider", "type": "string" }, "scopes": { "items": { "type": "string" }, "title": "Scopes", "type": "array" }, "user_id": { "title": "User Id", "type": "string" } }, "required": [ "id", "user_id", "provider", "delegated_agent_id", "delegation_scope", "delegation_channels", "delegated_at", "display_label", "scopes", "created_at" ], "title": "DelegationRead", "type": "object" }, "DesktopClientConfig": { "description": "How a desktop client (the VS Code extension) signs in with Keycloak.", "properties": { "client_id": { "title": "Client Id", "type": "string" }, "issuer": { "title": "Issuer", "type": "string" } }, "required": [ "issuer", "client_id" ], "title": "DesktopClientConfig", "type": "object" }, "DevEnvCreateResponse": { "properties": { "name": { "title": "Name", "type": "string" }, "ssh_enabled": { "default": false, "title": "Ssh Enabled", "type": "boolean" }, "ssh_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ssh Username" }, "status": { "default": "created", "title": "Status", "type": "string" } }, "required": [ "name" ], "title": "DevEnvCreateResponse", "type": "object" }, "DevEnvExtraSshKeyCreate": { "properties": { "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "public_key": { "minLength": 1, "title": "Public Key", "type": "string" }, "user_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "User Id" }, "username": { "maxLength": 32, "minLength": 1, "title": "Username", "type": "string" } }, "required": [ "username", "public_key" ], "title": "DevEnvExtraSshKeyCreate", "type": "object" }, "DevEnvExtraSshKeyRead": { "properties": { "agent_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Agent Id", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "granted_by_user_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Granted By User Id", "type": "string" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "public_key": { "title": "Public Key", "type": "string" }, "user_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "User Id" }, "username": { "title": "Username", "type": "string" } }, "required": [ "id", "agent_id", "username", "public_key", "granted_by_user_id", "created_at" ], "title": "DevEnvExtraSshKeyRead", "type": "object" }, "DevEnvGroupIdeGrantCreate": { "description": "Grant web-IDE access to a tenant group's user members (#424).\n\nNo key material \u2014 unlike an extra SSH key this only opens the browser editor\n(which runs as the shared uid), so a group member needs no Linux key on the\npod. ``expires_at`` optionally time-boxes the grant.", "properties": { "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "group_id": { "maxLength": 32, "minLength": 1, "title": "Group Id", "type": "string" } }, "required": [ "group_id" ], "title": "DevEnvGroupIdeGrantCreate", "type": "object" }, "DevEnvGroupIdeGrantRead": { "properties": { "agent_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Agent Id", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "granted_by_user_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Granted By User Id", "type": "string" }, "group_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Group Id", "type": "string" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" } }, "required": [ "id", "agent_id", "group_id", "granted_by_user_id", "created_at" ], "title": "DevEnvGroupIdeGrantRead", "type": "object" }, "DevEnvStartRequest": { "description": "Body of the tenant-scoped start route (GitLab #313) \u2014 deliberately empty.\n\nThe internal route lets its caller name an image; a browser must not, so\nthis model carries no fields and forbids extras. Anything smuggled in\n(``image``, ``tenant_id``, ``is_super_admin``, ``agent_id``) is a 422 rather\nthan a field that might one day be read.", "properties": {}, "title": "DevEnvStartRequest", "type": "object" }, "DevEnvStatusResponse": { "properties": { "exists": { "title": "Exists", "type": "boolean" }, "name": { "title": "Name", "type": "string" }, "ready": { "title": "Ready", "type": "boolean" }, "ready_replicas": { "default": 0, "title": "Ready Replicas", "type": "integer" }, "replicas": { "default": 0, "title": "Replicas", "type": "integer" }, "ssh_enabled": { "default": false, "title": "Ssh Enabled", "type": "boolean" }, "ssh_host": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ssh Host" }, "ssh_port": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ssh Port" }, "ssh_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ssh Username" } }, "required": [ "exists", "ready", "name" ], "title": "DevEnvStatusResponse", "type": "object" }, "DigestRead": { "description": "The latest structured digest for a session, or ``null`` if none exists.", "properties": { "generated_at": { "format": "date-time", "title": "Generated At", "type": "string" }, "lead_summary": { "title": "Lead Summary", "type": "string" }, "stories": { "items": { "$ref": "#/components/schemas/DigestStoryRead" }, "title": "Stories", "type": "array" } }, "required": [ "lead_summary", "generated_at", "stories" ], "title": "DigestRead", "type": "object" }, "DigestStoryRead": { "description": "One story tile in the feed.", "properties": { "image_status": { "enum": [ "pending", "resolved", "failed" ], "title": "Image Status", "type": "string" }, "og_image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Og Image Url" }, "position": { "title": "Position", "type": "integer" }, "source": { "title": "Source", "type": "string" }, "summary": { "title": "Summary", "type": "string" }, "title": { "title": "Title", "type": "string" }, "url": { "title": "Url", "type": "string" } }, "required": [ "position", "title", "summary", "url", "source", "og_image_url", "image_status" ], "title": "DigestStoryRead", "type": "object" }, "DocumentFile": { "description": "One uploaded file.\n\n``page_count`` is always ``None`` today: DocWorker's ``file`` row has no\npage count and its extractors discard the page structure after pulling\ntext (``services/ingest.py::_extract_pdf``). The key is kept in the\ncontract rather than dropped so populating it later is additive.\n\n``scan_status`` is the ClamAV verdict for this file, read from the\nplatform's own ``file_scan`` table (decision #24) \u2014 not from DocWorker.\n``None`` means no scan row references this file id yet.", "properties": { "content_type": { "title": "Content Type", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "filename": { "title": "Filename", "type": "string" }, "id": { "title": "Id", "type": "string" }, "page_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Page Count" }, "project_id": { "title": "Project Id", "type": "string" }, "scan_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scan Status" }, "size_bytes": { "title": "Size Bytes", "type": "integer" }, "status": { "title": "Status", "type": "string" } }, "required": [ "id", "filename", "content_type", "size_bytes", "project_id", "status", "created_at" ], "title": "DocumentFile", "type": "object" }, "DocumentFileBatchDeleteRequest": { "description": "Delete several files in one call \u2014 the \"Manage files\" bulk action.\n\n``file_ids`` carries only ids the caller selected; there is no\ntenant/owner field to smuggle (mass-assignment). The list is capped so a\nsingle request cannot fan out into an unbounded number of DocWorker\ndeletes, and the route de-duplicates before acting.", "properties": { "file_ids": { "items": { "type": "string" }, "maxItems": 100, "minItems": 1, "title": "File Ids", "type": "array" } }, "required": [ "file_ids" ], "title": "DocumentFileBatchDeleteRequest", "type": "object" }, "DocumentFileBatchDeleteResponse": { "description": "Partial-success result: what went, and what didn't and why.\n\nA single bad id does not sink the batch \u2014 the good ones are deleted and\nreported in ``deleted``; the rest land in ``failed`` so the UI can tell\nthe operator exactly what remains.", "properties": { "deleted": { "items": { "type": "string" }, "title": "Deleted", "type": "array" }, "failed": { "items": { "$ref": "#/components/schemas/DocumentFileDeleteFailure" }, "title": "Failed", "type": "array" } }, "required": [ "deleted", "failed" ], "title": "DocumentFileBatchDeleteResponse", "type": "object" }, "DocumentFileDeleteFailure": { "description": "One file the batch could not delete, with a non-leaky reason.\n\n``reason`` is deliberately coarse (\"not found\") \u2014 a foreign or mistyped\nid must be indistinguishable, so the response never confirms whether an\nid exists in another tenant (IDOR/BOLA).", "properties": { "id": { "title": "Id", "type": "string" }, "reason": { "title": "Reason", "type": "string" } }, "required": [ "id", "reason" ], "title": "DocumentFileDeleteFailure", "type": "object" }, "DocumentFileListResponse": { "properties": { "files": { "items": { "$ref": "#/components/schemas/DocumentFile" }, "title": "Files", "type": "array" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "files", "total" ], "title": "DocumentFileListResponse", "type": "object" }, "DocumentImportStatus": { "properties": { "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "files_imported": { "default": 0, "title": "Files Imported", "type": "integer" }, "finished_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Finished At" }, "started_at": { "format": "date-time", "title": "Started At", "type": "string" }, "status": { "title": "Status", "type": "string" } }, "required": [ "status", "started_at" ], "title": "DocumentImportStatus", "type": "object" }, "DocumentImportTriggered": { "properties": { "import_run_id": { "title": "Import Run Id", "type": "string" }, "status": { "title": "Status", "type": "string" } }, "required": [ "import_run_id", "status" ], "title": "DocumentImportTriggered", "type": "object" }, "DocumentProject": { "description": "One knowledge-base project. ``file_count`` is computed by DocWorker.", "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "file_count": { "default": 0, "title": "File Count", "type": "integer" }, "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "name", "created_at", "updated_at" ], "title": "DocumentProject", "type": "object" }, "DocumentProjectCreate": { "properties": { "description": { "anyOf": [ { "maxLength": 2000, "type": "string" }, { "type": "null" } ], "title": "Description" }, "name": { "maxLength": 200, "minLength": 1, "title": "Name", "type": "string" } }, "required": [ "name" ], "title": "DocumentProjectCreate", "type": "object" }, "DocumentProjectListResponse": { "properties": { "projects": { "items": { "$ref": "#/components/schemas/DocumentProject" }, "title": "Projects", "type": "array" } }, "required": [ "projects" ], "title": "DocumentProjectListResponse", "type": "object" }, "DocumentProjectUpdate": { "properties": { "description": { "anyOf": [ { "maxLength": 2000, "type": "string" }, { "type": "null" } ], "title": "Description" }, "name": { "anyOf": [ { "maxLength": 200, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Name" } }, "title": "DocumentProjectUpdate", "type": "object" }, "DocumentSearchHit": { "properties": { "chunk_id": { "title": "Chunk Id", "type": "string" }, "content": { "title": "Content", "type": "string" }, "end_char": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "End Char" }, "file_id": { "title": "File Id", "type": "string" }, "mode": { "enum": [ "semantic", "keyword" ], "title": "Mode", "type": "string" }, "ordinal": { "title": "Ordinal", "type": "integer" }, "project_id": { "title": "Project Id", "type": "string" }, "score": { "title": "Score", "type": "number" }, "start_char": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Start Char" } }, "required": [ "chunk_id", "file_id", "project_id", "ordinal", "content", "score", "mode" ], "title": "DocumentSearchHit", "type": "object" }, "DocumentSearchRequest": { "properties": { "limit": { "default": 10, "maximum": 50.0, "minimum": 1.0, "title": "Limit", "type": "integer" }, "mode": { "enum": [ "semantic", "keyword" ], "title": "Mode", "type": "string" }, "project_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Id" }, "query": { "minLength": 1, "title": "Query", "type": "string" } }, "required": [ "query" ], "title": "DocumentSearchRequest", "type": "object" }, "DocumentSearchResponse": { "properties": { "hits": { "items": { "$ref": "#/components/schemas/DocumentSearchHit" }, "title": "Hits", "type": "array" } }, "required": [ "hits" ], "title": "DocumentSearchResponse", "type": "object" }, "DocumentSource": { "properties": { "folder_ids": { "items": { "type": "string" }, "title": "Folder Ids", "type": "array" }, "id": { "title": "Id", "type": "string" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" }, "last_import_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Last Import At" }, "last_import_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Import Status" }, "linked_at": { "format": "date-time", "title": "Linked At", "type": "string" }, "provider": { "title": "Provider", "type": "string" } }, "required": [ "id", "provider", "folder_ids", "linked_at" ], "title": "DocumentSource", "type": "object" }, "DocumentSourceCreate": { "description": "Link a merge.dev file-storage account's folders as a document source.", "properties": { "folder_ids": { "items": { "type": "string" }, "maxItems": 200, "minItems": 1, "title": "Folder Ids", "type": "array" }, "label": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Label" }, "provider": { "maxLength": 64, "minLength": 1, "title": "Provider", "type": "string" } }, "required": [ "provider", "folder_ids" ], "title": "DocumentSourceCreate", "type": "object" }, "DocumentSourceFolder": { "description": "One folder in the linked account's tree.\n\n``parent_id`` is ``None`` for a top-level folder. ``has_children`` is\nderived from the account's own folder set, so an empty folder is never\noffered as expandable.", "properties": { "has_children": { "default": false, "title": "Has Children", "type": "boolean" }, "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Id" } }, "required": [ "id", "name" ], "title": "DocumentSourceFolder", "type": "object" }, "DocumentSourceFolderListResponse": { "properties": { "folders": { "items": { "$ref": "#/components/schemas/DocumentSourceFolder" }, "title": "Folders", "type": "array" } }, "required": [ "folders" ], "title": "DocumentSourceFolderListResponse", "type": "object" }, "DocumentSourceListResponse": { "properties": { "sources": { "items": { "$ref": "#/components/schemas/DocumentSource" }, "title": "Sources", "type": "array" } }, "required": [ "sources" ], "title": "DocumentSourceListResponse", "type": "object" }, "DocumentSourceProvider": { "description": "One selectable file-storage provider.\n\n``connected`` is whether the tenant already holds a usable merge.dev\nfile-storage link for it (decision #20 \u2014 the token lives in\n``tenant_identity``). The UI disables the rest until it is true, so a\nprovider is never offered as a destination the server cannot reach.", "properties": { "connected": { "default": false, "title": "Connected", "type": "boolean" }, "id": { "title": "Id", "type": "string" }, "label": { "title": "Label", "type": "string" } }, "required": [ "id", "label" ], "title": "DocumentSourceProvider", "type": "object" }, "DocumentSourceProviderListResponse": { "properties": { "providers": { "items": { "$ref": "#/components/schemas/DocumentSourceProvider" }, "title": "Providers", "type": "array" } }, "required": [ "providers" ], "title": "DocumentSourceProviderListResponse", "type": "object" }, "EditorToolResult": { "description": "An editor answering one tool call.\n\n``result`` is shaped like any tool result \u2014 ``{\"success\": bool, ...}`` \u2014\nand goes to the model verbatim, so the editor truncates large output first.", "properties": { "call_id": { "maxLength": 64, "minLength": 1, "title": "Call Id", "type": "string" }, "result": { "title": "Result", "type": "object" } }, "required": [ "call_id", "result" ], "title": "EditorToolResult", "type": "object" }, "EditorTurn": { "description": "Optional ``editor`` block on ``POST \u2026/sessions/{s}/messages``.\n\nNames the workspace tools the calling editor will answer itself for the turn\nthis message starts. Only an agent with ``editor_enabled`` accepts it;\nunknown names are ignored, and a read-only session is offered only the\nread tools.", "properties": { "tools": { "items": { "type": "string" }, "maxItems": 32, "title": "Tools", "type": "array" }, "workspace": { "anyOf": [ { "$ref": "#/components/schemas/EditorWorkspace" }, { "type": "null" } ] } }, "title": "EditorTurn", "type": "object" }, "EditorWorkspace": { "description": "What the connected editor has open, for the agent's prompt.\n\nDeliberately tiny and length-capped: every field is client-supplied and is\nrendered into the prompt of the turn it rides on.", "properties": { "git_branch": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Git Branch" }, "git_remote": { "anyOf": [ { "maxLength": 400, "type": "string" }, { "type": "null" } ], "description": "Credentials are stripped server-side.", "title": "Git Remote" }, "name": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "description": "Workspace folder name.", "title": "Name" }, "platform": { "anyOf": [ { "maxLength": 50, "type": "string" }, { "type": "null" } ], "description": "Editor host OS, e.g. darwin, linux, win32.", "title": "Platform" } }, "title": "EditorWorkspace", "type": "object" }, "EffectiveTerms": { "description": "What a tenant actually runs under: its plan with overrides applied.", "properties": { "allow_byo_models": { "title": "Allow Byo Models", "type": "boolean" }, "allowed_merge_categories": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Allowed Merge Categories" }, "apps": { "additionalProperties": { "type": "boolean" }, "title": "Apps", "type": "object" }, "budgets": { "additionalProperties": { "additionalProperties": { "type": "number" }, "type": "object" }, "title": "Budgets", "type": "object" }, "free_tier_model_kinds": { "items": { "type": "string" }, "title": "Free Tier Model Kinds", "type": "array" }, "ide_free_minutes_per_month": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ide Free Minutes Per Month" }, "ide_price_cents_per_user_hour": { "title": "Ide Price Cents Per User Hour", "type": "integer" }, "max_agents": { "title": "Max Agents", "type": "integer" }, "max_concurrent_sessions": { "title": "Max Concurrent Sessions", "type": "integer" }, "max_connections_per_agent": { "title": "Max Connections Per Agent", "type": "integer" }, "max_mailboxes_per_agent": { "title": "Max Mailboxes Per Agent", "type": "integer" }, "max_messages_per_mailbox": { "title": "Max Messages Per Mailbox", "type": "integer" }, "max_storage_gb": { "title": "Max Storage Gb", "type": "integer" }, "max_tasks_per_day": { "title": "Max Tasks Per Day", "type": "integer" }, "overridden": { "items": { "type": "string" }, "title": "Overridden", "type": "array" }, "paid_tier": { "default": false, "title": "Paid Tier", "type": "boolean" }, "plan_code": { "title": "Plan Code", "type": "string" }, "plan_id": { "title": "Plan Id", "type": "string" }, "price_cents": { "title": "Price Cents", "type": "integer" }, "seat_price_cents": { "title": "Seat Price Cents", "type": "integer" }, "token_markup_bps": { "title": "Token Markup Bps", "type": "integer" }, "zero_cost_model_kinds": { "items": { "type": "string" }, "title": "Zero Cost Model Kinds", "type": "array" } }, "required": [ "plan_id", "plan_code", "max_agents", "max_tasks_per_day", "max_concurrent_sessions", "max_storage_gb", "max_mailboxes_per_agent", "max_messages_per_mailbox", "max_connections_per_agent", "price_cents", "seat_price_cents", "token_markup_bps", "ide_price_cents_per_user_hour", "ide_free_minutes_per_month", "allow_byo_models", "allowed_merge_categories", "budgets", "apps" ], "title": "EffectiveTerms", "type": "object" }, "EmailVerificationResult": { "properties": { "detail": { "title": "Detail", "type": "string" }, "ok": { "title": "Ok", "type": "boolean" } }, "required": [ "ok", "detail" ], "title": "EmailVerificationResult", "type": "object" }, "EmailVerificationStatus": { "properties": { "email": { "title": "Email", "type": "string" }, "email_verified": { "title": "Email Verified", "type": "boolean" }, "email_verified_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email Verified At" } }, "required": [ "email", "email_verified", "email_verified_at" ], "title": "EmailVerificationStatus", "type": "object" }, "EnableWritesResponse": { "properties": { "enabled": { "title": "Enabled", "type": "boolean" }, "expires_at": { "title": "Expires At", "type": "string" }, "grant_id": { "title": "Grant Id", "type": "string" } }, "required": [ "enabled", "grant_id", "expires_at" ], "title": "EnableWritesResponse", "type": "object" }, "ExpensiveTaskRow": { "description": "One of the Top-N most expensive task sessions in the window.", "properties": { "agent_id": { "title": "Agent Id", "type": "string" }, "agent_name": { "title": "Agent Name", "type": "string" }, "completed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Completed At" }, "cost_usd": { "title": "Cost Usd", "type": "number" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "duration_seconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Duration Seconds" }, "input_tokens": { "title": "Input Tokens", "type": "integer" }, "output_tokens": { "title": "Output Tokens", "type": "integer" }, "requests": { "title": "Requests", "type": "integer" }, "session_id": { "title": "Session Id", "type": "string" }, "started_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Started At" }, "status": { "title": "Status", "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "top_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Top Model" }, "user_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Email" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id" }, "user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Name" } }, "required": [ "session_id", "status", "agent_id", "agent_name", "requests", "input_tokens", "output_tokens", "cost_usd", "created_at" ], "title": "ExpensiveTaskRow", "type": "object" }, "FineTuneJobCreate": { "properties": { "base_model_id": { "maxLength": 25, "minLength": 25, "title": "Base Model Id", "type": "string" }, "benchmark_id": { "maxLength": 25, "minLength": 25, "title": "Benchmark Id", "type": "string" }, "harness": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Harness" }, "hparams": { "title": "Hparams", "type": "object" }, "trainer": { "default": "slime", "title": "Trainer", "type": "string" } }, "required": [ "benchmark_id", "base_model_id" ], "title": "FineTuneJobCreate", "type": "object" }, "FineTuneJobPromoteRequest": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "name": { "maxLength": 128, "minLength": 1, "title": "Name", "type": "string" } }, "required": [ "name" ], "title": "FineTuneJobPromoteRequest", "type": "object" }, "FineTuneJobRead": { "properties": { "base_model_id": { "title": "Base Model Id", "type": "string" }, "benchmark_id": { "title": "Benchmark Id", "type": "string" }, "checkpoint_uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Checkpoint Uri" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "harness": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Harness" }, "hparams": { "title": "Hparams", "type": "object" }, "id": { "title": "Id", "type": "string" }, "k8s_job_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "K8S Job Name" }, "k8s_namespace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "K8S Namespace" }, "progress_pct": { "title": "Progress Pct", "type": "integer" }, "promoted_model_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Promoted Model Id" }, "reward_mean": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Reward Mean" }, "status": { "$ref": "#/components/schemas/FineTuneJobStatus" }, "step": { "title": "Step", "type": "integer" }, "trainer": { "title": "Trainer", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "benchmark_id", "base_model_id", "harness", "trainer", "hparams", "status", "step", "progress_pct", "reward_mean", "checkpoint_uri", "promoted_model_id", "error", "k8s_job_name", "k8s_namespace", "created_by", "created_at", "updated_at" ], "title": "FineTuneJobRead", "type": "object" }, "FineTuneJobStatus": { "enum": [ "queued", "running", "succeeded", "failed", "promoted" ], "title": "FineTuneJobStatus", "type": "string" }, "FlowisePromoteRequest": { "description": "Request body for ``POST .../flowise/chatflows/{chatflow_id}/promote``.", "properties": { "agent_name": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "description": "Display name for the promoted agent. Defaults to the chatflow name.", "title": "Agent Name" }, "agent_slug": { "anyOf": [ { "maxLength": 60, "pattern": "^[a-z0-9][a-z0-9-]*$", "type": "string" }, { "type": "null" } ], "description": "URL-safe slug. Defaults to a slugified version of the chatflow name.", "title": "Agent Slug" }, "overwrite": { "default": true, "description": "If True (the default), overwrite the agent repo's seed Agent.md / Soul.md / main.py with the translated chatflow output. Set False to keep any pre-existing files in place \u2014 useful when re-running promotion against an agent whose source has already been edited.", "title": "Overwrite", "type": "boolean" } }, "title": "FlowisePromoteRequest", "type": "object" }, "FlowisePromoteResponse": { "description": "Response from a successful chatflow promotion.", "properties": { "agent_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Agent Id", "type": "string" }, "agent_slug": { "title": "Agent Slug", "type": "string" }, "files_written": { "items": { "type": "string" }, "title": "Files Written", "type": "array" }, "repo_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Repo Url" } }, "required": [ "agent_id", "agent_slug", "repo_url", "files_written" ], "title": "FlowisePromoteResponse", "type": "object" }, "ForkSessionCreate": { "description": "Body for `POST /tenant/{t}/agent/{a}/sessions/{s}/fork`.\n\nBranches a **new** session from a historical message of the parent session\n``{s}`` (issue #8). The new fork references the parent's transcript up to\nand including ``fork_message_id`` (the \"cut\"), then is append-only from its\nown birth \u2014 the parent is never touched (decision #37). ``title`` is\noptional; when omitted the fork is titled after its parent. The fork\ninherits the parent's ``read_only`` flag; forking a read-only *caller*\nsession is refused (decision #32).", "properties": { "fork_message_id": { "description": "Message in the parent session to branch from (the transcript cut).", "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Fork Message Id", "type": "string" }, "title": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "title": "Title" } }, "required": [ "fork_message_id" ], "title": "ForkSessionCreate", "type": "object" }, "GitHubAppInstallRequest": { "description": "Tenant admin supplies the GitHub App installation_id after completing the\nGitHub App install flow in the browser. The API stores it on\n``tenant_identity`` (provider ``github:app``); access tokens are minted\non-demand later from the App's private key and this installation id.", "properties": { "installation_id": { "description": "GitHub App installation ID from the install callback.", "title": "Installation Id", "type": "integer" } }, "required": [ "installation_id" ], "title": "GitHubAppInstallRequest", "type": "object" }, "GitHubAppInstallResponse": { "description": "Confirmation that the GitHub App installation token was stored.", "properties": { "installation_id": { "title": "Installation Id", "type": "integer" }, "provider": { "default": "github:app", "title": "Provider", "type": "string" }, "tenant_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Tenant Id", "type": "string" } }, "required": [ "tenant_id", "installation_id" ], "title": "GitHubAppInstallResponse", "type": "object" }, "GitHubRepoWebhookCreate": { "description": "Wire a specific GitHub repo to an agent via a webhook route.", "properties": { "agent_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Agent Id", "type": "string" }, "auto_start": { "default": true, "title": "Auto Start", "type": "boolean" }, "branches": { "description": "Branch filter for push events. Empty means all branches.", "items": { "type": "string" }, "title": "Branches", "type": "array" }, "event_types": { "description": "GitHub event types to subscribe to.", "items": { "type": "string" }, "title": "Event Types", "type": "array" }, "repo_full_name": { "description": "GitHub repo in owner/repo format.", "examples": [ "octocat/Hello-World" ], "title": "Repo Full Name", "type": "string" } }, "required": [ "agent_id", "repo_full_name" ], "title": "GitHubRepoWebhookCreate", "type": "object" }, "GitHubRepoWebhookRead": { "description": "Webhook route enriched with GitHub-specific filter data.", "properties": { "agent_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Agent Id", "type": "string" }, "auto_start": { "title": "Auto Start", "type": "boolean" }, "branches": { "items": { "type": "string" }, "title": "Branches", "type": "array" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "event_types": { "items": { "type": "string" }, "title": "Event Types", "type": "array" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "is_active": { "title": "Is Active", "type": "boolean" }, "path_token": { "title": "Path Token", "type": "string" }, "provider": { "title": "Provider", "type": "string" }, "repo_full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Repo Full Name" }, "tenant_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Tenant Id", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "tenant_id", "agent_id", "provider", "path_token", "is_active", "auto_start", "created_at", "updated_at" ], "title": "GitHubRepoWebhookRead", "type": "object" }, "GitHubWebhookEventRead": { "description": "Read-only view of a GitHub webhook delivery (dedup table row).", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action" }, "delivery_id": { "title": "Delivery Id", "type": "string" }, "event_type": { "title": "Event Type", "type": "string" }, "processed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Processed At" }, "received_at": { "format": "date-time", "title": "Received At", "type": "string" }, "ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ref" }, "repo_full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Repo Full Name" }, "route_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Route Id", "type": "string" } }, "required": [ "delivery_id", "route_id", "event_type", "received_at" ], "title": "GitHubWebhookEventRead", "type": "object" }, "GoalCreate": { "description": "Body for ``PUT /tenant/{t}/sessions/{s}/goal`` (decision #16, issue #616).\n\nOnly a USER sets a goal. Every field here is user intent; **nothing\nbudget- or counter-shaped that the server computes is accepted**. In\nparticular ``goal_continuations`` / ``goal_status`` / ``tokens_used`` are not\nfields on this model, so a client that smuggles them in the body is ignored\n(``extra`` defaults to ignore) \u2014 the server owns the counters. See\ndocs/content/goals-and-planning.md \u00a7 7.", "properties": { "deadline_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Deadline At" }, "max_continuations": { "maximum": 1000.0, "minimum": 1.0, "title": "Max Continuations", "type": "integer" }, "objective": { "maxLength": 4000, "minLength": 1, "title": "Objective", "type": "string" }, "token_budget": { "anyOf": [ { "exclusiveMinimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Token Budget" } }, "required": [ "objective", "max_continuations" ], "title": "GoalCreate", "type": "object" }, "GoalRead": { "description": "The server-authoritative goal state for a session (issue #616).\n\n``tokens_used`` is always computed server-side from ``model_usage`` \u2014 the\nfigure a client sees is the one the continuation budget gate enforces.", "properties": { "continuations": { "title": "Continuations", "type": "integer" }, "deadline_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Deadline At" }, "ended_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Ended At" }, "max_continuations": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Continuations" }, "objective": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Objective" }, "started_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Started At" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "token_budget": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Token Budget" }, "tokens_used": { "title": "Tokens Used", "type": "integer" } }, "required": [ "objective", "status", "token_budget", "max_continuations", "deadline_at", "continuations", "tokens_used", "started_at", "ended_at" ], "title": "GoalRead", "type": "object" }, "GroupManagerRead": { "properties": { "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "label": { "title": "Label", "type": "string" }, "user_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "User Id", "type": "string" } }, "required": [ "user_id", "label" ], "title": "GroupManagerRead", "type": "object" }, "GroupMemberAdd": { "properties": { "member_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Member Id", "type": "string" }, "member_kind": { "enum": [ "user", "agent" ], "title": "Member Kind", "type": "string" } }, "required": [ "member_kind", "member_id" ], "title": "GroupMemberAdd", "type": "object" }, "GroupMemberRead": { "properties": { "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "label": { "title": "Label", "type": "string" }, "member_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Member Id", "type": "string" }, "member_kind": { "enum": [ "user", "agent" ], "title": "Member Kind", "type": "string" } }, "required": [ "member_kind", "member_id", "label" ], "title": "GroupMemberRead", "type": "object" }, "GuardrailModelOptionsRead": { "description": "Response schema for GET /agents/guardrail-model-options (issue #2321).\n\nReturns the enumerated set of valid model IDs for each per-agent override\nsurfaced by ``agent_proxy_config``: Prompt Guard, Llama Guard, and the\nembedding model used for memory / tool / skill context assembly. Seeded\nfrom the proxy's hardcoded defaults; extended by broker-registered\nvariants once a capability marker is available on the ``model`` table.\nComboboxes in the agent settings Guardrails section source from this list\nwhile still allowing free-form entry for forward-compat.", "properties": { "embedding": { "items": { "type": "string" }, "title": "Embedding", "type": "array" }, "llama_guard": { "items": { "type": "string" }, "title": "Llama Guard", "type": "array" }, "prompt_guard": { "items": { "type": "string" }, "title": "Prompt Guard", "type": "array" } }, "required": [ "prompt_guard", "llama_guard", "embedding" ], "title": "GuardrailModelOptionsRead", "type": "object" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "title": "Detail", "type": "array" } }, "title": "HTTPValidationError", "type": "object" }, "HfDownloadRead": { "properties": { "bytes_downloaded": { "title": "Bytes Downloaded", "type": "integer" }, "bytes_total": { "title": "Bytes Total", "type": "integer" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "filename": { "title": "Filename", "type": "string" }, "gcs_uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gcs Uri" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "model_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Model Id" }, "repo_id": { "title": "Repo Id", "type": "string" }, "requested_by": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Requested By" }, "revision": { "title": "Revision", "type": "string" }, "state": { "title": "State", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "repo_id", "revision", "filename", "state", "bytes_downloaded", "bytes_total", "gcs_uri", "error", "model_id", "requested_by", "created_at", "updated_at" ], "title": "HfDownloadRead", "type": "object" }, "HfPullRequest": { "properties": { "filename": { "maxLength": 512, "minLength": 1, "title": "Filename", "type": "string" }, "license_acknowledged": { "default": false, "title": "License Acknowledged", "type": "boolean" }, "repo_id": { "maxLength": 256, "minLength": 1, "title": "Repo Id", "type": "string" }, "revision": { "default": "main", "maxLength": 128, "title": "Revision", "type": "string" } }, "required": [ "repo_id", "filename" ], "title": "HfPullRequest", "type": "object" }, "HfRepoDetail": { "properties": { "author": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author" }, "gated": { "default": false, "title": "Gated", "type": "boolean" }, "gguf_files": { "items": { "$ref": "#/components/schemas/HfRepoFile" }, "title": "Gguf Files", "type": "array" }, "license": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "License" }, "repo_id": { "title": "Repo Id", "type": "string" }, "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" } }, "required": [ "repo_id" ], "title": "HfRepoDetail", "type": "object" }, "HfRepoFile": { "properties": { "filename": { "title": "Filename", "type": "string" }, "quantization": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Quantization" }, "size_bytes": { "title": "Size Bytes", "type": "integer" } }, "required": [ "filename", "size_bytes" ], "title": "HfRepoFile", "type": "object" }, "HfSearchResultItem": { "properties": { "author": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author" }, "downloads": { "default": 0, "title": "Downloads", "type": "integer" }, "last_modified": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Modified" }, "license": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "License" }, "likes": { "default": 0, "title": "Likes", "type": "integer" }, "pipeline_tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pipeline Tag" }, "repo_id": { "title": "Repo Id", "type": "string" }, "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" } }, "required": [ "repo_id" ], "title": "HfSearchResultItem", "type": "object" }, "IdeEligibility": { "description": "Can this caller open the IDE here, and in what state is it?\n\nExists so the front-end can gate its controls on a server-supplied\n*attribute* rather than on \"a session exists\" \u2014 and so it can do that\nwithout opening a session, which would mint a credential as a side effect\nof rendering a page.", "properties": { "allowance_blocked": { "default": false, "title": "Allowance Blocked", "type": "boolean" }, "allowance_minutes": { "default": 0, "title": "Allowance Minutes", "type": "integer" }, "eligible": { "title": "Eligible", "type": "boolean" }, "ide_kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ide Kind" }, "overage_enabled": { "default": false, "title": "Overage Enabled", "type": "boolean" }, "preferred_kind": { "title": "Preferred Kind", "type": "string" }, "reason": { "enum": [ "owner", "owner_no_ssh_key", "granted", "not_granted", "not_in_plan" ], "title": "Reason", "type": "string" }, "session_open": { "default": false, "title": "Session Open", "type": "boolean" }, "used_minutes": { "default": 0, "title": "Used Minutes", "type": "integer" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Username" } }, "required": [ "eligible", "preferred_kind" ], "title": "IdeEligibility", "type": "object" }, "IdeMountCreate": { "description": "Mount one thing. Exactly what the user clicked 'edit' on, nothing else.", "properties": { "kind": { "enum": [ "skill", "monorepo" ], "title": "Kind", "type": "string" }, "skill_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Skill Id" } }, "required": [ "kind" ], "title": "IdeMountCreate", "type": "object" }, "IdeMountRead": { "properties": { "kind": { "title": "Kind", "type": "string" }, "name": { "title": "Name", "type": "string" }, "path": { "title": "Path", "type": "string" }, "read_only": { "default": false, "title": "Read Only", "type": "boolean" } }, "required": [ "kind", "name", "path" ], "title": "IdeMountRead", "type": "object" }, "IdeMountsRead": { "properties": { "mounts": { "items": { "$ref": "#/components/schemas/IdeMountRead" }, "title": "Mounts", "type": "array" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "workspace_file": { "title": "Workspace File", "type": "string" } }, "required": [ "workspace_file" ], "title": "IdeMountsRead", "type": "object" }, "IdeOverageRead": { "description": "Web-IDE allowance + the overage add-on switch (#337).\n\nSame numbers as ``dev_env_ide_usage.allowance_state`` \u2014 the window the\nallowance is *enforced* against, so what the admin sees is what gates.", "properties": { "allowance_minutes": { "title": "Allowance Minutes", "type": "integer" }, "blocked": { "title": "Blocked", "type": "boolean" }, "overage_enabled": { "title": "Overage Enabled", "type": "boolean" }, "overage_entitled": { "title": "Overage Entitled", "type": "boolean" }, "remaining_minutes": { "title": "Remaining Minutes", "type": "integer" }, "used_minutes": { "title": "Used Minutes", "type": "integer" }, "window": { "$ref": "#/components/schemas/UsageWindow" } }, "required": [ "overage_enabled", "overage_entitled", "used_minutes", "allowance_minutes", "remaining_minutes", "blocked", "window" ], "title": "IdeOverageRead", "type": "object" }, "IdeOverageUpdate": { "description": "The one caller-settable field. Anything else in the body is ignored \u2014\nthe tenant comes from the path, the actor from the request context.", "properties": { "enabled": { "title": "Enabled", "type": "boolean" } }, "required": [ "enabled" ], "title": "IdeOverageUpdate", "type": "object" }, "IdeSessionOpen": { "description": "Open (or re-attach to) an IDE session.\n\n``ide_kind`` also **persists** as the caller's preference when supplied, so\nthe next environment they create opens in the editor they chose.", "properties": { "ide_kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ide Kind" } }, "title": "IdeSessionOpen", "type": "object" }, "IdeSessionRead": { "properties": { "ide_kind": { "title": "Ide Kind", "type": "string" }, "preferred_kind": { "title": "Preferred Kind", "type": "string" }, "restart_required": { "title": "Restart Required", "type": "boolean" }, "session_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Session Id", "type": "string" }, "username": { "title": "Username", "type": "string" }, "workspace_file": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace File" } }, "required": [ "session_id", "username", "ide_kind", "preferred_kind", "restart_required" ], "title": "IdeSessionRead", "type": "object" }, "IdentityProviderCreate": { "properties": { "alias": { "description": "Tenant-visible alias. The realm-wide alias is namespaced as tenant--.", "maxLength": 40, "minLength": 2, "pattern": "^[a-z0-9][a-z0-9-]{0,38}[a-z0-9]$", "title": "Alias", "type": "string" }, "config": { "title": "Config", "type": "object" }, "display_name": { "maxLength": 128, "minLength": 1, "title": "Display Name", "type": "string" }, "enabled": { "default": true, "title": "Enabled", "type": "boolean" }, "provider_id": { "enum": [ "oidc", "saml", "google", "microsoft", "github" ], "title": "Provider Id", "type": "string" } }, "required": [ "alias", "provider_id", "display_name" ], "title": "IdentityProviderCreate", "type": "object" }, "IdentityProviderRead": { "description": "Returned to API callers. Hides the ``tenant--`` alias prefix.\n\n``provider_id`` is a plain ``str`` here (vs the ``ProviderId`` Literal on\ncreate/update) so an unrecognised ``providerId`` from Keycloak \u2014 e.g. an\nIdP created directly in the realm or a provider type added later \u2014 does\nnot 500 the read path. The Literal still gates writes.", "properties": { "alias": { "title": "Alias", "type": "string" }, "config": { "title": "Config", "type": "object" }, "display_name": { "title": "Display Name", "type": "string" }, "enabled": { "title": "Enabled", "type": "boolean" }, "provider_id": { "title": "Provider Id", "type": "string" } }, "required": [ "alias", "provider_id", "display_name", "enabled", "config" ], "title": "IdentityProviderRead", "type": "object" }, "IdentityProviderUpdate": { "properties": { "config": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Config" }, "display_name": { "anyOf": [ { "maxLength": 128, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" } }, "title": "IdentityProviderUpdate", "type": "object" }, "ImpersonateTenantResponse": { "description": "Response payload for ``POST /admin/tenants/{tenant_id}/impersonate``.\n\nThe client navigates to ``redirect_url`` after the active-tenant cookie is set.", "properties": { "redirect_url": { "title": "Redirect Url", "type": "string" } }, "required": [ "redirect_url" ], "title": "ImpersonateTenantResponse", "type": "object" }, "InstallLinkResponse": { "description": "The GitHub App install URL carrying a single-use ``state``.", "properties": { "url": { "title": "Url", "type": "string" } }, "required": [ "url" ], "title": "InstallLinkResponse", "type": "object" }, "InstallStatusResponse": { "description": "Whether the tenant has the platform GitHub App connected.", "properties": { "connected": { "title": "Connected", "type": "boolean" }, "installation_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Installation Id" } }, "required": [ "connected" ], "title": "InstallStatusResponse", "type": "object" }, "InviteCreate": { "properties": { "email": { "format": "email", "title": "Email", "type": "string" }, "role": { "default": "MEMBER", "title": "Role", "type": "string" } }, "required": [ "email" ], "title": "InviteCreate", "type": "object" }, "InviteCreated": { "properties": { "created": { "title": "Created", "type": "boolean" }, "role": { "title": "Role", "type": "string" }, "tenant_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Tenant Id", "type": "string" }, "user_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "User Id", "type": "string" } }, "required": [ "user_id", "tenant_id", "role", "created" ], "title": "InviteCreated", "type": "object" }, "InviteTenantAdminRequest": { "properties": { "email": { "format": "email", "title": "Email", "type": "string" } }, "required": [ "email" ], "title": "InviteTenantAdminRequest", "type": "object" }, "JsonObject": { "description": "Arbitrary JSON object. Mirrors `dict[str, Any]` on the Python side; codegen emits a model class with no required fields.", "type": "object" }, "KahalaGrantCreate": { "description": "Body for ``POST /tenant/{tenant_id}/agents/{agent_id}/kahala-grants``.", "properties": { "tier": { "$ref": "#/components/schemas/KahalaGrantTier", "default": "suggest", "description": "Access tier: 'read' < 'suggest' < 'write' < 'modify_structure', each including the ones below it. Defaults to 'suggest' (the agent proposes edits for a human to accept). Re-granting the same scope with a different tier changes it." }, "wiki_slug": { "anyOf": [ { "maxLength": 256, "type": "string" }, { "type": "null" } ], "description": "Kahala wiki slug to narrow this grant to. Omit (or null) to grant access to every wiki in this tenant.", "title": "Wiki Slug" } }, "title": "KahalaGrantCreate", "type": "object" }, "KahalaGrantRead": { "description": "One grant row as returned to an admin.", "properties": { "agent_id": { "title": "Agent Id", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "granted_by_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Granted By User Id" }, "id": { "title": "Id", "type": "string" }, "revoked_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Revoked At" }, "tenant_id": { "title": "Tenant Id", "type": "string" }, "tier": { "title": "Tier", "type": "string" }, "wiki_slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Wiki Slug" } }, "required": [ "id", "tenant_id", "agent_id", "wiki_slug", "tier", "granted_by_user_id", "revoked_at", "created_at" ], "title": "KahalaGrantRead", "type": "object" }, "KahalaGrantTier": { "description": "The four grant tiers, low \u2192 high. ``str`` mix-in so a value serialises\nas its name and compares equal to the stored column string.", "enum": [ "read", "suggest", "write", "modify_structure" ], "title": "KahalaGrantTier", "type": "string" }, "KahalaWikiListResponse": { "description": "``GET /tenant/{tenant_id}/kahala/wikis`` \u2014 wrapped for later pagination.", "properties": { "wikis": { "items": { "$ref": "#/components/schemas/KahalaWikiOption" }, "title": "Wikis", "type": "array" } }, "required": [ "wikis" ], "title": "KahalaWikiListResponse", "type": "object" }, "KahalaWikiOption": { "description": "One wiki in a tenant's Kahala registry, as the grant typeahead shows it.", "properties": { "is_default": { "default": false, "title": "Is Default", "type": "boolean" }, "name": { "description": "Human label shown in the picker.", "title": "Name", "type": "string" }, "slug": { "description": "Submitted value \u2014 what a grant's `wiki_slug` stores.", "title": "Slug", "type": "string" } }, "required": [ "slug", "name" ], "title": "KahalaWikiOption", "type": "object" }, "LangflowInstanceRead": { "properties": { "entry_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entry Path" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message" }, "status": { "title": "Status", "type": "string" } }, "required": [ "status" ], "title": "LangflowInstanceRead", "type": "object" }, "LangflowPromoteRequest": { "description": "Request body for ``POST .../langflow/flows/{flow_id}/promote``.\n\n``flow_data`` is the raw flow export JSON \u2014 the shape\n``GET /api/v1/flows/{id}`` returns on a tenant's Langflow instance. The\nAPI has no standing credential to fetch it itself (unlike Flowise's\nstored workspace API key \u2014 see ``docs/content/langflow.md``'s \"Known\ngap\"), so the caller (the front-end, already holding an authenticated\nproxied session to the instance) fetches it and posts it here.", "properties": { "agent_name": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "description": "Display name for the promoted agent. Defaults to the flow name.", "title": "Agent Name" }, "agent_slug": { "anyOf": [ { "maxLength": 60, "pattern": "^[a-z0-9][a-z0-9-]*$", "type": "string" }, { "type": "null" } ], "description": "URL-safe slug. Defaults to a slugified version of the flow name.", "title": "Agent Slug" }, "flow_data": { "description": "Raw Langflow flow export JSON, as returned by the tenant's Langflow instance's GET /api/v1/flows/{flow_id}.", "title": "Flow Data", "type": "object" }, "overwrite": { "default": true, "description": "If True (the default), overwrite the agent repo's seed Agent.md / Soul.md / main.py with the translated flow output. Set False to keep any pre-existing files in place \u2014 useful when re-running promotion against an agent whose source has already been edited.", "title": "Overwrite", "type": "boolean" } }, "required": [ "flow_data" ], "title": "LangflowPromoteRequest", "type": "object" }, "LangflowPromoteResponse": { "description": "Response from a successful flow promotion.", "properties": { "agent_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Agent Id", "type": "string" }, "agent_slug": { "title": "Agent Slug", "type": "string" }, "files_written": { "items": { "type": "string" }, "title": "Files Written", "type": "array" }, "repo_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Repo Url" } }, "required": [ "agent_id", "agent_slug", "repo_url", "files_written" ], "title": "LangflowPromoteResponse", "type": "object" }, "LinkableProvider": { "description": "One row of the user-linkable provider catalogue. Booleans only.", "properties": { "configured": { "title": "Configured", "type": "boolean" }, "label": { "title": "Label", "type": "string" }, "slug": { "title": "Slug", "type": "string" }, "user_linkable": { "title": "User Linkable", "type": "boolean" } }, "required": [ "slug", "label", "configured", "user_linkable" ], "title": "LinkableProvider", "type": "object" }, "LinkedIdentityPurpose": { "enum": [ "tool", "auth_mirror" ], "title": "LinkedIdentityPurpose", "type": "string" }, "LinkedIdentityRead": { "description": "Public projection of a ``linked_identity`` row. Never includes tokens.", "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "display_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Label" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "id": { "title": "Id", "type": "string" }, "needs_relink": { "default": false, "title": "Needs Relink", "type": "boolean" }, "provider": { "title": "Provider", "type": "string" }, "provider_subject": { "title": "Provider Subject", "type": "string" }, "purpose": { "$ref": "#/components/schemas/LinkedIdentityPurpose" }, "scopes": { "items": { "type": "string" }, "title": "Scopes", "type": "array" } }, "required": [ "id", "provider", "provider_subject", "display_label", "purpose", "scopes", "expires_at", "created_at" ], "title": "LinkedIdentityRead", "type": "object" }, "LinkedRepoCreate": { "properties": { "branch": { "maxLength": 255, "minLength": 1, "title": "Branch", "type": "string" }, "linked_identity_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Linked Identity Id" }, "remote_url": { "maxLength": 2048, "minLength": 1, "title": "Remote Url", "type": "string" } }, "required": [ "remote_url", "branch" ], "title": "LinkedRepoCreate", "type": "object" }, "LinkedRepoListResponse": { "properties": { "repos": { "items": { "$ref": "#/components/schemas/LinkedRepoRead" }, "title": "Repos", "type": "array" } }, "required": [ "repos" ], "title": "LinkedRepoListResponse", "type": "object" }, "LinkedRepoRead": { "properties": { "branch": { "title": "Branch", "type": "string" }, "chunk_count": { "title": "Chunk Count", "type": "integer" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message" }, "file_count": { "title": "File Count", "type": "integer" }, "id": { "title": "Id", "type": "string" }, "last_ingested_sha": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Ingested Sha" }, "remote_url": { "title": "Remote Url", "type": "string" }, "status": { "title": "Status", "type": "string" }, "truncated": { "title": "Truncated", "type": "boolean" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "remote_url", "branch", "status", "file_count", "chunk_count", "truncated", "created_at", "updated_at" ], "title": "LinkedRepoRead", "type": "object" }, "LinkedRepoWebhookCreated": { "description": "Returned only on create/rotate \u2014 includes the raw signing secret (shown once).", "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "title": "Id", "type": "string" }, "linked_repo_id": { "title": "Linked Repo Id", "type": "string" }, "secret": { "title": "Secret", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "webhook_id": { "title": "Webhook Id", "type": "string" }, "webhook_url": { "title": "Webhook Url", "type": "string" } }, "required": [ "id", "linked_repo_id", "webhook_id", "webhook_url", "created_at", "updated_at", "secret" ], "title": "LinkedRepoWebhookCreated", "type": "object" }, "LinkedRepoWebhookRead": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "title": "Id", "type": "string" }, "linked_repo_id": { "title": "Linked Repo Id", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "webhook_id": { "title": "Webhook Id", "type": "string" }, "webhook_url": { "title": "Webhook Url", "type": "string" } }, "required": [ "id", "linked_repo_id", "webhook_id", "webhook_url", "created_at", "updated_at" ], "title": "LinkedRepoWebhookRead", "type": "object" }, "ListenModeUpdate": { "description": "Body for `POST /tenant/{t}/agent/{a}/sessions/{s}/listen`.\n\nDrives the chat composer's \"listen\" toggle. `on=True` enters the silent\nloop (user messages buffer, the agent is not invoked); `on=False` exits\nand flushes the buffered messages as one combined prompt. See\ndocs/content/chat-listen-mode.md.", "properties": { "on": { "title": "On", "type": "boolean" } }, "required": [ "on" ], "title": "ListenModeUpdate", "type": "object" }, "ListingKind": { "enum": [ "skill", "agent" ], "title": "ListingKind", "type": "string" }, "ListingVisibility": { "enum": [ "public", "unlisted" ], "title": "ListingVisibility", "type": "string" }, "LoginRequest": { "properties": { "password": { "minLength": 1, "title": "Password", "type": "string" }, "username": { "minLength": 1, "title": "Username", "type": "string" } }, "required": [ "username", "password" ], "title": "LoginRequest", "type": "object" }, "LoginResponse": { "properties": { "email": { "title": "Email", "type": "string" }, "expires_in": { "title": "Expires In", "type": "integer" }, "token_type": { "title": "Token Type", "type": "string" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id" } }, "required": [ "user_id", "email", "expires_in", "token_type" ], "title": "LoginResponse", "type": "object" }, "MailboxKind": { "enum": [ "internal", "external" ], "title": "MailboxKind", "type": "string" }, "MarketplaceListingBrowse": { "description": "Lightweight projection for the public browse endpoint.", "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "currency": { "title": "Currency", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "kind": { "title": "Kind", "type": "string" }, "price_cents": { "title": "Price Cents", "type": "integer" }, "slug": { "title": "Slug", "type": "string" }, "title": { "title": "Title", "type": "string" } }, "required": [ "id", "kind", "title", "slug", "description", "price_cents", "currency", "created_at" ], "title": "MarketplaceListingBrowse", "type": "object" }, "MarketplaceListingCreate": { "description": "Body for POST /tenant/{tenant_id}/marketplace/listings.", "properties": { "currency": { "default": "USD", "title": "Currency", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "kind": { "$ref": "#/components/schemas/ListingKind" }, "price_cents": { "default": 0, "minimum": 0.0, "title": "Price Cents", "type": "integer" }, "slug": { "title": "Slug", "type": "string" }, "source_agent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Agent Id" }, "source_skill_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Skill Id" }, "title": { "title": "Title", "type": "string" }, "visibility": { "$ref": "#/components/schemas/ListingVisibility", "default": "public" } }, "required": [ "kind", "title", "slug" ], "title": "MarketplaceListingCreate", "type": "object" }, "MarketplaceListingDetail": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "currency": { "title": "Currency", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "kind": { "title": "Kind", "type": "string" }, "price_cents": { "title": "Price Cents", "type": "integer" }, "review_notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Review Notes" }, "reviewed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Reviewed At" }, "reviewer_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Reviewer Id" }, "seller_user_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Seller User Id", "type": "string" }, "slug": { "title": "Slug", "type": "string" }, "status": { "title": "Status", "type": "string" }, "tenant_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Tenant Id", "type": "string" }, "title": { "title": "Title", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "versions": { "items": { "$ref": "#/components/schemas/MarketplaceVersionRead" }, "title": "Versions", "type": "array" }, "visibility": { "title": "Visibility", "type": "string" } }, "required": [ "id", "tenant_id", "seller_user_id", "kind", "title", "slug", "description", "price_cents", "currency", "status", "visibility", "created_at", "updated_at" ], "title": "MarketplaceListingDetail", "type": "object" }, "MarketplaceListingRead": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "currency": { "title": "Currency", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "kind": { "title": "Kind", "type": "string" }, "price_cents": { "title": "Price Cents", "type": "integer" }, "review_notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Review Notes" }, "reviewed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Reviewed At" }, "reviewer_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Reviewer Id" }, "seller_user_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Seller User Id", "type": "string" }, "slug": { "title": "Slug", "type": "string" }, "status": { "title": "Status", "type": "string" }, "tenant_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Tenant Id", "type": "string" }, "title": { "title": "Title", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "visibility": { "title": "Visibility", "type": "string" } }, "required": [ "id", "tenant_id", "seller_user_id", "kind", "title", "slug", "description", "price_cents", "currency", "status", "visibility", "created_at", "updated_at" ], "title": "MarketplaceListingRead", "type": "object" }, "MarketplacePayoutRead": { "description": "Response schema for payout history.", "properties": { "amount_cents": { "title": "Amount Cents", "type": "integer" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "currency": { "title": "Currency", "type": "string" }, "id": { "title": "Id", "type": "string" }, "seller_user_id": { "title": "Seller User Id", "type": "string" }, "stripe_transfer_id": { "title": "Stripe Transfer Id", "type": "string" } }, "required": [ "id", "seller_user_id", "stripe_transfer_id", "amount_cents", "currency", "created_at" ], "title": "MarketplacePayoutRead", "type": "object" }, "MarketplaceReviewDecision": { "description": "Admin decision on a pending marketplace listing review (issue #3133).", "properties": { "decision": { "enum": [ "approved", "rejected" ], "title": "Decision", "type": "string" }, "review_notes": { "anyOf": [ { "maxLength": 2000, "type": "string" }, { "type": "null" } ], "title": "Review Notes" } }, "required": [ "decision" ], "title": "MarketplaceReviewDecision", "type": "object" }, "MarketplaceReviewResponse": { "description": "Response after a submit-review or review action.", "properties": { "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "review_notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Review Notes" }, "reviewed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Reviewed At" }, "reviewer_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Reviewer Id" }, "status": { "title": "Status", "type": "string" } }, "required": [ "id", "status", "reviewer_id", "reviewed_at", "review_notes" ], "title": "MarketplaceReviewResponse", "type": "object" }, "MarketplaceVersionRead": { "properties": { "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "listing_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Listing Id", "type": "string" }, "published_at": { "format": "date-time", "title": "Published At", "type": "string" }, "sha256": { "title": "Sha256", "type": "string" }, "version": { "title": "Version", "type": "string" } }, "required": [ "id", "listing_id", "version", "sha256", "published_at" ], "title": "MarketplaceVersionRead", "type": "object" }, "MeResponse": { "properties": { "active_tenant_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Active Tenant Id" }, "email_verified": { "default": false, "title": "Email Verified", "type": "boolean" }, "is_super_admin": { "title": "Is Super Admin", "type": "boolean" }, "self_serve_verified_email_required": { "default": false, "title": "Self Serve Verified Email Required", "type": "boolean" }, "user": { "$ref": "#/components/schemas/UserRead" } }, "required": [ "user", "active_tenant_id", "is_super_admin" ], "title": "MeResponse", "type": "object" }, "MemberRoleUpdate": { "properties": { "role": { "pattern": "^(ADMIN|MEMBER|GUEST)$", "title": "Role", "type": "string" } }, "required": [ "role" ], "title": "MemberRoleUpdate", "type": "object" }, "MemoryCitation": { "description": "``ctx.memory.cite`` response \u2014 full memory record + optional transcript.\n\nReturned by ``GET /api/internal/sessions/{s}/memory/{memory_id}``. The\n``source_message`` field is populated when the memory was written with a\n``source_message_id`` AND the target transcript row is still visible to\nthe calling session (cross-session reads return ``source_message=None``\nrather than 403 so the citation chain degrades gracefully).", "properties": { "content": { "title": "Content", "type": "string" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "id": { "title": "Id", "type": "string" }, "kind": { "title": "Kind", "type": "string" }, "session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Session Id" }, "source_message": { "anyOf": [ { "$ref": "#/components/schemas/TranscriptTurn" }, { "type": "null" } ] }, "source_message_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Message Id" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id" } }, "required": [ "id", "content", "kind" ], "title": "MemoryCitation", "type": "object" }, "MemoryConflictListResponse": { "properties": { "conflicts": { "items": { "$ref": "#/components/schemas/MemoryConflictRead" }, "title": "Conflicts", "type": "array" } }, "required": [ "conflicts" ], "title": "MemoryConflictListResponse", "type": "object" }, "MemoryConflictRead": { "description": "A dream-cycle-detected pair of contradictory memories.\n\nMirrors ``models.agent_memory_conflict.AgentMemoryConflict`` minus\nthe FK columns. Used by both the tenant-admin route\n(``GET /tenant/{t}/agent/{a}/conflicts``) and the agent-side\ninternal route (``GET /sessions/{s}/memory/conflicts``).", "properties": { "detected_at": { "format": "date-time", "title": "Detected At", "type": "string" }, "id": { "title": "Id", "type": "string" }, "memory_a_id": { "title": "Memory A Id", "type": "string" }, "memory_b_id": { "title": "Memory B Id", "type": "string" }, "resolution": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Resolution" }, "resolved_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Resolved At" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Summary" } }, "required": [ "id", "memory_a_id", "memory_b_id", "detected_at" ], "title": "MemoryConflictRead", "type": "object" }, "MemoryConflictResolve": { "description": "Body for ``POST .../conflicts/{id}/resolve``.\n\n``keep`` must be one of the conflict's two memory ids; the loser is\ndropped from Valkey and the conflict row is marked resolved with\n``resolution = {\"kept\": , \"dropped\": , \"reason\": }``.", "properties": { "keep": { "maxLength": 128, "minLength": 1, "title": "Keep", "type": "string" }, "reason": { "maxLength": 2000, "minLength": 1, "title": "Reason", "type": "string" } }, "required": [ "keep", "reason" ], "title": "MemoryConflictResolve", "type": "object" }, "MemoryExportResponse": { "description": "Response from ``POST /tenant/{t}/agent/{a}/memory/export``.\n\nThe export lands at ``gcs_uri`` (per-agent workspace folder, decision\n#11). ``download_url`` is a short-lived V4 signed URL \u2014 None in\nenvironments where signing isn't wired (local kind), so the UI falls\nback to the ``gs://`` URI for direct access from the cluster.", "properties": { "download_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Download Url" }, "exported": { "title": "Exported", "type": "integer" }, "gcs_uri": { "title": "Gcs Uri", "type": "string" }, "include_embeddings": { "title": "Include Embeddings", "type": "boolean" } }, "required": [ "gcs_uri", "exported", "include_embeddings" ], "title": "MemoryExportResponse", "type": "object" }, "MemoryImportRequest": { "description": "JSON body for ``POST /tenant/{t}/agent/{a}/memory/import-from-gcs``.\n\nThe ``/import`` endpoint is multipart-only \u2014 its ``gcs_uri`` is\naccepted as a form field alongside the optional ``file`` upload. This\nschema is the dedicated JSON entry point that re-imports an existing\nexport (e.g. service-to-service callers that already have the\n``gs://`` URI of a prior export).", "properties": { "gcs_uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gcs Uri" } }, "title": "MemoryImportRequest", "type": "object" }, "MemoryImportResponse": { "description": "Counts for ``POST /tenant/{t}/agent/{a}/memory/import``.\n\n``scanned`` is the number of JSONL rows the schema validator looked at;\n``imported`` is the subset that landed in Valkey; ``skipped`` is\nwell-formed rows the caller filtered out (e.g. duplicate ids); and\n``failed`` is rows that broke schema or re-embedding.", "properties": { "failed": { "title": "Failed", "type": "integer" }, "imported": { "title": "Imported", "type": "integer" }, "scanned": { "title": "Scanned", "type": "integer" }, "skipped": { "title": "Skipped", "type": "integer" } }, "required": [ "scanned", "imported", "skipped", "failed" ], "title": "MemoryImportResponse", "type": "object" }, "MemorySummaryRead": { "properties": { "agent_id": { "title": "Agent Id", "type": "string" }, "as_of": { "format": "date-time", "title": "As Of", "type": "string" }, "generated_from_count": { "title": "Generated From Count", "type": "integer" }, "summary_markdown": { "title": "Summary Markdown", "type": "string" } }, "required": [ "agent_id", "summary_markdown", "as_of", "generated_from_count" ], "title": "MemorySummaryRead", "type": "object" }, "MemorySummaryUpdate": { "properties": { "summary_markdown": { "maxLength": 50000, "minLength": 1, "title": "Summary Markdown", "type": "string" } }, "required": [ "summary_markdown" ], "title": "MemorySummaryUpdate", "type": "object" }, "MentionItem": { "description": "A single resolved mention inside a chat message.", "properties": { "display": { "description": "Human-readable label shown in the chip", "minLength": 1, "title": "Display", "type": "string" }, "id": { "description": "CUID (agent/user) or Slack channel id", "minLength": 1, "title": "Id", "type": "string" }, "type": { "$ref": "#/components/schemas/MentionType" } }, "required": [ "type", "id", "display" ], "title": "MentionItem", "type": "object" }, "MentionType": { "enum": [ "agent", "user", "slack_channel" ], "title": "MentionType", "type": "string" }, "MergeCallbackRequest": { "properties": { "category": { "examples": [ "hris" ], "title": "Category", "type": "string" }, "public_token": { "title": "Public Token", "type": "string" } }, "required": [ "public_token", "category" ], "title": "MergeCallbackRequest", "type": "object" }, "MergeCallbackResponse": { "properties": { "external_account_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Account Id" }, "provider": { "title": "Provider", "type": "string" } }, "required": [ "provider" ], "title": "MergeCallbackResponse", "type": "object" }, "MergeLinkTokenRequest": { "properties": { "category": { "examples": [ "hris", "accounting", "crm" ], "title": "Category", "type": "string" }, "email": { "anyOf": [ { "format": "email", "type": "string" }, { "type": "null" } ], "title": "Email" }, "organization_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization Name" } }, "required": [ "category" ], "title": "MergeLinkTokenRequest", "type": "object" }, "MergeLinkTokenResponse": { "properties": { "integration": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Integration" }, "link_token": { "title": "Link Token", "type": "string" } }, "required": [ "link_token" ], "title": "MergeLinkTokenResponse", "type": "object" }, "MessageContentText": { "properties": { "text": { "title": "Text", "type": "object" }, "type": { "const": "text", "title": "Type", "type": "string" } }, "required": [ "text" ], "title": "MessageContentText", "type": "object" }, "MessageCreateRequest": { "properties": { "content": { "title": "Content", "type": "string" }, "metadata": { "title": "Metadata", "type": "object" }, "role": { "enum": [ "user", "assistant" ], "title": "Role", "type": "string" } }, "required": [ "content" ], "title": "MessageCreateRequest", "type": "object" }, "MessageFeedbackCreate": { "description": "Body for POST .../messages/{message_id}/feedback.", "properties": { "rating": { "enum": [ -1, 1 ], "title": "Rating", "type": "integer" } }, "required": [ "rating" ], "title": "MessageFeedbackCreate", "type": "object" }, "MessageFeedbackRead": { "properties": { "agent_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Agent Id", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "message_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Message Id", "type": "string" }, "rating": { "title": "Rating", "type": "integer" }, "session_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Session Id", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "user_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "User Id", "type": "string" } }, "required": [ "id", "message_id", "session_id", "agent_id", "user_id", "rating", "created_at", "updated_at" ], "title": "MessageFeedbackRead", "type": "object" }, "MessageList": { "properties": { "data": { "items": { "$ref": "#/components/schemas/MessageObject" }, "title": "Data", "type": "array" }, "first_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First Id" }, "has_more": { "default": false, "title": "Has More", "type": "boolean" }, "last_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Id" }, "object": { "const": "list", "title": "Object", "type": "string" } }, "required": [ "data" ], "title": "MessageList", "type": "object" }, "MessageObject": { "properties": { "assistant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assistant Id" }, "content": { "items": { "$ref": "#/components/schemas/MessageContentText" }, "title": "Content", "type": "array" }, "created_at": { "title": "Created At", "type": "integer" }, "id": { "title": "Id", "type": "string" }, "metadata": { "title": "Metadata", "type": "object" }, "object": { "const": "thread.message", "title": "Object", "type": "string" }, "role": { "title": "Role", "type": "string" }, "run_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Run Id" }, "thread_id": { "title": "Thread Id", "type": "string" } }, "required": [ "id", "created_at", "thread_id", "role", "content" ], "title": "MessageObject", "type": "object" }, "ModelConflictRead": { "properties": { "display_name": { "title": "Display Name", "type": "string" }, "model_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Model Id", "type": "string" } }, "required": [ "model_id", "display_name" ], "title": "ModelConflictRead", "type": "object" }, "ModelCreate": { "properties": { "config": { "title": "Config", "type": "object" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "kind": { "enum": [ "local", "openrouter", "anthropic", "openai", "google", "mistral", "cohere", "custom_http", "bedrock", "ifm" ], "title": "Kind", "type": "string" }, "name": { "maxLength": 128, "minLength": 1, "title": "Name", "type": "string" }, "pricing": { "title": "Pricing", "type": "object" } }, "required": [ "name", "kind" ], "title": "ModelCreate", "type": "object" }, "ModelCredentialRead": { "description": "Metadata for one model-provider BYOK slot. Never carries the key.", "properties": { "configured": { "title": "Configured", "type": "boolean" }, "provider": { "title": "Provider", "type": "string" }, "vendor": { "title": "Vendor", "type": "string" } }, "required": [ "vendor", "provider", "configured" ], "title": "ModelCredentialRead", "type": "object" }, "ModelCredentialSet": { "description": "Body for setting / rotating a vendor's BYOK key.\n\nOnly ``api_key`` is accepted \u2014 the vendor comes from the path and the\ntenant from the path (Casbin-verified membership). Any other field a\ncaller smuggles in (``tenant_id``, ``provider``, ``is_super_admin``, \u2026)\nis ignored by construction (mass-assignment defense).", "properties": { "api_key": { "minLength": 1, "title": "Api Key", "type": "string" } }, "required": [ "api_key" ], "title": "ModelCredentialSet", "type": "object" }, "ModelEndpointCreate": { "description": "Register a new self-hosted model endpoint.", "properties": { "api_key": { "anyOf": [ { "maxLength": 512, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Api Key" }, "context_window": { "default": 4096, "minimum": 1.0, "title": "Context Window", "type": "integer" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "endpoint_url": { "maxLength": 512, "minLength": 1, "title": "Endpoint Url", "type": "string" }, "input_cost_per_1k": { "default": 0.0, "minimum": 0.0, "title": "Input Cost Per 1K", "type": "number" }, "name": { "maxLength": 128, "minLength": 1, "title": "Name", "type": "string" }, "output_cost_per_1k": { "default": 0.0, "minimum": 0.0, "title": "Output Cost Per 1K", "type": "number" }, "supports_streaming": { "default": false, "title": "Supports Streaming", "type": "boolean" }, "supports_tools": { "default": false, "title": "Supports Tools", "type": "boolean" }, "supports_vision": { "default": false, "title": "Supports Vision", "type": "boolean" } }, "required": [ "name", "endpoint_url" ], "title": "ModelEndpointCreate", "type": "object" }, "ModelEndpointHealthResult": { "description": "Result of a health check against a self-hosted endpoint.", "properties": { "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "latency_ms": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Latency Ms" }, "model_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Model Id", "type": "string" }, "reachable": { "title": "Reachable", "type": "boolean" } }, "required": [ "model_id", "reachable" ], "title": "ModelEndpointHealthResult", "type": "object" }, "ModelEndpointRead": { "description": "Response for a self-hosted model endpoint. ``api_key`` is never returned.", "properties": { "context_window": { "title": "Context Window", "type": "integer" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "endpoint_url": { "title": "Endpoint Url", "type": "string" }, "health_checked_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Health Checked At" }, "health_latency_ms": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Health Latency Ms" }, "health_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Health Status" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "input_cost_per_1k": { "title": "Input Cost Per 1K", "type": "number" }, "name": { "title": "Name", "type": "string" }, "output_cost_per_1k": { "title": "Output Cost Per 1K", "type": "number" }, "status": { "title": "Status", "type": "string" }, "supports_streaming": { "title": "Supports Streaming", "type": "boolean" }, "supports_tools": { "title": "Supports Tools", "type": "boolean" }, "supports_vision": { "title": "Supports Vision", "type": "boolean" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "name", "description", "endpoint_url", "status", "input_cost_per_1k", "output_cost_per_1k", "context_window", "supports_tools", "supports_vision", "supports_streaming", "created_at", "updated_at" ], "title": "ModelEndpointRead", "type": "object" }, "ModelEndpointUpdate": { "description": "Partial update of a self-hosted model endpoint.", "properties": { "api_key": { "anyOf": [ { "maxLength": 512, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Api Key" }, "context_window": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Context Window" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "endpoint_url": { "anyOf": [ { "maxLength": 512, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Endpoint Url" }, "input_cost_per_1k": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "type": "null" } ], "title": "Input Cost Per 1K" }, "name": { "anyOf": [ { "maxLength": 128, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Name" }, "output_cost_per_1k": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "type": "null" } ], "title": "Output Cost Per 1K" }, "supports_streaming": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Supports Streaming" }, "supports_tools": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Supports Tools" }, "supports_vision": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Supports Vision" } }, "title": "ModelEndpointUpdate", "type": "object" }, "ModelRead": { "properties": { "available_to_all_tenants": { "default": false, "title": "Available To All Tenants", "type": "boolean" }, "config": { "title": "Config", "type": "object" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "endpoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Endpoint" }, "failover_chain": { "items": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, "title": "Failover Chain", "type": "array" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "is_free": { "title": "Is Free", "type": "boolean" }, "is_system_default": { "default": false, "title": "Is System Default", "type": "boolean" }, "kind": { "title": "Kind", "type": "string" }, "name": { "title": "Name", "type": "string" }, "owner_user_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Owner User Id", "type": "string" }, "owning_tenant_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Owning Tenant Id" }, "pricing": { "title": "Pricing", "type": "object" }, "status": { "title": "Status", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "owner_user_id", "name", "description", "kind", "status", "is_free", "config", "pricing", "endpoint", "created_at", "updated_at" ], "title": "ModelRead", "type": "object" }, "ModelUpdate": { "properties": { "config": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Config" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "name": { "anyOf": [ { "maxLength": 128, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Name" }, "pricing": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Pricing" }, "status": { "anyOf": [ { "enum": [ "active", "disabled", "experimental", "deprecated" ], "type": "string" }, { "type": "null" } ], "title": "Status" } }, "title": "ModelUpdate", "type": "object" }, "NewsBotProvisionResponse": { "description": "Result of :func:`provision_newsbot_route`.", "properties": { "agent_id": { "description": "The id of the tenant's NewsBot agent.", "title": "Agent Id", "type": "string" }, "agent_slug": { "description": "Always ``newsbot`` (the fixed seed slug).", "title": "Agent Slug", "type": "string" }, "is_new": { "description": "``True`` iff this call provisioned a brand-new agent. ``False`` on a re-click, when the tenant already had a NewsBot.", "title": "Is New", "type": "boolean" } }, "required": [ "agent_id", "agent_slug", "is_new" ], "title": "NewsBotProvisionResponse", "type": "object" }, "NotificationListResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/NotificationRead" }, "title": "Items", "type": "array" }, "unread_count": { "title": "Unread Count", "type": "integer" } }, "required": [ "items", "unread_count" ], "title": "NotificationListResponse", "type": "object" }, "NotificationRead": { "properties": { "agent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agent Id" }, "agent_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agent Name" }, "body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Body" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "title": "Id", "type": "string" }, "kind": { "title": "Kind", "type": "string" }, "read_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Read At" }, "session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Session Id" }, "tenant_id": { "title": "Tenant Id", "type": "string" }, "title": { "title": "Title", "type": "string" } }, "required": [ "id", "tenant_id", "kind", "title", "created_at" ], "title": "NotificationRead", "type": "object" }, "NotificationsMarkedRead": { "properties": { "updated": { "title": "Updated", "type": "integer" } }, "required": [ "updated" ], "title": "NotificationsMarkedRead", "type": "object" }, "PendingTenantInviteRead": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "email": { "title": "Email", "type": "string" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "invited_by_user_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Invited By User Id" } }, "required": [ "id", "email", "invited_by_user_id", "created_at" ], "title": "PendingTenantInviteRead", "type": "object" }, "PersonalWorkspaceCreate": { "description": "Body for the self-serve \"create your workspace\" path (#3648).\n\nDeliberately minimal: the **only** caller-supplied field is an optional\ndisplay ``name``. Everything else that ``TenantCreate`` exposes \u2014 ``slug``,\n``plan_code``, ``billing_email``, ``seed_profile`` \u2014 is server-forced, which\nis the mass-assignment defense (CLAUDE.md security-testing): the plan is\nalways ``FREE``, the seed profile is always ``default`` (Janet + Michael),\nthe owner is always the caller, and any smuggled ``plan_id`` /\n``is_super_admin`` / ``is_platform_operator`` / ``owner_*`` / ``tenant_id``\nfield is simply not on this model and cannot reach the service.\n\n``name`` is optional so a drive-by PLG signup can create a workspace with a\nsingle click; when omitted the server derives a friendly name + slug from\nthe caller's email.", "properties": { "name": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Name" } }, "title": "PersonalWorkspaceCreate", "type": "object" }, "PlanChangeRequest": { "properties": { "plan_code": { "maxLength": 32, "minLength": 1, "title": "Plan Code", "type": "string" } }, "required": [ "plan_code" ], "title": "PlanChangeRequest", "type": "object" }, "PlanCharges": { "description": "What the tenant's plan charges this calendar month (GitLab #353).\n\nAn estimate of the month in progress from the effective plan terms\n(overrides applied) plus the ledger of metered usage already reported.\nRecurring lines are billed by the Stripe subscription; metered lines are\nreported once the month closes.", "properties": { "currency": { "title": "Currency", "type": "string" }, "estimated_total_cents": { "title": "Estimated Total Cents", "type": "integer" }, "has_subscription": { "title": "Has Subscription", "type": "boolean" }, "ide_billable_minutes": { "title": "Ide Billable Minutes", "type": "integer" }, "ide_cents": { "title": "Ide Cents", "type": "integer" }, "ide_free_minutes": { "title": "Ide Free Minutes", "type": "integer" }, "ide_overage_enabled": { "title": "Ide Overage Enabled", "type": "boolean" }, "ide_price_cents_per_user_hour": { "title": "Ide Price Cents Per User Hour", "type": "integer" }, "ide_used_minutes": { "title": "Ide Used Minutes", "type": "integer" }, "plan_code": { "title": "Plan Code", "type": "string" }, "platform_fee_cents": { "title": "Platform Fee Cents", "type": "integer" }, "reported": { "items": { "$ref": "#/components/schemas/PlanUsageReportRead" }, "title": "Reported", "type": "array" }, "reseller_billed": { "default": false, "title": "Reseller Billed", "type": "boolean" }, "resold_tenant_count": { "default": 0, "title": "Resold Tenant Count", "type": "integer" }, "resold_token_cents": { "default": 0, "title": "Resold Token Cents", "type": "integer" }, "seat_price_cents": { "title": "Seat Price Cents", "type": "integer" }, "seats": { "title": "Seats", "type": "integer" }, "seats_cents": { "title": "Seats Cents", "type": "integer" }, "token_cents": { "title": "Token Cents", "type": "integer" }, "window": { "$ref": "#/components/schemas/UsageWindow" } }, "required": [ "plan_code", "currency", "window", "has_subscription", "platform_fee_cents", "seats", "seat_price_cents", "seats_cents", "ide_used_minutes", "ide_free_minutes", "ide_billable_minutes", "ide_price_cents_per_user_hour", "ide_overage_enabled", "ide_cents", "token_cents", "estimated_total_cents", "reported" ], "title": "PlanCharges", "type": "object" }, "PlanCreate": { "description": "SuperAdmin: new plan. Unsent terms take the column defaults.", "properties": { "allow_byo_models": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Allow Byo Models" }, "allowed_merge_categories": { "anyOf": [ { "items": { "enum": [ "hris", "ats", "accounting", "ticketing", "crm", "mktg", "filestorage" ], "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Allowed Merge Categories" }, "apps": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "propertyNames": { "enum": [ "atd", "kahala", "newsbot", "zoom", "ide" ] }, "type": "object" }, { "type": "null" } ], "title": "Apps" }, "budgets": { "anyOf": [ { "additionalProperties": { "additionalProperties": { "type": "number" }, "type": "object" }, "description": "{scope: {window: USD}} - scope is user|agent, window is hour|day|week|month. In an override, null removes the plan's figure.", "title": "Budgets", "type": "object" }, { "type": "null" } ], "title": "Budgets" }, "code": { "maxLength": 32, "minLength": 1, "pattern": "^[A-Z][A-Z0-9_]*$", "title": "Code", "type": "string" }, "display_name": { "maxLength": 128, "minLength": 1, "title": "Display Name", "type": "string" }, "free_tier_model_kinds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Free Tier Model Kinds" }, "ide_free_minutes_per_month": { "anyOf": [ { "maximum": 1000000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Ide Free Minutes Per Month" }, "ide_price_cents_per_user_hour": { "anyOf": [ { "maximum": 1000000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Ide Price Cents Per User Hour" }, "is_public": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Public" }, "max_agents": { "anyOf": [ { "maximum": 100000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Max Agents" }, "max_concurrent_sessions": { "anyOf": [ { "maximum": 100000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Max Concurrent Sessions" }, "max_connections_per_agent": { "anyOf": [ { "maximum": 1000.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Max Connections Per Agent" }, "max_mailboxes_per_agent": { "anyOf": [ { "maximum": 10000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Max Mailboxes Per Agent" }, "max_messages_per_mailbox": { "anyOf": [ { "maximum": 10000000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Max Messages Per Mailbox" }, "max_storage_gb": { "anyOf": [ { "maximum": 1000000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Max Storage Gb" }, "max_tasks_per_day": { "anyOf": [ { "maximum": 100000000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Max Tasks Per Day" }, "paid_tier": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Paid Tier" }, "price_cents": { "anyOf": [ { "maximum": 100000000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Price Cents" }, "seat_price_cents": { "anyOf": [ { "maximum": 100000000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Seat Price Cents" }, "stripe_price_id": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "title": "Stripe Price Id" }, "token_markup_bps": { "anyOf": [ { "maximum": 100000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Token Markup Bps" }, "zero_cost_model_kinds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Zero Cost Model Kinds" } }, "required": [ "display_name", "code" ], "title": "PlanCreate", "type": "object" }, "PlanLimitExcessRead": { "description": "A limit this tenant's current usage exceeds on a plan (GitLab #353).\n\nOn a downgrade the change is still allowed; the ``over`` newest resources\nbecome read-only until capacity returns (``services/plan_capacity.py``).", "properties": { "current": { "title": "Current", "type": "integer" }, "limit": { "title": "Limit", "type": "integer" }, "over": { "title": "Over", "type": "integer" }, "resource": { "title": "Resource", "type": "string" }, "term": { "title": "Term", "type": "string" } }, "required": [ "term", "resource", "limit", "current", "over" ], "title": "PlanLimitExcessRead", "type": "object" }, "PlanOptions": { "description": "``GET /tenant/{t}/billing/plans`` \u2014 the self-serve plan picker.", "properties": { "current_plan_code": { "title": "Current Plan Code", "type": "string" }, "has_subscription": { "title": "Has Subscription", "type": "boolean" }, "plans": { "items": { "$ref": "#/components/schemas/PublicPlanRead" }, "title": "Plans", "type": "array" } }, "required": [ "current_plan_code", "has_subscription", "plans" ], "title": "PlanOptions", "type": "object" }, "PlanRead": { "properties": { "allow_byo_models": { "title": "Allow Byo Models", "type": "boolean" }, "allowed_merge_categories": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Allowed Merge Categories" }, "apps": { "title": "Apps", "type": "object" }, "budgets": { "title": "Budgets", "type": "object" }, "code": { "title": "Code", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "display_name": { "title": "Display Name", "type": "string" }, "features": { "title": "Features", "type": "object" }, "free_tier_model_kinds": { "default": [], "items": { "type": "string" }, "title": "Free Tier Model Kinds", "type": "array" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "ide_free_minutes_per_month": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ide Free Minutes Per Month" }, "ide_price_cents_per_user_hour": { "title": "Ide Price Cents Per User Hour", "type": "integer" }, "is_public": { "title": "Is Public", "type": "boolean" }, "is_super_admin": { "title": "Is Super Admin", "type": "boolean" }, "max_agents": { "title": "Max Agents", "type": "integer" }, "max_concurrent_sessions": { "title": "Max Concurrent Sessions", "type": "integer" }, "max_connections_per_agent": { "title": "Max Connections Per Agent", "type": "integer" }, "max_mailboxes_per_agent": { "title": "Max Mailboxes Per Agent", "type": "integer" }, "max_messages_per_mailbox": { "title": "Max Messages Per Mailbox", "type": "integer" }, "max_storage_gb": { "title": "Max Storage Gb", "type": "integer" }, "max_tasks_per_day": { "title": "Max Tasks Per Day", "type": "integer" }, "paid_tier": { "default": false, "title": "Paid Tier", "type": "boolean" }, "price_cents": { "title": "Price Cents", "type": "integer" }, "seat_price_cents": { "title": "Seat Price Cents", "type": "integer" }, "stripe_price_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stripe Price Id" }, "tenant_count": { "default": 0, "title": "Tenant Count", "type": "integer" }, "token_markup_bps": { "title": "Token Markup Bps", "type": "integer" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "zero_cost_model_kinds": { "default": [], "items": { "type": "string" }, "title": "Zero Cost Model Kinds", "type": "array" } }, "required": [ "id", "code", "display_name", "is_super_admin", "is_public", "max_agents", "max_tasks_per_day", "max_concurrent_sessions", "max_storage_gb", "max_mailboxes_per_agent", "max_messages_per_mailbox", "max_connections_per_agent", "price_cents", "seat_price_cents", "token_markup_bps", "ide_price_cents_per_user_hour", "ide_free_minutes_per_month", "allow_byo_models", "allowed_merge_categories", "budgets", "apps", "stripe_price_id", "features", "created_at", "updated_at" ], "title": "PlanRead", "type": "object" }, "PlanTermsPatch": { "description": "Every overridable term, all optional. ``extra=\"forbid\"`` so a smuggled\n``is_super_admin`` / ``code`` / ``tenant_id`` is a 422, never ignored.", "properties": { "allow_byo_models": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Allow Byo Models" }, "allowed_merge_categories": { "anyOf": [ { "items": { "enum": [ "hris", "ats", "accounting", "ticketing", "crm", "mktg", "filestorage" ], "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Allowed Merge Categories" }, "apps": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "propertyNames": { "enum": [ "atd", "kahala", "newsbot", "zoom", "ide" ] }, "type": "object" }, { "type": "null" } ], "title": "Apps" }, "budgets": { "anyOf": [ { "additionalProperties": { "additionalProperties": { "type": "number" }, "type": "object" }, "description": "{scope: {window: USD}} - scope is user|agent, window is hour|day|week|month. In an override, null removes the plan's figure.", "title": "Budgets", "type": "object" }, { "type": "null" } ], "title": "Budgets" }, "free_tier_model_kinds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Free Tier Model Kinds" }, "ide_free_minutes_per_month": { "anyOf": [ { "maximum": 1000000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Ide Free Minutes Per Month" }, "ide_price_cents_per_user_hour": { "anyOf": [ { "maximum": 1000000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Ide Price Cents Per User Hour" }, "max_agents": { "anyOf": [ { "maximum": 100000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Max Agents" }, "max_concurrent_sessions": { "anyOf": [ { "maximum": 100000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Max Concurrent Sessions" }, "max_connections_per_agent": { "anyOf": [ { "maximum": 1000.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Max Connections Per Agent" }, "max_mailboxes_per_agent": { "anyOf": [ { "maximum": 10000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Max Mailboxes Per Agent" }, "max_messages_per_mailbox": { "anyOf": [ { "maximum": 10000000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Max Messages Per Mailbox" }, "max_storage_gb": { "anyOf": [ { "maximum": 1000000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Max Storage Gb" }, "max_tasks_per_day": { "anyOf": [ { "maximum": 100000000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Max Tasks Per Day" }, "paid_tier": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Paid Tier" }, "price_cents": { "anyOf": [ { "maximum": 100000000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Price Cents" }, "seat_price_cents": { "anyOf": [ { "maximum": 100000000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Seat Price Cents" }, "token_markup_bps": { "anyOf": [ { "maximum": 100000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Token Markup Bps" }, "zero_cost_model_kinds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Zero Cost Model Kinds" } }, "title": "PlanTermsPatch", "type": "object" }, "PlanUpdateRequest": { "description": "SuperAdmin plan edit (issue #353). Every term plus the catalogue fields.\n\n``code`` and ``is_super_admin`` are immutable (``extra=\"forbid\"`` makes\nsending them a 422): code-keyed defaults such as memory retention read the\ncode, and the operator plan is a singleton.", "properties": { "allow_byo_models": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Allow Byo Models" }, "allowed_merge_categories": { "anyOf": [ { "items": { "enum": [ "hris", "ats", "accounting", "ticketing", "crm", "mktg", "filestorage" ], "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Allowed Merge Categories" }, "apps": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "propertyNames": { "enum": [ "atd", "kahala", "newsbot", "zoom", "ide" ] }, "type": "object" }, { "type": "null" } ], "title": "Apps" }, "budgets": { "anyOf": [ { "additionalProperties": { "additionalProperties": { "type": "number" }, "type": "object" }, "description": "{scope: {window: USD}} - scope is user|agent, window is hour|day|week|month. In an override, null removes the plan's figure.", "title": "Budgets", "type": "object" }, { "type": "null" } ], "title": "Budgets" }, "display_name": { "anyOf": [ { "maxLength": 128, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "free_tier_model_kinds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Free Tier Model Kinds" }, "ide_free_minutes_per_month": { "anyOf": [ { "maximum": 1000000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Ide Free Minutes Per Month" }, "ide_price_cents_per_user_hour": { "anyOf": [ { "maximum": 1000000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Ide Price Cents Per User Hour" }, "is_public": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Public" }, "max_agents": { "anyOf": [ { "maximum": 100000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Max Agents" }, "max_concurrent_sessions": { "anyOf": [ { "maximum": 100000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Max Concurrent Sessions" }, "max_connections_per_agent": { "anyOf": [ { "maximum": 1000.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Max Connections Per Agent" }, "max_mailboxes_per_agent": { "anyOf": [ { "maximum": 10000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Max Mailboxes Per Agent" }, "max_messages_per_mailbox": { "anyOf": [ { "maximum": 10000000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Max Messages Per Mailbox" }, "max_storage_gb": { "anyOf": [ { "maximum": 1000000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Max Storage Gb" }, "max_tasks_per_day": { "anyOf": [ { "maximum": 100000000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Max Tasks Per Day" }, "paid_tier": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Paid Tier" }, "price_cents": { "anyOf": [ { "maximum": 100000000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Price Cents" }, "seat_price_cents": { "anyOf": [ { "maximum": 100000000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Seat Price Cents" }, "stripe_price_id": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "title": "Stripe Price Id" }, "token_markup_bps": { "anyOf": [ { "maximum": 100000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Token Markup Bps" }, "zero_cost_model_kinds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Zero Cost Model Kinds" } }, "title": "PlanUpdateRequest", "type": "object" }, "PlanUsageReportRead": { "description": "One metered-usage invoice item reported to Stripe (the ledger, #353).", "properties": { "amount_cents": { "title": "Amount Cents", "type": "integer" }, "confirmed": { "title": "Confirmed", "type": "boolean" }, "period_start": { "format": "date-time", "title": "Period Start", "type": "string" }, "quantity": { "title": "Quantity", "type": "integer" }, "seq": { "title": "Seq", "type": "integer" }, "term": { "title": "Term", "type": "string" } }, "required": [ "term", "period_start", "seq", "quantity", "amount_cents", "confirmed" ], "title": "PlanUsageReportRead", "type": "object" }, "PlatformBrandFaviconUploaded": { "properties": { "favicon_content_type": { "title": "Favicon Content Type", "type": "string" }, "favicon_sha256": { "title": "Favicon Sha256", "type": "string" }, "favicon_size_bytes": { "title": "Favicon Size Bytes", "type": "integer" } }, "required": [ "favicon_sha256", "favicon_content_type", "favicon_size_bytes" ], "title": "PlatformBrandFaviconUploaded", "type": "object" }, "PlatformBrandRead": { "properties": { "favicon_content_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Favicon Content Type" }, "favicon_sha256": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Favicon Sha256" }, "favicon_size_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Favicon Size Bytes" }, "has_favicon": { "title": "Has Favicon", "type": "boolean" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "required": [ "has_favicon" ], "title": "PlatformBrandRead", "type": "object" }, "PlatformSecretRevealRead": { "properties": { "last_rotated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Last Rotated At" }, "provider": { "title": "Provider", "type": "string" }, "value": { "title": "Value", "type": "string" } }, "required": [ "provider", "value", "last_rotated_at" ], "title": "PlatformSecretRevealRead", "type": "object" }, "PlatformSecretRow": { "properties": { "is_set": { "title": "Is Set", "type": "boolean" }, "label": { "title": "Label", "type": "string" }, "last_rotated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Last Rotated At" }, "masked": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Masked" }, "provider": { "title": "Provider", "type": "string" }, "rotated_by_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rotated By User Id" } }, "required": [ "provider", "label", "is_set", "last_rotated_at", "rotated_by_user_id", "masked" ], "title": "PlatformSecretRow", "type": "object" }, "PlatformSecretSetRequest": { "description": "Body for PUT /admin/platform-secrets/{provider}.\n\n``label`` is required when creating a new provider; it's optional when\nrotating the value of an existing one (omit to keep the existing label).", "properties": { "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" }, "value": { "title": "Value", "type": "string" } }, "required": [ "value" ], "title": "PlatformSecretSetRequest", "type": "object" }, "PolicyCreate": { "properties": { "act": { "title": "Act", "type": "string" }, "eft": { "enum": [ "allow", "deny" ], "title": "Eft", "type": "string" }, "obj": { "title": "Obj", "type": "string" }, "sub": { "title": "Sub", "type": "string" } }, "required": [ "sub", "obj", "act" ], "title": "PolicyCreate", "type": "object" }, "PolicyRead": { "properties": { "act": { "title": "Act", "type": "string" }, "dom": { "title": "Dom", "type": "string" }, "eft": { "title": "Eft", "type": "string" }, "obj": { "title": "Obj", "type": "string" }, "sub": { "title": "Sub", "type": "string" } }, "required": [ "sub", "dom", "obj", "act", "eft" ], "title": "PolicyRead", "type": "object" }, "PreferenceSuggestions": { "description": "Server-sourced suggestions for the NewsBot4 ``/preferences`` typeaheads.\n\nThese are *suggestions*, not identifiers \u2014 the front-end always accepts\nfree-form entry for the long tail \u2014 but per ``docs/content/ui.md`` the\nenumerable half is server-owned rather than a catalogue hard-coded in the\nfront-end (issue #3623). ``sources`` is the curated outlet list unioned with\nthe human names of the live source credentials the caller may use \u2014 never a\nsecret.", "properties": { "sources": { "items": { "type": "string" }, "title": "Sources", "type": "array" }, "topics": { "items": { "type": "string" }, "title": "Topics", "type": "array" } }, "required": [ "topics", "sources" ], "title": "PreferenceSuggestions", "type": "object" }, "ProjectRead": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "slug": { "title": "Slug", "type": "string" }, "tenant_id": { "title": "Tenant Id", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "tenant_id", "name", "slug", "created_at", "updated_at" ], "title": "ProjectRead", "type": "object" }, "PromptEmbeddingSettingsRead": { "description": "Response for GET /tenants/{id}/prompt-embedding.", "properties": { "opt_out": { "description": "When true, this tenant's prompts are not embedded for analytics or clustering. Default false \u2014 prompts are embedded locally (never sent to an outside vendor).", "title": "Opt Out", "type": "boolean" } }, "required": [ "opt_out" ], "title": "PromptEmbeddingSettingsRead", "type": "object" }, "PromptEmbeddingSettingsUpdate": { "description": "Body for PUT /tenants/{id}/prompt-embedding.\n\nSetting ``opt_out`` to ``True`` also purges the tenant's existing\n``prompt_embedding`` rows; setting it back to ``False`` only re-enables\nembedding going forward (the backfill loop refills over time).", "properties": { "opt_out": { "description": "True to opt this tenant out of prompt embedding; false to opt back in.", "title": "Opt Out", "type": "boolean" } }, "required": [ "opt_out" ], "title": "PromptEmbeddingSettingsUpdate", "type": "object" }, "ProxyGuardrailConfigRead": { "description": "Response schema for GET /agents/{id}/proxy-config.\n\nReturns the per-agent guardrail model overrides, egress allowlist, and\nbuilt-in detector toggles. A ``None`` value means the override is not\nset and the global default applies \u2014 the proxy falls back to its\nhardcoded defaults for Prompt Guard / Llama Guard, and to the broker's\n``system:embedding`` sentinel for the embedding model.", "properties": { "built_in": { "$ref": "#/components/schemas/BuiltInDetectorConfigRead" }, "egress_allowlist": { "items": { "type": "string" }, "title": "Egress Allowlist", "type": "array" }, "embedding_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Embedding Model" }, "llama_guard_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Llama Guard Model" }, "prompt_guard_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prompt Guard Model" } }, "title": "ProxyGuardrailConfigRead", "type": "object" }, "ProxyGuardrailConfigUpdate": { "description": "Partial-update body for PUT /agents/{id}/proxy-config.\n\nFields are written only when present in the request body\n(``model_fields_set``). Sending a field as ``null`` clears the override\nand falls back to the global default; omitting a field leaves the existing\nvalue untouched. The service writes the value as-is into JSONB without\nmodel-ID validation; the proxy rejects unresolvable IDs at inference time.\n\n**Embedding-model dimension lock.** Setting ``embedding_model`` to a\nvariant whose dimension differs from the agent's current vector indexes\n(Valkey memory + pgvector tool/skill routing) will silently break\nnearest-neighbour retrieval after the next embed call. Until per-agent\nshadow-index migration lands, the picker enumeration is restricted to\nsame-dimension (1536) variants and any free-form override outside that\nfamily is operator-at-own-risk \u2014 see ``docs/content/guardrails.md``.", "properties": { "egress_allowlist": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Egress Allowlist" }, "embedding_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Embedding Model" }, "llama_guard_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Llama Guard Model" }, "max_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Bytes" }, "pii_scrub": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Pii Scrub" }, "prompt_guard_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prompt Guard Model" }, "secret_scrub": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Secret Scrub" } }, "title": "ProxyGuardrailConfigUpdate", "type": "object" }, "PublicPlanRead": { "description": "A plan a tenant may choose for itself (``plan.is_public``) \u2014 GitLab #353.\n\nPrices are what *this* tenant would pay on it: the plan's terms with the\ntenant's SuperAdmin overrides applied.", "properties": { "code": { "title": "Code", "type": "string" }, "current": { "default": false, "title": "Current", "type": "boolean" }, "display_name": { "title": "Display Name", "type": "string" }, "exceeds": { "default": [], "items": { "$ref": "#/components/schemas/PlanLimitExcessRead" }, "title": "Exceeds", "type": "array" }, "ide_price_cents_per_user_hour": { "title": "Ide Price Cents Per User Hour", "type": "integer" }, "price_cents": { "title": "Price Cents", "type": "integer" }, "seat_price_cents": { "title": "Seat Price Cents", "type": "integer" }, "token_markup_bps": { "title": "Token Markup Bps", "type": "integer" } }, "required": [ "code", "display_name", "price_cents", "seat_price_cents", "token_markup_bps", "ide_price_cents_per_user_hour" ], "title": "PublicPlanRead", "type": "object" }, "RBACCheckRequest": { "properties": { "action": { "title": "Action", "type": "string" }, "agent_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Agent Id" }, "user_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "User Id", "type": "string" } }, "required": [ "user_id", "action" ], "title": "RBACCheckRequest", "type": "object" }, "RBACCheckResponse": { "properties": { "allowed": { "title": "Allowed", "type": "boolean" }, "reason": { "title": "Reason", "type": "string" } }, "required": [ "allowed", "reason" ], "title": "RBACCheckResponse", "type": "object" }, "ReaderTenantCreate": { "description": "Body of ``POST /reseller/readers`` (GitLab #594).\n\nOnly the reader's **asserted** Keycloak identity \u2014 the same trust posture\n``tenants/ensure`` (DRL) and ``tenants/import`` (atd) take: NewsBot4 has\nalready verified the reader's token and forwards the claims.\n\nThere is deliberately **no** ``plan_code`` / ``seed_profile`` / ``tenant_id``\n/ ``billed_to_tenant_id`` / ``reseller_tenant_id`` / ``owner_*`` /\n``is_super_admin`` field. Those are the mass-assignment guard: the plan, the\n``newsbot`` seed profile and the billed-to reseller are all server-forced\n(``newsbot_reader_provision`` \u2192 ``reseller_billing``), and the reseller is\nresolved from the per-environment setting, never from the body \u2014 so there is\nno cross-reseller surface. ``extra=\"forbid\"`` rejects any smuggled key\noutright (422) rather than silently dropping it.", "properties": { "email": { "minLength": 1, "title": "Email", "type": "string" }, "email_verified": { "default": false, "title": "Email Verified", "type": "boolean" }, "kc_subject": { "minLength": 1, "title": "Kc Subject", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" } }, "required": [ "kc_subject", "email" ], "title": "ReaderTenantCreate", "type": "object" }, "ReaderTenantRead": { "properties": { "created": { "title": "Created", "type": "boolean" }, "id": { "title": "Id", "type": "string" }, "slug": { "title": "Slug", "type": "string" } }, "required": [ "id", "slug", "created" ], "title": "ReaderTenantRead", "type": "object" }, "ReaderTierRead": { "properties": { "paid": { "title": "Paid", "type": "boolean" }, "tenant_id": { "title": "Tenant Id", "type": "string" }, "tier": { "enum": [ "free", "pro" ], "title": "Tier", "type": "string" } }, "required": [ "tenant_id", "tier", "paid" ], "title": "ReaderTierRead", "type": "object" }, "ReaderTierUpdate": { "description": "Body of ``PUT /reseller/tenants/{tenant_id}/tier``. Only the tier.", "properties": { "tier": { "enum": [ "free", "pro" ], "title": "Tier", "type": "string" } }, "required": [ "tier" ], "title": "ReaderTierUpdate", "type": "object" }, "ReassignAgentTenantRequest": { "properties": { "tenant_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Tenant Id", "type": "string" } }, "required": [ "tenant_id" ], "title": "ReassignAgentTenantRequest", "type": "object" }, "ReassignAgentTenantResponse": { "description": "Response from ``PUT /admin/agents/{agent_id}/tenant``.", "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "integration_warnings": { "items": { "type": "string" }, "title": "Integration Warnings", "type": "array" }, "is_active": { "title": "Is Active", "type": "boolean" }, "is_seed": { "title": "Is Seed", "type": "boolean" }, "model_conflicts": { "items": { "$ref": "#/components/schemas/ModelConflictRead" }, "title": "Model Conflicts", "type": "array" }, "name": { "title": "Name", "type": "string" }, "slug": { "title": "Slug", "type": "string" }, "tenant_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Tenant Id", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "tenant_id", "name", "slug", "is_active", "is_seed", "created_at", "updated_at", "model_conflicts", "integration_warnings" ], "title": "ReassignAgentTenantResponse", "type": "object" }, "ReorderItem": { "properties": { "display_order": { "minimum": 0.0, "title": "Display Order", "type": "integer" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" } }, "required": [ "id", "display_order" ], "title": "ReorderItem", "type": "object" }, "ReorderRequest": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ReorderItem" }, "minItems": 1, "title": "Items", "type": "array" } }, "required": [ "items" ], "title": "ReorderRequest", "type": "object" }, "RepoRevision": { "description": "One ``agent/self-edit-`` branch surfaced as a pending revision.", "properties": { "author": { "title": "Author", "type": "string" }, "branch": { "title": "Branch", "type": "string" }, "created_at": { "title": "Created At", "type": "string" }, "mr_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mr Url" }, "sha": { "title": "Sha", "type": "string" } }, "required": [ "branch", "sha", "author", "created_at" ], "title": "RepoRevision", "type": "object" }, "ResoldTenantUsage": { "description": "One reseller-billed tenant's model usage for the period.\n\nBYOK calls are excluded from every figure (the platform never bills them;\nwholesale plans disallow BYO models anyway).", "properties": { "billed_cents": { "title": "Billed Cents", "type": "integer" }, "billed_micro_usd": { "title": "Billed Micro Usd", "type": "integer" }, "calls": { "title": "Calls", "type": "integer" }, "provider_cost_cents": { "title": "Provider Cost Cents", "type": "integer" }, "provider_cost_micro_usd": { "title": "Provider Cost Micro Usd", "type": "integer" }, "slug": { "title": "Slug", "type": "string" }, "tenant_id": { "title": "Tenant Id", "type": "string" } }, "required": [ "tenant_id", "slug", "calls", "provider_cost_micro_usd", "provider_cost_cents", "billed_micro_usd", "billed_cents" ], "title": "ResoldTenantUsage", "type": "object" }, "ResoldUsage": { "properties": { "billed_cents": { "title": "Billed Cents", "type": "integer" }, "billed_micro_usd": { "title": "Billed Micro Usd", "type": "integer" }, "calls": { "title": "Calls", "type": "integer" }, "closed": { "title": "Closed", "type": "boolean" }, "currency": { "title": "Currency", "type": "string" }, "period": { "title": "Period", "type": "string" }, "period_end": { "format": "date-time", "title": "Period End", "type": "string" }, "period_start": { "format": "date-time", "title": "Period Start", "type": "string" }, "provider_cost_cents": { "title": "Provider Cost Cents", "type": "integer" }, "provider_cost_micro_usd": { "title": "Provider Cost Micro Usd", "type": "integer" }, "reseller_tenant_id": { "title": "Reseller Tenant Id", "type": "string" }, "tenant_count": { "title": "Tenant Count", "type": "integer" }, "tenants": { "items": { "$ref": "#/components/schemas/ResoldTenantUsage" }, "title": "Tenants", "type": "array" } }, "required": [ "reseller_tenant_id", "period", "period_start", "period_end", "closed", "currency", "tenant_count", "calls", "provider_cost_micro_usd", "provider_cost_cents", "billed_micro_usd", "billed_cents", "tenants" ], "title": "ResoldUsage", "type": "object" }, "RunCreateRequest": { "properties": { "additional_instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Additional Instructions" }, "additional_messages": { "anyOf": [ { "items": { "$ref": "#/components/schemas/MessageCreateRequest" }, "type": "array" }, { "type": "null" } ], "title": "Additional Messages" }, "assistant_id": { "title": "Assistant Id", "type": "string" }, "instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instructions" }, "metadata": { "title": "Metadata", "type": "object" }, "stream": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Stream" } }, "required": [ "assistant_id" ], "title": "RunCreateRequest", "type": "object" }, "RunObject": { "properties": { "assistant_id": { "title": "Assistant Id", "type": "string" }, "created_at": { "title": "Created At", "type": "integer" }, "id": { "title": "Id", "type": "string" }, "instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instructions" }, "metadata": { "title": "Metadata", "type": "object" }, "model": { "default": "good-place-agent", "title": "Model", "type": "string" }, "object": { "const": "thread.run", "title": "Object", "type": "string" }, "status": { "title": "Status", "type": "string" }, "thread_id": { "title": "Thread Id", "type": "string" } }, "required": [ "id", "created_at", "thread_id", "assistant_id", "status" ], "title": "RunObject", "type": "object" }, "SSOConfigRead": { "description": "SSO configuration surface for the tenant Organization > Security page.", "properties": { "active": { "title": "Active", "type": "boolean" }, "identity_providers": { "items": { "$ref": "#/components/schemas/SSOIdentityProviderSummary" }, "title": "Identity Providers", "type": "array" }, "issuer_url": { "title": "Issuer Url", "type": "string" }, "realm": { "title": "Realm", "type": "string" } }, "required": [ "active", "realm", "issuer_url", "identity_providers" ], "title": "SSOConfigRead", "type": "object" }, "SSOIdentityProviderSummary": { "description": "Minimal IdP projection for the SSO config overview.", "properties": { "alias": { "title": "Alias", "type": "string" }, "display_name": { "title": "Display Name", "type": "string" }, "enabled": { "title": "Enabled", "type": "boolean" }, "provider_id": { "title": "Provider Id", "type": "string" } }, "required": [ "alias", "display_name", "provider_id", "enabled" ], "title": "SSOIdentityProviderSummary", "type": "object" }, "SampleUseCaseCreate": { "properties": { "category": { "maxLength": 200, "minLength": 1, "title": "Category", "type": "string" }, "description": { "maxLength": 5000, "minLength": 1, "title": "Description", "type": "string" }, "title": { "maxLength": 500, "minLength": 1, "title": "Title", "type": "string" } }, "required": [ "title", "description", "category" ], "title": "SampleUseCaseCreate", "type": "object" }, "SampleUseCaseIconUploaded": { "properties": { "icon_content_type": { "title": "Icon Content Type", "type": "string" }, "icon_sha256": { "title": "Icon Sha256", "type": "string" }, "icon_size_bytes": { "title": "Icon Size Bytes", "type": "integer" } }, "required": [ "icon_sha256", "icon_content_type", "icon_size_bytes" ], "title": "SampleUseCaseIconUploaded", "type": "object" }, "SampleUseCaseRead": { "properties": { "category": { "title": "Category", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Created By" }, "description": { "title": "Description", "type": "string" }, "display_order": { "title": "Display Order", "type": "integer" }, "has_icon": { "title": "Has Icon", "type": "boolean" }, "icon_content_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Icon Content Type" }, "icon_sha256": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Icon Sha256" }, "icon_size_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Icon Size Bytes" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "is_active": { "title": "Is Active", "type": "boolean" }, "title": { "title": "Title", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "title", "description", "category", "has_icon", "icon_content_type", "icon_sha256", "icon_size_bytes", "display_order", "is_active", "created_by", "created_at", "updated_at" ], "title": "SampleUseCaseRead", "type": "object" }, "SampleUseCaseUpdate": { "properties": { "category": { "anyOf": [ { "maxLength": 200, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Category" }, "description": { "anyOf": [ { "maxLength": 5000, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Description" }, "display_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Display Order" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active" }, "title": { "anyOf": [ { "maxLength": 500, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Title" } }, "title": "SampleUseCaseUpdate", "type": "object" }, "SelfEditBranchRead": { "description": "One row in the agent code-tab \"self-edit branches\" table.\n\n``mr_url`` is ``None`` when the SDK has pushed the branch but no merge\nrequest has been opened yet. The front-end renders the \"review MR\" link\nonly when the field is present.", "properties": { "author": { "title": "Author", "type": "string" }, "created_at": { "title": "Created At", "type": "string" }, "mr_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mr Url" }, "name": { "title": "Name", "type": "string" }, "sha": { "title": "Sha", "type": "string" } }, "required": [ "name", "sha", "author", "created_at" ], "title": "SelfEditBranchRead", "type": "object" }, "ServiceStatusRead": { "properties": { "bars": { "items": { "enum": [ "green", "yellow", "red", "gray" ], "type": "string" }, "title": "Bars", "type": "array" }, "display_name": { "title": "Display Name", "type": "string" }, "enabled": { "default": true, "title": "Enabled", "type": "boolean" }, "kind": { "enum": [ "internal", "connector" ], "title": "Kind", "type": "string" }, "service_key": { "title": "Service Key", "type": "string" } }, "required": [ "service_key", "display_name", "kind", "bars" ], "title": "ServiceStatusRead", "type": "object" }, "SessionAttachmentRead": { "description": "Response for a successfully uploaded session attachment.\n\n``kind`` is constrained to the values of the ``AttachmentKind`` ORM enum so\nthe OpenAPI snapshot (which feeds the mobile Dart client) carries the\nallowed values rather than a free-form string.", "properties": { "agent_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Agent Id", "type": "string" }, "content_type": { "title": "Content Type", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "filename": { "title": "Filename", "type": "string" }, "gcs_path": { "title": "Gcs Path", "type": "string" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "kind": { "enum": [ "image", "document" ], "title": "Kind", "type": "string" }, "session_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Session Id", "type": "string" }, "sha256": { "title": "Sha256", "type": "string" }, "size_bytes": { "title": "Size Bytes", "type": "integer" }, "tenant_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Tenant Id", "type": "string" } }, "required": [ "id", "session_id", "tenant_id", "agent_id", "filename", "content_type", "size_bytes", "sha256", "gcs_path", "kind", "created_at" ], "title": "SessionAttachmentRead", "type": "object" }, "SessionBriefRequest": { "description": "Body for ``POST /tenant/{t}/agent/{a}/sessions/{s}/brief`` (GitLab #531).\n\nStarts a *new* session seeded with a broker-generated brief of the source\nsession \u2014 the manual alternative to automatic compaction\n(docs/content/context-compaction.md). ``archive_source`` (default True)\ncontrols whether the source session transitions to ``archived_for_brief``\nonce the brief session exists; its transcript is never modified either way\n(decision #37).\n\nEvery other field a client might smuggle \u2014 ``parent_session_id``,\n``created_by_id``, ``status``, ``tenant_id``, ``read_only``,\n``is_super_admin`` \u2014 is ignored (pydantic drops unknown keys). The new\nsession's linkage, ownership, tenancy, and read-only flag are all resolved\nserver-side from the source session and the authenticated caller, never\nfrom this body (mass-assignment defence).", "properties": { "archive_source": { "default": true, "title": "Archive Source", "type": "boolean" } }, "title": "SessionBriefRequest", "type": "object" }, "SessionCancelRequest": { "description": "Optional body for `POST .../sessions/{session_id}/cancel` (#3124).\n\n``cascade=True`` is the opt-in \"stop this + its background tasks\" choice:\nafter the parent is cancelled, every still-active descendant subtask is\ncancelled too. Default ``False`` preserves the fire-and-forget contract \u2014\nan omitted body behaves exactly as before this field existed.", "properties": { "cascade": { "default": false, "title": "Cascade", "type": "boolean" } }, "title": "SessionCancelRequest", "type": "object" }, "SessionParticipant": { "description": "One human present in a session (session owner or a message author).", "properties": { "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "user_id": { "title": "User Id", "type": "string" } }, "required": [ "user_id" ], "title": "SessionParticipant", "type": "object" }, "SessionParticipantsOut": { "description": "The distinct humans present in a session, owner first.\n\nDerived from who has *participated* \u2014 the session creator plus every\ndistinct human-turn author (issue #605's ``task_message.author_user_id``).\nThis is \"participants who have posted\", not live view-presence; true\njoin/leave tracking would need a net-new SSE presence signal (deferred).", "properties": { "participants": { "items": { "$ref": "#/components/schemas/SessionParticipant" }, "title": "Participants", "type": "array" } }, "required": [ "participants" ], "title": "SessionParticipantsOut", "type": "object" }, "SessionTitleUpdate": { "description": "Body for ``PATCH /tenant/{t}/agent/{a}/sessions/{s}``.\n\nLets a user rename the current session from the chat header. The auto-namer\n(``services.session_naming``) still runs on every 5th user message and will\noverwrite a stale title, but a user-supplied title takes effect immediately\nand survives until the next auto-rename boundary.", "properties": { "title": { "maxLength": 255, "minLength": 1, "title": "Title", "type": "string" } }, "required": [ "title" ], "title": "SessionTitleUpdate", "type": "object" }, "SettleRequest": { "description": "Settle one lane of a session's retained output.\n\n``lane`` and ``action`` are the whole decision; there is no per-file\nselection (\"whole-output, path-disjoint or refused, never content\nsynthesis\", issue #10). Mass-assignment guard: no ``tenant_id`` /\n``session_id`` / ``settled_by_id`` here \u2014 all resolved server-side.", "properties": { "action": { "enum": [ "select", "apply", "discard" ], "title": "Action", "type": "string" }, "lane": { "enum": [ "workspace", "repo" ], "title": "Lane", "type": "string" } }, "required": [ "lane", "action" ], "title": "SettleRequest", "type": "object" }, "SettleResult": { "properties": { "file_count": { "title": "File Count", "type": "integer" }, "lane": { "enum": [ "workspace", "repo" ], "title": "Lane", "type": "string" }, "mr_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "For a repo-lane `select`, the merged self-edit MR url", "title": "Mr Url" }, "outcome": { "enum": [ "select", "apply", "discard" ], "title": "Outcome", "type": "string" }, "settlement_id": { "title": "Settlement Id", "type": "string" } }, "required": [ "lane", "outcome", "file_count", "settlement_id" ], "title": "SettleResult", "type": "object" }, "SettlementStatus": { "description": "Whether a lane has already been settled (consume-once, decision #49).", "properties": { "lane": { "enum": [ "workspace", "repo" ], "title": "Lane", "type": "string" }, "outcome": { "anyOf": [ { "enum": [ "select", "apply", "discard" ], "type": "string" }, { "type": "null" } ], "title": "Outcome" }, "settled": { "title": "Settled", "type": "boolean" }, "settled_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Settled At" } }, "required": [ "lane", "settled" ], "title": "SettlementStatus", "type": "object" }, "SiemConfigRead": { "description": "Response schema for GET /settings/siem.", "properties": { "custom_redaction_patterns": { "default": [], "items": { "$ref": "#/components/schemas/CustomRedactionPattern" }, "title": "Custom Redaction Patterns", "type": "array" }, "destinations": { "default": [], "items": { "$ref": "#/components/schemas/SiemDestinationRead" }, "title": "Destinations", "type": "array" } }, "title": "SiemConfigRead", "type": "object" }, "SiemConfigUpdate": { "description": "Request schema for PUT /settings/siem.", "properties": { "custom_redaction_patterns": { "default": [], "items": { "$ref": "#/components/schemas/CustomRedactionPattern" }, "title": "Custom Redaction Patterns", "type": "array" }, "destinations": { "default": [], "items": { "$ref": "#/components/schemas/SiemDestination" }, "title": "Destinations", "type": "array" } }, "title": "SiemConfigUpdate", "type": "object" }, "SiemDestination": { "description": "A single SIEM forwarding destination.", "properties": { "destination_type": { "$ref": "#/components/schemas/SiemDestinationType" }, "enabled": { "default": true, "title": "Enabled", "type": "boolean" }, "endpoint_url": { "maxLength": 2048, "minLength": 1, "title": "Endpoint Url", "type": "string" }, "token": { "anyOf": [ { "maxLength": 4096, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Token" } }, "required": [ "destination_type", "endpoint_url" ], "title": "SiemDestination", "type": "object" }, "SiemDestinationRead": { "description": "Read-only view of a SIEM destination (token masked).", "properties": { "destination_type": { "$ref": "#/components/schemas/SiemDestinationType" }, "enabled": { "title": "Enabled", "type": "boolean" }, "endpoint_url": { "title": "Endpoint Url", "type": "string" }, "has_token": { "title": "Has Token", "type": "boolean" } }, "required": [ "destination_type", "enabled", "endpoint_url", "has_token" ], "title": "SiemDestinationRead", "type": "object" }, "SiemDestinationType": { "description": "Supported SIEM destination types.", "enum": [ "splunk_hec", "datadog", "syslog", "webhook" ], "title": "SiemDestinationType", "type": "string" }, "SkillAdminRead": { "description": "Extended skill view for tenant admins \u2014 includes derived fields.", "properties": { "agent_count": { "title": "Agent Count", "type": "integer" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "entrypoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entrypoint" }, "forked_from_skill_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Forked From Skill Id" }, "forked_from_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Forked From Version" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "instruction_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instruction Content" }, "name": { "title": "Name", "type": "string" }, "network_enabled": { "title": "Network Enabled", "type": "boolean" }, "owner_agent_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Owner Agent Id" }, "owner_agent_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner Agent Name" }, "review_notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Review Notes" }, "review_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Review Status" }, "reviewed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Reviewed At" }, "reviewer_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Reviewer Id" }, "skill_type": { "title": "Skill Type", "type": "string" }, "source_repo_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Repo Url" }, "status": { "title": "Status", "type": "string" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Summary" }, "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" }, "tier": { "enum": [ "agent", "tenant", "platform" ], "title": "Tier", "type": "string" }, "version": { "title": "Version", "type": "string" }, "visibility": { "title": "Visibility", "type": "string" } }, "required": [ "id", "owner_agent_id", "name", "description", "summary", "skill_type", "source_repo_url", "entrypoint", "instruction_content", "version", "visibility", "tier", "status", "review_status", "reviewer_id", "reviewed_at", "review_notes", "network_enabled", "tags", "created_at", "owner_agent_name", "agent_count" ], "title": "SkillAdminRead", "type": "object" }, "SkillAgentRead": { "description": "Lightweight agent summary for the per-skill agents list.", "properties": { "agent_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Agent Id", "type": "string" }, "is_enabled": { "title": "Is Enabled", "type": "boolean" }, "name": { "title": "Name", "type": "string" } }, "required": [ "agent_id", "name", "is_enabled" ], "title": "SkillAgentRead", "type": "object" }, "SkillCreate": { "properties": { "description": { "minLength": 1, "title": "Description", "type": "string" }, "entrypoint": { "default": "skill:run", "title": "Entrypoint", "type": "string" }, "instruction_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instruction Content" }, "name": { "maxLength": 128, "minLength": 1, "title": "Name", "type": "string" }, "network_enabled": { "default": false, "title": "Network Enabled", "type": "boolean" }, "owner_agent_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Owner Agent Id", "type": "string" }, "skill_type": { "enum": [ "executable", "text" ], "title": "Skill Type", "type": "string" }, "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" }, "visibility": { "enum": [ "public", "private" ], "title": "Visibility", "type": "string" } }, "required": [ "name", "description", "owner_agent_id" ], "title": "SkillCreate", "type": "object" }, "SkillCredentialCreate": { "description": "Body for ``PUT /\u2026/skill-credentials/skill/{skill_id}`` \u2014 upsert on a triple.\n\nThe plaintext ``payload`` is encrypted immediately via the per-tenant\nFernet key and never written to the database in clear. Idempotent on the\ntriple \u2014 a second call with the same ``(agent_id, skill_id)`` overwrites\nthe previous row's ciphertext (rotation).", "properties": { "agent_id": { "minLength": 1, "title": "Agent Id", "type": "string" }, "credential_kind": { "$ref": "#/components/schemas/SkillCredentialKind" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "payload": { "description": "Plaintext credential material. Encrypted immediately and never stored in clear. Treat as write-only.", "minLength": 1, "title": "Payload", "type": "string" }, "skill_id": { "minLength": 1, "title": "Skill Id", "type": "string" } }, "required": [ "agent_id", "skill_id", "credential_kind", "payload" ], "title": "SkillCredentialCreate", "type": "object" }, "SkillCredentialKind": { "description": "Discriminator for the encrypted payload shape.\n\nStorage is opaque ``bytes`` either way; ``kind`` is metadata the skill\nruntime uses to interpret the plaintext (e.g. \"this is a JSON\n``{access_token, refresh_token}`` blob\" vs \"this is a raw API key\").", "enum": [ "oauth_token", "pat", "api_key", "totp_seed", "imap_smtp" ], "title": "SkillCredentialKind", "type": "string" }, "SkillCredentialRead": { "description": "Public projection \u2014 metadata only, never the payload.", "properties": { "agent_id": { "title": "Agent Id", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "credential_kind": { "$ref": "#/components/schemas/SkillCredentialKind" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "id": { "title": "Id", "type": "string" }, "last_used_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Last Used At" }, "revoked_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Revoked At" }, "skill_id": { "title": "Skill Id", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "user_id": { "title": "User Id", "type": "string" } }, "required": [ "id", "user_id", "agent_id", "skill_id", "credential_kind", "created_at", "updated_at", "last_used_at", "expires_at", "revoked_at" ], "title": "SkillCredentialRead", "type": "object" }, "SkillCredentialReveal": { "description": "Returned by the read endpoint. Contains the decrypted payload.", "properties": { "credential_kind": { "$ref": "#/components/schemas/SkillCredentialKind" }, "id": { "title": "Id", "type": "string" }, "payload": { "title": "Payload", "type": "string" } }, "required": [ "id", "credential_kind", "payload" ], "title": "SkillCredentialReveal", "type": "object" }, "SkillExecuteRequest": { "properties": { "agent_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Agent Id", "type": "string" }, "duration_ms": { "default": 0, "description": "Wall-clock ms, reported by the agent SDK", "minimum": 0.0, "title": "Duration Ms", "type": "integer" }, "error_message": { "anyOf": [ { "maxLength": 4096, "type": "string" }, { "type": "null" } ], "title": "Error Message" }, "input_args": { "title": "Input Args", "type": "object" }, "mutates": { "default": false, "title": "Mutates", "type": "boolean" }, "session_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Session Id", "type": "string" }, "status": { "enum": [ "success", "error", "timeout" ], "title": "Status", "type": "string" } }, "required": [ "session_id", "agent_id" ], "title": "SkillExecuteRequest", "type": "object" }, "SkillForkRead": { "description": "Response from POST /skills/{skill_id}/fork \u2014 the newly created skill.", "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "entrypoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entrypoint" }, "forked_from_skill_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Forked From Skill Id" }, "forked_from_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Forked From Version" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "instruction_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instruction Content" }, "name": { "title": "Name", "type": "string" }, "network_enabled": { "title": "Network Enabled", "type": "boolean" }, "owner_agent_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Owner Agent Id" }, "skill_type": { "title": "Skill Type", "type": "string" }, "source_repo_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Repo Url" }, "status": { "title": "Status", "type": "string" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Summary" }, "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" }, "version": { "title": "Version", "type": "string" }, "visibility": { "title": "Visibility", "type": "string" } }, "required": [ "id", "owner_agent_id", "name", "description", "summary", "skill_type", "source_repo_url", "entrypoint", "instruction_content", "version", "visibility", "status", "network_enabled", "tags", "forked_from_skill_id", "forked_from_version", "created_at" ], "title": "SkillForkRead", "type": "object" }, "SkillForkRequest": { "description": "Request body for POST /skills/{skill_id}/fork.", "properties": { "target_agent_id": { "description": "Agent that will own the forked skill", "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Target Agent Id", "type": "string" } }, "required": [ "target_agent_id" ], "title": "SkillForkRequest", "type": "object" }, "SkillGlobalSummary": { "properties": { "by_status": { "additionalProperties": { "type": "integer" }, "title": "By Status", "type": "object" }, "by_type": { "additionalProperties": { "type": "integer" }, "title": "By Type", "type": "object" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "total", "by_status", "by_type" ], "title": "SkillGlobalSummary", "type": "object" }, "SkillImportResult": { "description": "Response from POST /skills/import.", "properties": { "allowed_tools": { "items": { "type": "string" }, "title": "Allowed Tools", "type": "array" }, "description": { "title": "Description", "type": "string" }, "entrypoint": { "title": "Entrypoint", "type": "string" }, "env_vars": { "additionalProperties": { "type": "string" }, "title": "Env Vars", "type": "object" }, "id": { "title": "Id", "type": "string" }, "instructions": { "title": "Instructions", "type": "string" }, "name": { "title": "Name", "type": "string" }, "network_enabled": { "title": "Network Enabled", "type": "boolean" }, "source_repo_url": { "title": "Source Repo Url", "type": "string" }, "status": { "title": "Status", "type": "string" }, "version": { "title": "Version", "type": "string" } }, "required": [ "id", "name", "description", "entrypoint", "version", "status", "source_repo_url", "instructions", "network_enabled", "env_vars", "allowed_tools" ], "title": "SkillImportResult", "type": "object" }, "SkillInvocationRead": { "properties": { "agent_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Agent Id" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "duration_ms": { "title": "Duration Ms", "type": "integer" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "session_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Session Id", "type": "string" }, "skill_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Skill Id", "type": "string" }, "skill_platform_secret_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Skill Platform Secret Name" }, "skill_platform_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Skill Platform Token" }, "skill_version": { "title": "Skill Version", "type": "string" }, "started_at": { "format": "date-time", "title": "Started At", "type": "string" }, "status": { "enum": [ "success", "error", "timeout" ], "title": "Status", "type": "string" }, "tenant_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Tenant Id", "type": "string" }, "user_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "User Id" } }, "required": [ "id", "skill_id", "skill_version", "agent_id", "user_id", "session_id", "tenant_id", "status", "duration_ms", "error_message", "started_at", "created_at" ], "title": "SkillInvocationRead", "type": "object" }, "SkillPublishRequest": { "properties": { "version": { "description": "Git tag or ref to publish", "maxLength": 128, "minLength": 1, "title": "Version", "type": "string" } }, "required": [ "version" ], "title": "SkillPublishRequest", "type": "object" }, "SkillRead": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "entrypoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entrypoint" }, "forked_from_skill_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Forked From Skill Id" }, "forked_from_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Forked From Version" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "instruction_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instruction Content" }, "name": { "title": "Name", "type": "string" }, "network_enabled": { "title": "Network Enabled", "type": "boolean" }, "owner_agent_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Owner Agent Id" }, "review_notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Review Notes" }, "review_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Review Status" }, "reviewed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Reviewed At" }, "reviewer_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Reviewer Id" }, "skill_type": { "title": "Skill Type", "type": "string" }, "source_repo_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Repo Url" }, "status": { "title": "Status", "type": "string" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Summary" }, "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" }, "tier": { "enum": [ "agent", "tenant", "platform" ], "title": "Tier", "type": "string" }, "version": { "title": "Version", "type": "string" }, "visibility": { "title": "Visibility", "type": "string" } }, "required": [ "id", "owner_agent_id", "name", "description", "summary", "skill_type", "source_repo_url", "entrypoint", "instruction_content", "version", "visibility", "tier", "status", "review_status", "reviewer_id", "reviewed_at", "review_notes", "network_enabled", "tags", "created_at" ], "title": "SkillRead", "type": "object" }, "SkillReviewDecision": { "description": "Admin decision on a pending skill review.", "properties": { "decision": { "enum": [ "approved", "rejected" ], "title": "Decision", "type": "string" }, "review_notes": { "anyOf": [ { "maxLength": 2000, "type": "string" }, { "type": "null" } ], "title": "Review Notes" } }, "required": [ "decision" ], "title": "SkillReviewDecision", "type": "object" }, "SkillReviewResponse": { "description": "Response after a review action.", "properties": { "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "review_notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Review Notes" }, "review_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Review Status" }, "reviewed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Reviewed At" }, "reviewer_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Reviewer Id" }, "status": { "title": "Status", "type": "string" } }, "required": [ "id", "review_status", "reviewer_id", "reviewed_at", "review_notes", "status" ], "title": "SkillReviewResponse", "type": "object" }, "SkillTransferRequest": { "description": "Request body for POST /skills/{skill_id}/transfer.", "properties": { "target_agent_id": { "description": "Agent to transfer ownership to", "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Target Agent Id", "type": "string" } }, "required": [ "target_agent_id" ], "title": "SkillTransferRequest", "type": "object" }, "SkillUpdate": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "instruction_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instruction Content" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "network_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Network Enabled" }, "status": { "anyOf": [ { "enum": [ "draft", "active", "deprecated", "archived", "pending_review" ], "type": "string" }, { "type": "null" } ], "title": "Status" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Summary" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" } }, "title": "SkillUpdate", "type": "object" }, "SkillWebhookCreated": { "description": "Returned only on create/rotate \u2014 includes the raw bearer token (shown once).", "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "skill_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Skill Id", "type": "string" }, "tenant_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Tenant Id", "type": "string" }, "token": { "title": "Token", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "webhook_id": { "title": "Webhook Id", "type": "string" }, "webhook_url": { "title": "Webhook Url", "type": "string" } }, "required": [ "id", "skill_id", "tenant_id", "webhook_id", "webhook_url", "created_at", "updated_at", "token" ], "title": "SkillWebhookCreated", "type": "object" }, "SkillWebhookRead": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "skill_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Skill Id", "type": "string" }, "tenant_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Tenant Id", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "webhook_id": { "title": "Webhook Id", "type": "string" }, "webhook_url": { "title": "Webhook Url", "type": "string" } }, "required": [ "id", "skill_id", "tenant_id", "webhook_id", "webhook_url", "created_at", "updated_at" ], "title": "SkillWebhookRead", "type": "object" }, "SourceAddRequest": { "description": "Body of ``POST /api/v1/newsbot/sources``.\n\nThe caller supplies only a URL. ``is_public`` / ``age_tag`` /\n``added_by_user_id`` / ``title`` are server-owned \u2014 the mass-assignment\ntests confirm smuggled fields are ignored.", "properties": { "url": { "maxLength": 512, "minLength": 1, "title": "Url", "type": "string" } }, "required": [ "url" ], "title": "SourceAddRequest", "type": "object" }, "SourceBlocklistRead": { "description": "Moderator-visible blocklist row.", "properties": { "added_by_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Added By User Id" }, "canonical_url": { "title": "Canonical Url", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "title": "Id", "type": "string" }, "reason": { "title": "Reason", "type": "string" } }, "required": [ "id", "canonical_url", "reason", "added_by_user_id", "created_at" ], "title": "SourceBlocklistRead", "type": "object" }, "SourceBlocklistRequest": { "description": "Body of ``POST /api/v1/newsbot/sources/blocklist``.", "properties": { "reason": { "maxLength": 1000, "minLength": 1, "title": "Reason", "type": "string" }, "url": { "maxLength": 512, "minLength": 1, "title": "Url", "type": "string" } }, "required": [ "url", "reason" ], "title": "SourceBlocklistRequest", "type": "object" }, "SourceCredentialAdminRead": { "description": "One credential's metadata + its share grants. Never carries the secret.", "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "created_by_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Created By Id", "type": "string" }, "credential_kind": { "$ref": "#/components/schemas/SourceCredentialKind" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "grants": { "items": { "$ref": "#/components/schemas/SourceCredentialGrantRead" }, "title": "Grants", "type": "array" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "last_used_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Last Used At" }, "name": { "title": "Name", "type": "string" }, "revoked_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Revoked At" }, "source": { "title": "Source", "type": "string" }, "tenant_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Tenant Id", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "tenant_id", "created_by_id", "name", "source", "credential_kind", "created_at", "updated_at", "last_used_at", "expires_at", "revoked_at" ], "title": "SourceCredentialAdminRead", "type": "object" }, "SourceCredentialCreate": { "description": "Body for ``POST /\u2026/source-credentials`` \u2014 create a new credential.\n\nThe plaintext ``payload`` is encrypted immediately via the per-tenant\nFernet key and never stored in clear. ``name`` is unique per tenant.", "properties": { "credential_kind": { "$ref": "#/components/schemas/SourceCredentialKind" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "name": { "maxLength": 200, "minLength": 1, "title": "Name", "type": "string" }, "payload": { "description": "Plaintext credential material. Encrypted immediately and never stored in clear. Treat as write-only.", "minLength": 1, "title": "Payload", "type": "string" }, "source": { "description": "The source host/domain the credential authenticates to, e.g. nytimes.com.", "maxLength": 255, "minLength": 1, "title": "Source", "type": "string" } }, "required": [ "name", "source", "credential_kind", "payload" ], "title": "SourceCredentialCreate", "type": "object" }, "SourceCredentialGrantKind": { "description": "Who a grant makes the credential available to.\n\n- ``user`` \u2014 a specific user (``principal_id`` = user id).\n- ``agent`` \u2014 a specific agent (``principal_id`` = agent id).\n- ``role`` \u2014 every principal in a tenant **role** (``principal_id`` = role\n name, e.g. ``MEMBER``) \u2014 the standard-RBAC target.\n- ``group`` \u2014 every user/agent member of a tenant-authored ``tenant_group``\n (``principal_id`` = group id) \u2014 the decision-#43 grantee (G3/#424). The\n intersection still holds: a group grant reaches a member's user side and\n an agent member's agent side, each expanded by one flat join through\n ``tenant_group_member``, and access remains ``user side \u2229 agent side``.\n- ``all`` \u2014 everyone in the tenant (``principal_id`` is NULL).", "enum": [ "user", "agent", "role", "group", "all" ], "title": "SourceCredentialGrantKind", "type": "string" }, "SourceCredentialGrantRead": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "grant_kind": { "$ref": "#/components/schemas/SourceCredentialGrantKind" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "principal_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Principal Id" } }, "required": [ "id", "grant_kind", "principal_id", "created_at" ], "title": "SourceCredentialGrantRead", "type": "object" }, "SourceCredentialGrantRequest": { "description": "Add or remove one share grant.\n\n``all`` must omit ``principal_id``; every other kind requires one \u2014 the\nservice enforces this too (``add_grant``/``remove_grant`` raise\n``InvalidInput``).", "properties": { "grant_kind": { "$ref": "#/components/schemas/SourceCredentialGrantKind" }, "principal_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Principal Id" } }, "required": [ "grant_kind" ], "title": "SourceCredentialGrantRequest", "type": "object" }, "SourceCredentialKind": { "description": "Discriminator for the encrypted payload shape (storage is opaque bytes).\n\n``api_key`` / ``bearer`` are a single secret string; ``basic_auth`` is a\nJSON ``{username, password}`` blob; ``cookie`` is a raw Cookie header value;\n``oauth_token`` is a JSON ``{access_token, refresh_token}`` blob.", "enum": [ "api_key", "bearer", "basic_auth", "cookie", "oauth_token" ], "title": "SourceCredentialKind", "type": "string" }, "SourceCredentialRead": { "description": "Public projection \u2014 metadata only, never the payload.", "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "created_by_id": { "title": "Created By Id", "type": "string" }, "credential_kind": { "$ref": "#/components/schemas/SourceCredentialKind" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "id": { "title": "Id", "type": "string" }, "last_used_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Last Used At" }, "name": { "title": "Name", "type": "string" }, "revoked_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Revoked At" }, "source": { "title": "Source", "type": "string" }, "tenant_id": { "title": "Tenant Id", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "tenant_id", "created_by_id", "name", "source", "credential_kind", "created_at", "updated_at", "last_used_at", "expires_at", "revoked_at" ], "title": "SourceCredentialRead", "type": "object" }, "SourceCredentialRotate": { "description": "Body for ``POST /\u2026/source-credentials/{id}/rotate`` \u2014 new secret in place.\n\nRotation un-revokes and resets the expiry (default: no expiry).", "properties": { "credential_kind": { "anyOf": [ { "$ref": "#/components/schemas/SourceCredentialKind" }, { "type": "null" } ] }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "payload": { "description": "New plaintext credential material. Encrypted immediately.", "minLength": 1, "title": "Payload", "type": "string" } }, "required": [ "payload" ], "title": "SourceCredentialRotate", "type": "object" }, "SourceGroupShareRequest": { "description": "Body of the source\u2194group visibility share/unshare routes (#424).\n\n``group_id`` is a tenant-group id; a group from another tenant returns 404\n(no cross-tenant existence oracle). ``group:`` is the grantee \u2014 a source\nshared here becomes visible to every user member of the group.", "properties": { "group_id": { "maxLength": 32, "minLength": 1, "title": "Group Id", "type": "string" } }, "required": [ "group_id" ], "title": "SourceGroupShareRequest", "type": "object" }, "SourceListResponse": { "description": "Paginated ``GET /api/v1/newsbot/sources`` response.", "properties": { "limit": { "title": "Limit", "type": "integer" }, "offset": { "title": "Offset", "type": "integer" }, "sources": { "items": { "$ref": "#/components/schemas/SourceRead" }, "title": "Sources", "type": "array" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "sources", "total", "limit", "offset" ], "title": "SourceListResponse", "type": "object" }, "SourceRead": { "description": "The tenant-caller-visible catalogue row.", "properties": { "age_tag": { "enum": [ "general_audience", "young_adult", "adult_only", "unrated" ], "title": "Age Tag", "type": "string" }, "canonical_url": { "title": "Canonical Url", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "title": "Id", "type": "string" }, "is_public": { "title": "Is Public", "type": "boolean" }, "title": { "title": "Title", "type": "string" } }, "required": [ "id", "canonical_url", "title", "is_public", "age_tag", "created_at" ], "title": "SourceRead", "type": "object" }, "SourceTagRequest": { "description": "Body of ``POST /api/v1/newsbot/sources/{id}/tag``.", "properties": { "age_tag": { "enum": [ "general_audience", "young_adult", "adult_only", "unrated" ], "title": "Age Tag", "type": "string" } }, "required": [ "age_tag" ], "title": "SourceTagRequest", "type": "object" }, "SshKeyAdd": { "description": "Request body for adding or rotating an SSH private key.\n\nThe key is encrypted immediately and never returned via the API.\nProvider is stored as ``ssh:`` so each target host has a distinct\nlinked_identity row.", "properties": { "host": { "description": "Hostname or IP address of the target server. Only letters, digits, dots, hyphens, and underscores are allowed \u2014 must match what the `ssh` connector accepts at exec time.", "maxLength": 59, "minLength": 1, "pattern": "^[A-Za-z0-9._-]+$", "title": "Host", "type": "string" }, "label": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "description": "Human-readable label for this key (defaults to username@host:port)", "title": "Label" }, "port": { "default": 22, "description": "SSH port (default 22)", "maximum": 65535.0, "minimum": 1.0, "title": "Port", "type": "integer" }, "private_key": { "description": "PEM or OpenSSH private key material (Ed25519, RSA, ECDSA, or DSS)", "minLength": 40, "title": "Private Key", "type": "string" }, "username": { "description": "SSH username (letters, digits, dots, hyphens, underscores).", "maxLength": 64, "minLength": 1, "pattern": "^[A-Za-z0-9._-]+$", "title": "Username", "type": "string" } }, "required": [ "host", "username", "private_key" ], "title": "SshKeyAdd", "type": "object" }, "StartLinkResponse": { "description": "Returned by the ``start`` route.\n\n``authorize_url`` is the full upstream URL the browser must follow to begin\nthe OAuth dance. ``state`` is included so a JSON client (mobile, integration\ntests) can verify it matches the eventual callback \u2014 browser SPAs normally\nonly need the URL.", "properties": { "authorize_url": { "title": "Authorize Url", "type": "string" }, "state": { "title": "State", "type": "string" } }, "required": [ "authorize_url", "state" ], "title": "StartLinkResponse", "type": "object" }, "StatusAlertCreate": { "properties": { "body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Body" }, "platform_wide": { "default": false, "description": "If true, alert applies to all tenants. SuperAdmin only.", "title": "Platform Wide", "type": "boolean" }, "severity": { "enum": [ "info", "warning", "error", "critical" ], "title": "Severity", "type": "string" }, "title": { "maxLength": 512, "minLength": 1, "title": "Title", "type": "string" } }, "required": [ "title" ], "title": "StatusAlertCreate", "type": "object" }, "StatusAlertPatch": { "properties": { "body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Body" }, "severity": { "anyOf": [ { "enum": [ "info", "warning", "error", "critical" ], "type": "string" }, { "type": "null" } ], "title": "Severity" }, "status": { "anyOf": [ { "enum": [ "active", "resolved" ], "type": "string" }, { "type": "null" } ], "title": "Status" }, "title": { "anyOf": [ { "maxLength": 512, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Title" } }, "title": "StatusAlertPatch", "type": "object" }, "StatusAlertRead": { "properties": { "body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Body" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "created_by_agent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By Agent Id" }, "created_by_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By User Id" }, "id": { "title": "Id", "type": "string" }, "resolved_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Resolved At" }, "severity": { "title": "Severity", "type": "string" }, "status": { "title": "Status", "type": "string" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" }, "title": { "title": "Title", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "title", "severity", "status", "created_at", "updated_at" ], "title": "StatusAlertRead", "type": "object" }, "StatusAlertTimelineRead": { "properties": { "body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Body" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "created_by_agent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By Agent Id" }, "created_by_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By User Id" }, "id": { "title": "Id", "type": "string" }, "resolved_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Resolved At" }, "severity": { "title": "Severity", "type": "string" }, "status": { "title": "Status", "type": "string" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" }, "title": { "title": "Title", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "updates": { "items": { "$ref": "#/components/schemas/StatusAlertUpdateRead" }, "title": "Updates", "type": "array" } }, "required": [ "id", "title", "severity", "status", "created_at", "updated_at" ], "title": "StatusAlertTimelineRead", "type": "object" }, "StatusAlertUpdateCreate": { "properties": { "body": { "minLength": 1, "title": "Body", "type": "string" } }, "required": [ "body" ], "title": "StatusAlertUpdateCreate", "type": "object" }, "StatusAlertUpdateRead": { "properties": { "alert_id": { "title": "Alert Id", "type": "string" }, "body": { "title": "Body", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "created_by_agent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By Agent Id" }, "created_by_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By User Id" }, "id": { "title": "Id", "type": "string" } }, "required": [ "id", "alert_id", "body", "created_at" ], "title": "StatusAlertUpdateRead", "type": "object" }, "StepUpGrantCreate": { "properties": { "purpose": { "$ref": "#/components/schemas/StepUpPurpose" } }, "required": [ "purpose" ], "title": "StepUpGrantCreate", "type": "object" }, "StepUpGrantRead": { "properties": { "expires_at": { "title": "Expires At", "type": "string" }, "grant_id": { "title": "Grant Id", "type": "string" }, "purpose": { "$ref": "#/components/schemas/StepUpPurpose" } }, "required": [ "grant_id", "purpose", "expires_at" ], "title": "StepUpGrantRead", "type": "object" }, "StepUpPurpose": { "description": "What a reauth authorizes. A grant for one purpose never covers another.", "enum": [ "agent_persona", "agent_ssh_key", "model_pricing", "plan_billing", "tenant_plan_change", "tenant_group_sensitive", "dev_env_ide_open", "workspace_settlement", "documents_bulk_delete", "agent_editor_access", "operator_cluster_restart", "github_app_connect", "export_transcript" ], "title": "StepUpPurpose", "type": "string" }, "SubscriptionRead": { "description": "Current plan + Stripe lifecycle status for a tenant.", "properties": { "plan_code": { "title": "Plan Code", "type": "string" }, "plan_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Plan Id", "type": "string" }, "plan_status": { "enum": [ "trialing", "active", "past_due", "canceled" ], "title": "Plan Status", "type": "string" }, "stripe_customer_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stripe Customer Id" }, "stripe_enterprise_subscription_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stripe Enterprise Subscription Id" }, "stripe_langflow_subscription_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stripe Langflow Subscription Id" }, "stripe_subscription_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stripe Subscription Id" }, "stripe_support_subscription_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stripe Support Subscription Id" } }, "required": [ "plan_id", "plan_code", "plan_status", "stripe_customer_id", "stripe_subscription_id" ], "title": "SubscriptionRead", "type": "object" }, "SubtaskCancelRequest": { "description": "Body for `POST .../sessions/{session_id}/subtasks/cancel` (#3124).\n\nSelective reap: cancel exactly the listed descendant subtasks. Ids that are\nnot active descendants of this session (already terminal, or not in its\nsubtree) are silently ignored \u2014 the response reports what was actually\ncancelled, and a foreign id can never reach another session's row.", "properties": { "subtask_session_ids": { "items": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, "maxItems": 200, "minItems": 1, "title": "Subtask Session Ids", "type": "array" } }, "required": [ "subtask_session_ids" ], "title": "SubtaskCancelRequest", "type": "object" }, "SubtaskCancelResponse": { "description": "Response for the two reap paths (#3124): the subtasks actually cancelled.", "properties": { "cancelled": { "items": { "$ref": "#/components/schemas/SubtaskSummary" }, "title": "Cancelled", "type": "array" }, "count": { "title": "Count", "type": "integer" } }, "required": [ "cancelled", "count" ], "title": "SubtaskCancelResponse", "type": "object" }, "SubtaskSummary": { "description": "One active descendant subtask, for the reap picker (issue #3124).\n\nFlat entry in the \"running subtasks\" list a user sees when they stop, or\nwhen a parent thread reaches a terminal state with descendants still\nrunning. ``depth`` is the hop distance from the session being reaped (1 =\ndirect child) so the UI can indent nested subtasks.", "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "depth": { "title": "Depth", "type": "integer" }, "session_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Session Id", "type": "string" }, "status": { "title": "Status", "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" } }, "required": [ "session_id", "status", "depth", "created_at" ], "title": "SubtaskSummary", "type": "object" }, "SystemDefaultModelSet": { "description": "Request body for PUT /admin/models/system-default.", "properties": { "model_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Model Id", "type": "string" } }, "required": [ "model_id" ], "title": "SystemDefaultModelSet", "type": "object" }, "TaskMessageCreate": { "description": "Body for `POST /tenant/{t}/agent/{a}/sessions/{s}/messages`.\n\nContent is jsonb \u2014 typically `{\"text\": \"...\"}` for plain user messages but\ncan carry structured payloads (tool results, attachments). Role is locked\nto ``user``: browser-bound callers can't forge `assistant` / `system` /\n`tool` history. Internal callers (the agent SDK) inject those roles via\nthe internal API surface, not this route.", "properties": { "content": { "title": "Content", "type": "object" }, "editor": { "anyOf": [ { "$ref": "#/components/schemas/EditorTurn" }, { "type": "null" } ] }, "mentions": { "anyOf": [ { "items": { "$ref": "#/components/schemas/MentionItem" }, "type": "array" }, { "type": "null" } ], "title": "Mentions" }, "role": { "const": "user", "title": "Role", "type": "string" } }, "required": [ "content" ], "title": "TaskMessageCreate", "type": "object" }, "TaskMessageOut": { "description": "Response shape for a single persisted message.", "properties": { "author_display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author Display Name" }, "author_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author User Id" }, "content": { "title": "Content", "type": "object" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "title": "Id", "type": "string" }, "is_seed": { "default": false, "title": "Is Seed", "type": "boolean" }, "mentions": { "anyOf": [ { "items": { "$ref": "#/components/schemas/MentionItem" }, "type": "array" }, { "type": "null" } ], "title": "Mentions" }, "role": { "$ref": "#/components/schemas/TaskMessageRole" }, "session_id": { "title": "Session Id", "type": "string" }, "token_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Token Count" } }, "required": [ "id", "session_id", "role", "content", "token_count", "created_at" ], "title": "TaskMessageOut", "type": "object" }, "TaskMessageRead": { "properties": { "child_completion_tokens": { "default": 0, "title": "Child Completion Tokens", "type": "integer" }, "child_cost_cents": { "default": 0, "title": "Child Cost Cents", "type": "integer" }, "child_prompt_tokens": { "default": 0, "title": "Child Prompt Tokens", "type": "integer" }, "completion_tokens": { "default": 0, "title": "Completion Tokens", "type": "integer" }, "content": { "title": "Content", "type": "object" }, "cost_cents": { "default": 0, "title": "Cost Cents", "type": "integer" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "mentions": { "anyOf": [ { "items": { "$ref": "#/components/schemas/MentionItem" }, "type": "array" }, { "type": "null" } ], "title": "Mentions" }, "prompt_tokens": { "default": 0, "title": "Prompt Tokens", "type": "integer" }, "role": { "title": "Role", "type": "string" }, "session_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Session Id", "type": "string" }, "token_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Token Count" } }, "required": [ "id", "session_id", "role", "content", "created_at" ], "title": "TaskMessageRead", "type": "object" }, "TaskMessageRole": { "enum": [ "system", "user", "assistant", "tool" ], "title": "TaskMessageRole", "type": "string" }, "TaskSessionCreate": { "description": "Body for `POST /tenant/{t}/agent/{a}/sessions`.\n\n`initial_message` is optional \u2014 callers can create an idle session and post\nthe first message separately. `read_only` is propagated to the agent pod\nvia the `READ_ONLY` env var (decision #32) and blocks memory writes / repo\ncommits / cron mutations server-side.", "properties": { "initial_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Initial Message" }, "read_only": { "default": false, "title": "Read Only", "type": "boolean" }, "source_sha": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Sha" }, "title": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "title": "Title" } }, "title": "TaskSessionCreate", "type": "object" }, "TaskSessionDebugRead": { "description": "Full session dump for the tenant-admin debug view.", "properties": { "attributed_child_completion_tokens": { "default": 0, "title": "Attributed Child Completion Tokens", "type": "integer" }, "attributed_child_cost_cents": { "default": 0, "title": "Attributed Child Cost Cents", "type": "integer" }, "attributed_child_count": { "default": 0, "title": "Attributed Child Count", "type": "integer" }, "attributed_child_prompt_tokens": { "default": 0, "title": "Attributed Child Prompt Tokens", "type": "integer" }, "completion_tokens": { "default": 0, "title": "Completion Tokens", "type": "integer" }, "messages": { "items": { "$ref": "#/components/schemas/TaskMessageRead" }, "title": "Messages", "type": "array" }, "prompt_tokens": { "default": 0, "title": "Prompt Tokens", "type": "integer" }, "session": { "$ref": "#/components/schemas/TaskSessionRead" }, "total_cost_cents": { "default": 0, "title": "Total Cost Cents", "type": "integer" }, "total_incl_children_cost_cents": { "default": 0, "title": "Total Incl Children Cost Cents", "type": "integer" }, "total_tokens": { "title": "Total Tokens", "type": "integer" } }, "required": [ "session", "messages", "total_tokens" ], "title": "TaskSessionDebugRead", "type": "object" }, "TaskSessionRead": { "properties": { "agent_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Agent Id", "type": "string" }, "agent_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agent Name" }, "archived_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Archived At" }, "boot_phase": { "anyOf": [ { "enum": [ "not_yet_created", "scheduling", "pulling_image", "cloning_repo", "mounting_workspace", "booting_agent", "running", "failed", "unknown" ], "type": "string" }, { "type": "null" } ], "title": "Boot Phase" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" }, "category_confidence": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Category Confidence" }, "completed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Completed At" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "created_by_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Created By Id" }, "failure_detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Failure Detail" }, "failure_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Failure Reason" }, "fork_message_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Fork Message Id" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "listen_mode": { "default": false, "title": "Listen Mode", "type": "boolean" }, "next_retry_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Next Retry At" }, "parent_relationship": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Relationship" }, "parent_session_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Parent Session Id" }, "pod_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pod Name" }, "read_only": { "title": "Read Only", "type": "boolean" }, "retry_count": { "default": 0, "title": "Retry Count", "type": "integer" }, "source_sha": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Sha" }, "started_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Started At" }, "status": { "title": "Status", "type": "string" }, "task_state": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Task State" }, "task_state_version": { "default": 0, "title": "Task State Version", "type": "integer" }, "tenant_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Tenant Id", "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "tenant_id", "agent_id", "status", "read_only", "created_at", "updated_at" ], "title": "TaskSessionRead", "type": "object" }, "TaskSummary30d": { "properties": { "total_messages": { "title": "Total Messages", "type": "integer" }, "total_sessions": { "title": "Total Sessions", "type": "integer" } }, "required": [ "total_sessions", "total_messages" ], "title": "TaskSummary30d", "type": "object" }, "TenantAgentRead": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "created_by_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Created By Id" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "invocations_30d": { "title": "Invocations 30D", "type": "integer" }, "is_active": { "title": "Is Active", "type": "boolean" }, "is_seed": { "title": "Is Seed", "type": "boolean" }, "last_invoked_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Last Invoked At" }, "name": { "title": "Name", "type": "string" }, "slug": { "title": "Slug", "type": "string" } }, "required": [ "id", "name", "slug", "created_by_id", "is_active", "is_seed", "created_at", "last_invoked_at", "invocations_30d" ], "title": "TenantAgentRead", "type": "object" }, "TenantAllowedAccountCreate": { "properties": { "auto_role": { "minLength": 1, "title": "Auto Role", "type": "string" }, "pattern": { "maxLength": 253, "minLength": 1, "title": "Pattern", "type": "string" } }, "required": [ "pattern", "auto_role" ], "title": "TenantAllowedAccountCreate", "type": "object" }, "TenantAllowedAccountRead": { "properties": { "auto_role": { "title": "Auto Role", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "pattern": { "title": "Pattern", "type": "string" } }, "required": [ "id", "pattern", "auto_role", "created_at" ], "title": "TenantAllowedAccountRead", "type": "object" }, "TenantBrandFaviconUploaded": { "description": "Returned by the favicon-upload endpoint.", "properties": { "favicon_content_type": { "title": "Favicon Content Type", "type": "string" }, "favicon_sha256": { "title": "Favicon Sha256", "type": "string" }, "favicon_size_bytes": { "title": "Favicon Size Bytes", "type": "integer" }, "tenant_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Tenant Id", "type": "string" } }, "required": [ "tenant_id", "favicon_sha256", "favicon_content_type", "favicon_size_bytes" ], "title": "TenantBrandFaviconUploaded", "type": "object" }, "TenantBrandLogoUploaded": { "description": "Returned by the logo-upload endpoint.", "properties": { "logo_content_type": { "title": "Logo Content Type", "type": "string" }, "logo_sha256": { "title": "Logo Sha256", "type": "string" }, "logo_size_bytes": { "title": "Logo Size Bytes", "type": "integer" }, "tenant_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Tenant Id", "type": "string" } }, "required": [ "tenant_id", "logo_sha256", "logo_content_type", "logo_size_bytes" ], "title": "TenantBrandLogoUploaded", "type": "object" }, "TenantBrandRead": { "properties": { "accent_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accent Color" }, "background_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Background Color" }, "contrast_warnings": { "items": { "type": "string" }, "title": "Contrast Warnings", "type": "array" }, "default_appearance": { "$ref": "#/components/schemas/ThemePreference", "default": "system" }, "favicon_content_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Favicon Content Type" }, "favicon_sha256": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Favicon Sha256" }, "favicon_size_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Favicon Size Bytes" }, "has_favicon": { "default": false, "title": "Has Favicon", "type": "boolean" }, "has_logo": { "title": "Has Logo", "type": "boolean" }, "logo_content_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Logo Content Type" }, "logo_sha256": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Logo Sha256" }, "logo_size_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Logo Size Bytes" }, "primary_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Primary Color" }, "secondary_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Secondary Color" }, "tenant_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Tenant Id", "type": "string" }, "text_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Text Color" }, "theme_extra": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Theme Extra" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "required": [ "tenant_id", "has_logo" ], "title": "TenantBrandRead", "type": "object" }, "TenantBrandUpdate": { "description": "Partial-update for theme tokens. Logo is uploaded via the separate\nmultipart endpoint. Pass ``null`` for a colour field to clear it.", "properties": { "accent_color": { "anyOf": [ { "pattern": "^#[0-9A-Fa-f]{6}$", "type": "string" }, { "type": "null" } ], "title": "Accent Color" }, "background_color": { "anyOf": [ { "pattern": "^#[0-9A-Fa-f]{6}$", "type": "string" }, { "type": "null" } ], "title": "Background Color" }, "default_appearance": { "anyOf": [ { "$ref": "#/components/schemas/ThemePreference" }, { "type": "null" } ] }, "primary_color": { "anyOf": [ { "pattern": "^#[0-9A-Fa-f]{6}$", "type": "string" }, { "type": "null" } ], "title": "Primary Color" }, "secondary_color": { "anyOf": [ { "pattern": "^#[0-9A-Fa-f]{6}$", "type": "string" }, { "type": "null" } ], "title": "Secondary Color" }, "text_color": { "anyOf": [ { "pattern": "^#[0-9A-Fa-f]{6}$", "type": "string" }, { "type": "null" } ], "title": "Text Color" }, "theme_extra": { "anyOf": [ { "$ref": "#/components/schemas/TenantThemeExtra" }, { "type": "null" } ] } }, "title": "TenantBrandUpdate", "type": "object" }, "TenantCreate": { "properties": { "billing_email": { "anyOf": [ { "format": "email", "type": "string" }, { "type": "null" } ], "title": "Billing Email" }, "name": { "maxLength": 255, "minLength": 1, "title": "Name", "type": "string" }, "plan_code": { "default": "FREE", "title": "Plan Code", "type": "string" }, "seed_profile": { "default": "default", "title": "Seed Profile", "type": "string" }, "slug": { "maxLength": 64, "minLength": 1, "pattern": "^[a-z0-9][a-z0-9-]{0,63}$", "title": "Slug", "type": "string" } }, "required": [ "name", "slug" ], "title": "TenantCreate", "type": "object" }, "TenantEntitlementsRead": { "properties": { "allow_byo_models": { "title": "Allow Byo Models", "type": "boolean" }, "allowed_merge_categories": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Allowed Merge Categories" }, "apps": { "additionalProperties": { "type": "boolean" }, "title": "Apps", "type": "object" }, "budgets": { "additionalProperties": { "additionalProperties": { "type": "number" }, "type": "object" }, "title": "Budgets", "type": "object" }, "plan_code": { "title": "Plan Code", "type": "string" } }, "required": [ "plan_code", "apps", "allow_byo_models", "allowed_merge_categories", "budgets" ], "title": "TenantEntitlementsRead", "type": "object" }, "TenantGroupCreate": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "name": { "maxLength": 128, "minLength": 1, "title": "Name", "type": "string" } }, "required": [ "name" ], "title": "TenantGroupCreate", "type": "object" }, "TenantGroupDetail": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "managers": { "items": { "$ref": "#/components/schemas/GroupManagerRead" }, "title": "Managers", "type": "array" }, "members": { "items": { "$ref": "#/components/schemas/GroupMemberRead" }, "title": "Members", "type": "array" }, "name": { "title": "Name", "type": "string" }, "tenant_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Tenant Id", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "tenant_id", "name", "members", "managers", "created_at", "updated_at" ], "title": "TenantGroupDetail", "type": "object" }, "TenantGroupPermissionRead": { "description": "Capability flags a group grants its **user** members (#424).\n\n``inert_for_agent_members`` is always ``True`` today: these flags gate user\nactions and there is no agent-side capability gate yet, so an agent that is a\ngroup member gains nothing. The admin UI must surface this so a grant is not\nmistaken for conferring an agent a capability it cannot use.", "properties": { "can_create_agents": { "default": false, "title": "Can Create Agents", "type": "boolean" }, "can_create_skills": { "default": false, "title": "Can Create Skills", "type": "boolean" }, "can_invite_users": { "default": false, "title": "Can Invite Users", "type": "boolean" }, "can_manage_settings": { "default": false, "title": "Can Manage Settings", "type": "boolean" }, "can_view_billing": { "default": false, "title": "Can View Billing", "type": "boolean" }, "group_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Group Id", "type": "string" }, "inert_for_agent_members": { "default": true, "title": "Inert For Agent Members", "type": "boolean" } }, "required": [ "group_id" ], "title": "TenantGroupPermissionRead", "type": "object" }, "TenantGroupPermissionUpdate": { "description": "Update body for a group's capability grant \u2014 all optional (patch subset).", "properties": { "can_create_agents": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Can Create Agents" }, "can_create_skills": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Can Create Skills" }, "can_invite_users": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Can Invite Users" }, "can_manage_settings": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Can Manage Settings" }, "can_view_billing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Can View Billing" } }, "title": "TenantGroupPermissionUpdate", "type": "object" }, "TenantGroupRead": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "manager_count": { "default": 0, "title": "Manager Count", "type": "integer" }, "member_count": { "default": 0, "title": "Member Count", "type": "integer" }, "name": { "title": "Name", "type": "string" }, "tenant_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Tenant Id", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "tenant_id", "name", "created_at", "updated_at" ], "title": "TenantGroupRead", "type": "object" }, "TenantGroupSummary": { "description": "A group as seen by a member on the \"my groups\" surface.", "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "is_manager": { "default": false, "title": "Is Manager", "type": "boolean" }, "name": { "title": "Name", "type": "string" }, "tenant_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Tenant Id", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "tenant_id", "name", "created_at", "updated_at" ], "title": "TenantGroupSummary", "type": "object" }, "TenantGroupUpdate": { "description": "Rename / re-describe. Omitting a field leaves it; sending ``null`` on\n``description`` clears it (the route reads ``model_fields_set``).", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "name": { "anyOf": [ { "maxLength": 128, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Name" } }, "title": "TenantGroupUpdate", "type": "object" }, "TenantGuardrailDefaultsRead": { "description": "Response schema for GET /tenants/{id}/guardrail-defaults.\n\nAll fields are nullable \u2014 ``None`` means \"no tenant default set;\nplatform default applies\".", "properties": { "built_in": { "anyOf": [ { "$ref": "#/components/schemas/BuiltInDefaults" }, { "type": "null" } ] }, "egress_allowlist": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Egress Allowlist" }, "embedding_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Embedding Model" }, "llama_guard_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Llama Guard Model" }, "prompt_guard_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prompt Guard Model" } }, "title": "TenantGuardrailDefaultsRead", "type": "object" }, "TenantGuardrailDefaultsUpdate": { "description": "Partial-update body for PUT /tenants/{id}/guardrail-defaults.\n\nFields present in the request body are written; omitted fields are\nleft untouched. Sending a field as ``null`` clears the override and\nfalls back to the platform default.", "properties": { "built_in": { "anyOf": [ { "$ref": "#/components/schemas/BuiltInDefaults" }, { "type": "null" } ] }, "egress_allowlist": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Egress Allowlist" }, "embedding_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Embedding Model" }, "llama_guard_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Llama Guard Model" }, "prompt_guard_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prompt Guard Model" } }, "title": "TenantGuardrailDefaultsUpdate", "type": "object" }, "TenantIdentityCreate": { "description": "Body for saving a BYOK credential in tenant_identity.\n\n`provider` must match the `tenant_identity.provider` convention:\n`model:` for model BYOK keys (e.g. `model:openrouter`).\nThe plaintext `access_token` is encrypted immediately and never persisted\nin clear (CLAUDE.md decision #14).", "properties": { "access_token": { "minLength": 1, "title": "Access Token", "type": "string" }, "external_account_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Account Id" }, "provider": { "maxLength": 64, "minLength": 1, "title": "Provider", "type": "string" } }, "required": [ "provider", "access_token" ], "title": "TenantIdentityCreate", "type": "object" }, "TenantIdentityRead": { "description": "Public projection of `tenant_identity`. Never includes tokens.", "properties": { "external_account_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Account Id" }, "id": { "title": "Id", "type": "string" }, "needs_relink": { "default": false, "title": "Needs Relink", "type": "boolean" }, "provider": { "title": "Provider", "type": "string" }, "scopes": { "items": { "type": "string" }, "title": "Scopes", "type": "array" } }, "required": [ "id", "provider", "external_account_id", "scopes" ], "title": "TenantIdentityRead", "type": "object" }, "TenantIntegrationRead": { "description": "Public projection of a tenant-wide integration.\n\nMirrors the ``TenantIntegration`` interface in\n``front-end/src/pages/tenants/[tenantId]/organization/integrations.astro``.", "properties": { "connected": { "title": "Connected", "type": "boolean" }, "label": { "title": "Label", "type": "string" }, "provider": { "title": "Provider", "type": "string" }, "scope": { "title": "Scope", "type": "string" } }, "required": [ "provider", "label", "connected", "scope" ], "title": "TenantIntegrationRead", "type": "object" }, "TenantMailboxRow": { "description": "One mailbox row for the tenant-admin Mail page.\n\n``is_paused`` mirrors the SuperAdmin schema: paused == ``mailbox.is_active``\nis false. Tenant admins can see the state but cannot toggle it from this\nsurface (decision per ``mail.md``: \"Tenant admins cannot create or delete\nmailboxes\" \u2014 pause is a SuperAdmin lever).", "properties": { "address": { "title": "Address", "type": "string" }, "agent_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agent Name" }, "bounce_count_7d": { "title": "Bounce Count 7D", "type": "integer" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "is_paused": { "title": "Is Paused", "type": "boolean" }, "message_count_7d": { "title": "Message Count 7D", "type": "integer" }, "service": { "enum": [ "internal", "external" ], "title": "Service", "type": "string" } }, "required": [ "id", "address", "service", "agent_name", "message_count_7d", "bounce_count_7d", "is_paused" ], "title": "TenantMailboxRow", "type": "object" }, "TenantMember": { "properties": { "email": { "title": "Email", "type": "string" }, "joined_at": { "format": "date-time", "title": "Joined At", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "role": { "title": "Role", "type": "string" }, "status": { "enum": [ "active", "invited" ], "title": "Status", "type": "string" }, "user_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "User Id", "type": "string" } }, "required": [ "user_id", "email", "name", "role", "status", "joined_at" ], "title": "TenantMember", "type": "object" }, "TenantMemberRead": { "properties": { "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "email": { "title": "Email", "type": "string" }, "is_super_admin": { "title": "Is Super Admin", "type": "boolean" }, "joined_at": { "format": "date-time", "title": "Joined At", "type": "string" }, "role": { "title": "Role", "type": "string" }, "user_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "User Id", "type": "string" } }, "required": [ "user_id", "email", "display_name", "role", "is_super_admin", "joined_at" ], "title": "TenantMemberRead", "type": "object" }, "TenantMembershipRead": { "properties": { "is_default": { "title": "Is Default", "type": "boolean" }, "joined_at": { "format": "date-time", "title": "Joined At", "type": "string" }, "plan_code": { "title": "Plan Code", "type": "string" }, "plan_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Plan Id", "type": "string" }, "role": { "title": "Role", "type": "string" }, "tenant_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Tenant Id", "type": "string" }, "tenant_name": { "title": "Tenant Name", "type": "string" }, "tenant_slug": { "title": "Tenant Slug", "type": "string" } }, "required": [ "tenant_id", "tenant_name", "tenant_slug", "plan_id", "plan_code", "role", "is_default", "joined_at" ], "title": "TenantMembershipRead", "type": "object" }, "TenantModelGrant": { "properties": { "status": { "enum": [ "active", "disabled", "experimental", "deprecated" ], "title": "Status", "type": "string" } }, "title": "TenantModelGrant", "type": "object" }, "TenantModelListItem": { "description": "``ModelRead`` plus the per-tenant grant status. The tenant org models\npage needs both: ``status`` is the global ``Model.status`` (drives the\n\"globally disabled \u2014 not toggleable\" affordance) and ``tenant_status``\nis the ``tenant_model.status`` override the tenant admin flips on/off.", "properties": { "available_to_all_tenants": { "default": false, "title": "Available To All Tenants", "type": "boolean" }, "config": { "title": "Config", "type": "object" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "endpoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Endpoint" }, "failover_chain": { "items": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, "title": "Failover Chain", "type": "array" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "is_free": { "title": "Is Free", "type": "boolean" }, "is_system_default": { "default": false, "title": "Is System Default", "type": "boolean" }, "kind": { "title": "Kind", "type": "string" }, "name": { "title": "Name", "type": "string" }, "owner_user_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Owner User Id", "type": "string" }, "owning_tenant_id": { "anyOf": [ { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "type": "string" }, { "type": "null" } ], "title": "Owning Tenant Id" }, "pricing": { "title": "Pricing", "type": "object" }, "status": { "title": "Status", "type": "string" }, "tenant_status": { "title": "Tenant Status", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "owner_user_id", "name", "description", "kind", "status", "is_free", "config", "pricing", "endpoint", "created_at", "updated_at", "tenant_status" ], "title": "TenantModelListItem", "type": "object" }, "TenantModelRead": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "model_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Model Id", "type": "string" }, "status": { "title": "Status", "type": "string" }, "tenant_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Tenant Id", "type": "string" } }, "required": [ "tenant_id", "model_id", "status", "created_at" ], "title": "TenantModelRead", "type": "object" }, "TenantPaidRequest": { "properties": { "paid": { "title": "Paid", "type": "boolean" } }, "required": [ "paid" ], "title": "TenantPaidRequest", "type": "object" }, "TenantPlanChangeRequest": { "description": "``POST /tenant/{t}/billing/change-plan``. Only a plan code.\n\nEvery price, quantity and the tenant come from the server; any other field\nin the body (``price_id``, ``unit_amount``, ``quantity``, ``tenant_id`` \u2026)\nis ignored.", "properties": { "plan_code": { "maxLength": 32, "minLength": 1, "title": "Plan Code", "type": "string" } }, "required": [ "plan_code" ], "title": "TenantPlanChangeRequest", "type": "object" }, "TenantPlanChangeResult": { "properties": { "from_plan_code": { "title": "From Plan Code", "type": "string" }, "plan_code": { "title": "Plan Code", "type": "string" }, "session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Session Id" }, "status": { "title": "Status", "type": "string" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" } }, "required": [ "status", "from_plan_code", "plan_code" ], "title": "TenantPlanChangeResult", "type": "object" }, "TenantPlanOverridesRead": { "description": "A tenant's sparse overrides, its plan, and the resolved result.", "properties": { "effective": { "$ref": "#/components/schemas/EffectiveTerms" }, "overrides": { "title": "Overrides", "type": "object" }, "plan": { "$ref": "#/components/schemas/PlanRead" }, "tenant_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Tenant Id", "type": "string" } }, "required": [ "tenant_id", "plan", "overrides", "effective" ], "title": "TenantPlanOverridesRead", "type": "object" }, "TenantRead": { "properties": { "abandoned_warning_sent_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Abandoned Warning Sent At" }, "allow_superadmin_access": { "default": true, "title": "Allow Superadmin Access", "type": "boolean" }, "billing_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Billing Email" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "default_skill_visibility_scope": { "enum": [ "private_only", "tenant_allowed" ], "title": "Default Skill Visibility Scope", "type": "string" }, "external_mail_enabled": { "default": false, "title": "External Mail Enabled", "type": "boolean" }, "id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Id", "type": "string" }, "is_suspended": { "default": false, "title": "Is Suspended", "type": "boolean" }, "name": { "title": "Name", "type": "string" }, "paid": { "default": false, "title": "Paid", "type": "boolean" }, "plan_id": { "maxLength": 25, "minLength": 25, "pattern": "^c[a-z0-9]{24}$", "title": "Plan Id", "type": "string" }, "slug": { "title": "Slug", "type": "string" }, "status": { "$ref": "#/components/schemas/TenantStatus", "default": "active" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "voicebox_enabled": { "default": false, "title": "Voicebox Enabled", "type": "boolean" } }, "required": [ "id", "name", "slug", "plan_id", "billing_email", "created_at", "updated_at" ], "title": "TenantRead", "type": "object" }, "TenantSkillVisibilityScopeUpdate": { "description": "PUT body for ``/tenants/{tenant_id}/skill-visibility-scope-default``.\n\nSets the tenant-wide default that seeds ``skill_visibility_scope`` on\nnewly created agents. Existing agents are not retroactively changed.\nSee issue #550 and SkillVisibilityScope in models/agent.py.", "properties": { "default_skill_visibility_scope": { "enum": [ "private_only", "tenant_allowed" ], "title": "Default Skill Visibility Scope", "type": "string" } }, "required": [ "default_skill_visibility_scope" ], "title": "TenantSkillVisibilityScopeUpdate", "type": "object" }, "TenantStatus": { "description": "Tenant lifecycle status, orthogonal to the Stripe subscription state.\n\n``pending_payment`` \u2014 tenant created but Stripe checkout not yet completed.\n``active`` \u2014 fully usable (FREE auto-activates; paid activates on checkout).\n``suspended`` \u2014 administratively suspended; all mutating operations blocked.", "enum": [ "pending_payment", "active", "suspended" ], "title": "TenantStatus", "type": "string" }, "TenantThemeExtra": { "description": "Validated shape for ``tenant_brand.theme_extra``.\n\n``light`` / ``dark`` are each an optional ``{token: \"#RRGGBB\"}`` map. Both\nthe token names (must be in :data:`BRAND_TOKENS`) and the values (must match\n``#RRGGBB``) are validated, so a bad token name or an injection payload is a\n422 and can never reach a rendered ``