{ "openapi": "3.1.0", "info": { "title": "Hubrix API", "summary": "The AI workspace API for consultancies and modern teams.", "description": "## Welcome to the Hubrix API\n\nThe Hubrix API gives you programmatic access to every feature of the Hubrix AI Workspace:\nchat, custom agents, visual workflow automation, deep research, bulk processing, document storage,\ncloud data connectors, billing, and team workspaces.\n\n### Base URLs\n\n| Environment | URL |\n|-------------|-----|\n| Production | `https://api.hubrix.ai/v1` |\n| Staging | `https://dev2.hubrix.ai/api/v1` |\n\nAll paths in this reference are shown relative to the base URL (e.g. `POST /auth/login`\nmaps to `POST https://api.hubrix.ai/v1/auth/login` in production).\n\n### Authentication\n\nAll endpoints require a `Bearer` token in the `Authorization` header unless explicitly\nmarked **Public**. Obtain a token by:\n\n1. **Email/password** — `POST /auth/login` → `{access_token, refresh_token}`\n2. **Google SSO** — `GET /auth/google/start` → redirect → `GET /auth/google/callback`\n3. **Microsoft SSO** — `GET /auth/microsoft/start` → redirect → `GET /auth/microsoft/callback`\n\nAccess tokens expire after **15 minutes**. Use `POST /auth/refresh` with the `refresh_token`\n(valid 30 days, rotated on each use) to obtain a new access token without re-authentication.\n\nAPI keys (format: `hbx_…`) authenticate as a company without user context. Issue them from\n**Settings → API Keys** in the Hubrix UI.\n\n### Versioning\n\nWe use CalVer (`YYYY.MM.DD`) shown in `info.version` and returned on every response in the\n`X-Hubrix-Version` header. We commit to:\n\n- **Backward-compatible additions** — new endpoints, new optional fields — at any time.\n- **Breaking changes** — at most quarterly, with 90-day deprecation notice, changelog entry,\n `Sunset` header on deprecated endpoints, and email to active integrators.\n\nPin to a specific version by sending `X-Hubrix-API-Version: 2026.05.04`. We serve the\nrequested version for its full deprecation window.\n\n### Rate Limits\n\nRate limit state is returned on every response:\n\n| Header | Description |\n|--------|-------------|\n| `X-RateLimit-Limit` | Maximum requests allowed in the window |\n| `X-RateLimit-Remaining` | Requests remaining in the current window |\n| `X-RateLimit-Reset` | Unix epoch when the window resets |\n\nOn `429 Too Many Requests`, wait until `X-RateLimit-Reset` or use exponential backoff\nstarting at 1 second. See the [Rate Limits guide](https://api.hubrix.ai/rate-limits).\n\n### Errors\n\nAll errors follow [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457):\n\n```json\n{\n \"type\": \"https://api.hubrix.ai/errors/insufficient_credits\",\n \"title\": \"Insufficient credits\",\n \"status\": 402,\n \"detail\": \"This action requires 60 credits; current balance is 13.\",\n \"instance\": \"/v1/research\",\n \"request_id\": \"req_01HZ3K9...\"\n}\n```\n\nResponses use `Content-Type: application/problem+json`. See the full\n[error code reference](https://api.hubrix.ai/errors).\n\n### Credits\n\nAI operations consume credits from your company's monthly allocation. Each endpoint that\ncosts credits documents its credit cost in the description. The billing flow is:\n\n1. `reserve()` — credits reserved before the operation starts\n2. `commit()` — reserved credits converted to used on success\n3. `refund()` — reserved credits returned on failure\n\nCheck your balance at `GET /billing/credits`. Top up at `POST /billing/topup`.\n\n### SDKs\n\nOfficial SDKs:\n\n- **Python** — `pip install hubrix` · [Quickstart](https://api.hubrix.ai/sdks/python)\n- **JavaScript/TypeScript** — `npm install @hubrix/sdk` · [Quickstart](https://api.hubrix.ai/sdks/javascript)\n- **Swift** — SPM package · [Quickstart](https://api.hubrix.ai/sdks/swift) *(preview)*\n\n### Webhooks\n\nHubrix sends signed webhooks for billing events, workflow completions, and job state changes.\nSee [Webhooks](https://api.hubrix.ai/webhooks).\n\n### Support\n\n- **API issues**: [api@hubrix.ai](mailto:api@hubrix.ai)\n- **Documentation**: [hubrix.ai/contact](https://hubrix.ai/contact)\n- **Engineering blog**: [docs.hubrix.ai/engineering](https://docs.hubrix.ai/engineering)\n", "termsOfService": "https://hubrix.ai/legal/terms", "contact": { "name": "Hubrix Engineering", "url": "https://hubrix.ai/contact", "email": "api@hubrix.ai" }, "license": { "name": "Hubrix API Terms", "url": "https://hubrix.ai/legal/api-terms" }, "version": "2026.05.04" }, "servers": [ { "url": "https://api.hubrix.ai/v1", "description": "Production" }, { "url": "https://dev2.hubrix.ai/api/v1", "description": "Staging" } ], "paths": { "/api/v1/health": { "get": { "tags": [ "health" ], "summary": "Health Check", "operationId": "health_check_api_v1_health_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthResponse" } } } } } } }, "/api/v1/models": { "get": { "tags": [ "models" ], "summary": "List Models", "description": "List all non-blocked AI models with display names.", "operationId": "list_models_api_v1_models_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ModelItem" }, "type": "array", "title": "Response List Models Api V1 Models Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/admin/overview": { "get": { "tags": [ "admin" ], "summary": "Get Overview", "operationId": "get_overview_api_v1_admin_overview_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/admin/users": { "get": { "tags": [ "admin" ], "summary": "List Users", "operationId": "list_users_api_v1_admin_users_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "name": "role", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "default": "created_at", "title": "Sort" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 20, "title": "Per Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/users/{user_id}": { "get": { "tags": [ "admin" ], "summary": "Get User", "operationId": "get_user_api_v1_admin_users__user_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "User Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "admin" ], "summary": "Patch User", "operationId": "patch_user_api_v1_admin_users__user_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "User Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPatchRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "admin" ], "summary": "Delete User", "operationId": "delete_user_api_v1_admin_users__user_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "User Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/users/{user_id}/suspend": { "post": { "tags": [ "admin" ], "summary": "Suspend User", "operationId": "suspend_user_api_v1_admin_users__user_id__suspend_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "User Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuspendRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/users/{user_id}/unsuspend": { "post": { "tags": [ "admin" ], "summary": "Unsuspend User", "operationId": "unsuspend_user_api_v1_admin_users__user_id__unsuspend_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "User Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/users/{user_id}/reset-password": { "post": { "tags": [ "admin" ], "summary": "Reset Password", "operationId": "reset_password_api_v1_admin_users__user_id__reset_password_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "User Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/users/{user_id}/force-logout": { "post": { "tags": [ "admin" ], "summary": "Force Logout", "operationId": "force_logout_api_v1_admin_users__user_id__force_logout_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "User Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/users/{user_id}/disable-mfa": { "post": { "tags": [ "admin" ], "summary": "Disable Mfa", "operationId": "disable_mfa_api_v1_admin_users__user_id__disable_mfa_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "User Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/users/invite": { "post": { "tags": [ "admin" ], "summary": "Invite User", "description": "Legacy invite endpoint — kept for backwards compatibility.", "operationId": "invite_user_api_v1_admin_users_invite_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InviteRequest" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/admin/users/{user_id}/sessions": { "get": { "tags": [ "admin" ], "summary": "User Sessions", "operationId": "user_sessions_api_v1_admin_users__user_id__sessions_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "User Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/users/{user_id}/usage": { "get": { "tags": [ "admin" ], "summary": "User Usage", "operationId": "user_usage_api_v1_admin_users__user_id__usage_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "User Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/invitations": { "post": { "tags": [ "admin" ], "summary": "Create Invitation", "operationId": "create_invitation_api_v1_admin_invitations_post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvitationRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "admin" ], "summary": "List Invitations", "operationId": "list_invitations_api_v1_admin_invitations_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 20, "title": "Per Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/invitations/{invitation_id}/resend": { "post": { "tags": [ "admin" ], "summary": "Resend Invitation", "operationId": "resend_invitation_api_v1_admin_invitations__invitation_id__resend_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "invitation_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Invitation Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/invitations/{invitation_id}/revoke": { "post": { "tags": [ "admin" ], "summary": "Revoke Invitation", "operationId": "revoke_invitation_api_v1_admin_invitations__invitation_id__revoke_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "invitation_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Invitation Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/invitations/bulk": { "post": { "tags": [ "admin" ], "summary": "Bulk Invite", "operationId": "bulk_invite_api_v1_admin_invitations_bulk_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkInvitationRequest" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/admin/companies": { "get": { "tags": [ "admin" ], "summary": "List Companies", "operationId": "list_companies_api_v1_admin_companies_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 20, "title": "Per Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/companies/{company_id}": { "get": { "tags": [ "admin" ], "summary": "Get Company", "operationId": "get_company_api_v1_admin_companies__company_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Company Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "admin" ], "summary": "Patch Company", "operationId": "patch_company_api_v1_admin_companies__company_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Company Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyPatchRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/companies/{company_id}/credits/grant": { "post": { "tags": [ "admin" ], "summary": "Grant Credits", "operationId": "grant_credits_api_v1_admin_companies__company_id__credits_grant_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Company Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditGrantRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/companies/{company_id}/credits/revoke": { "post": { "tags": [ "admin" ], "summary": "Revoke Credits", "operationId": "revoke_credits_api_v1_admin_companies__company_id__credits_revoke_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Company Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditGrantRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/companies/{company_id}/audit": { "get": { "tags": [ "admin" ], "summary": "Company Audit", "operationId": "company_audit_api_v1_admin_companies__company_id__audit_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Company Id" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Per Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/billing/summary": { "get": { "tags": [ "admin" ], "summary": "Billing Summary", "operationId": "billing_summary_api_v1_admin_billing_summary_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/admin/billing/overview": { "get": { "tags": [ "admin" ], "summary": "Billing Overview", "description": "Platform-wide billing metrics. Superadmin only.", "operationId": "billing_overview_api_v1_admin_billing_overview_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/admin/billing/customers": { "get": { "tags": [ "admin" ], "summary": "Billing Customers", "description": "Paginated list of all companies with plan info. Superadmin only.", "operationId": "billing_customers_api_v1_admin_billing_customers_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 25, "title": "Per Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/billing/invoices": { "get": { "tags": [ "admin" ], "summary": "List Invoices", "operationId": "list_invoices_api_v1_admin_billing_invoices_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 20, "title": "Per Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/billing/transactions": { "get": { "tags": [ "admin" ], "summary": "List Transactions", "operationId": "list_transactions_api_v1_admin_billing_transactions_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Per Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/billing/plan/change": { "post": { "tags": [ "admin" ], "summary": "Change Plan", "operationId": "change_plan_api_v1_admin_billing_plan_change_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanChangeRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/admin/billing/topup/checkout": { "post": { "tags": [ "admin" ], "summary": "Topup Checkout", "operationId": "topup_checkout_api_v1_admin_billing_topup_checkout_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/app__modules__admin__billing__TopupRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/admin/billing/payment-methods": { "get": { "tags": [ "admin" ], "summary": "Payment Methods", "operationId": "payment_methods_api_v1_admin_billing_payment_methods_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/admin/usage": { "get": { "tags": [ "admin" ], "summary": "Get Usage", "operationId": "get_usage_api_v1_admin_usage_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "group_by", "in": "query", "required": false, "schema": { "type": "string", "default": "model", "title": "Group By" } }, { "name": "days", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 365, "minimum": 1, "default": 30, "title": "Days" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/usage/export": { "get": { "tags": [ "admin" ], "summary": "Export Usage", "operationId": "export_usage_api_v1_admin_usage_export_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "group_by", "in": "query", "required": false, "schema": { "type": "string", "default": "model", "title": "Group By" } }, { "name": "days", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 365, "minimum": 1, "default": 30, "title": "Days" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/models": { "get": { "tags": [ "admin" ], "summary": "List Models", "operationId": "list_models_api_v1_admin_models_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "HTTPBearer": [] } ] }, "post": { "tags": [ "admin" ], "summary": "Create Model", "operationId": "create_model_api_v1_admin_models_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelCreateRequest" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/admin/models/{model_id}": { "patch": { "tags": [ "admin" ], "summary": "Patch Model", "operationId": "patch_model_api_v1_admin_models__model_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "model_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Model Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelPatchRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/api-keys": { "get": { "tags": [ "admin" ], "summary": "List Api Keys", "operationId": "list_api_keys_api_v1_admin_api_keys_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "HTTPBearer": [] } ] }, "post": { "tags": [ "admin" ], "summary": "Create Api Key", "operationId": "create_api_key_api_v1_admin_api_keys_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/app__modules__admin__api_keys__ApiKeyCreateRequest" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/admin/api-keys/{key_id}": { "delete": { "tags": [ "admin" ], "summary": "Delete Api Key", "operationId": "delete_api_key_api_v1_admin_api_keys__key_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "key_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Key Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/connectors": { "get": { "tags": [ "admin" ], "summary": "List Connectors", "operationId": "list_connectors_api_v1_admin_connectors_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/admin/connectors/{name}/test": { "post": { "tags": [ "admin" ], "summary": "Test Connector", "operationId": "test_connector_api_v1_admin_connectors__name__test_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/connectors/{name}": { "patch": { "tags": [ "admin" ], "summary": "Update Connector", "operationId": "update_connector_api_v1_admin_connectors__name__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/security/policy": { "get": { "tags": [ "admin" ], "summary": "Get Policy", "operationId": "get_policy_api_v1_admin_security_policy_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "HTTPBearer": [] } ] }, "put": { "tags": [ "admin" ], "summary": "Put Policy", "operationId": "put_policy_api_v1_admin_security_policy_put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyPatchRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] }, "patch": { "tags": [ "admin" ], "summary": "Patch Policy", "description": "Alias for PUT to support both PUT and PATCH.", "operationId": "patch_policy_api_v1_admin_security_policy_patch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyPatchRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/admin/security/sessions": { "get": { "tags": [ "admin" ], "summary": "List Sessions", "description": "List active sessions from user_sessions table (falls back to refresh_tokens).", "operationId": "list_sessions_api_v1_admin_security_sessions_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Per Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/security/sessions/{session_id}/revoke": { "post": { "tags": [ "admin" ], "summary": "Revoke Session", "operationId": "revoke_session_api_v1_admin_security_sessions__session_id__revoke_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Session Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/security/sessions/{session_id}": { "delete": { "tags": [ "admin" ], "summary": "Revoke Session Delete", "description": "DELETE alias for backwards compatibility.", "operationId": "revoke_session_delete_api_v1_admin_security_sessions__session_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Session Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/security/login-attempts": { "get": { "tags": [ "admin" ], "summary": "Login Attempts", "description": "List login attempts from login_attempts table.", "operationId": "login_attempts_api_v1_admin_security_login_attempts_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Per Page" } }, { "name": "success", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Success" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/audit": { "get": { "tags": [ "admin" ], "summary": "List Audit", "operationId": "list_audit_api_v1_admin_audit_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "action", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action" } }, { "name": "user_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id" } }, { "name": "from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "From" } }, { "name": "to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "To" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Per Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/branding": { "get": { "tags": [ "admin" ], "summary": "Get Branding", "operationId": "get_branding_api_v1_admin_branding_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "HTTPBearer": [] } ] }, "patch": { "tags": [ "admin" ], "summary": "Patch Branding", "operationId": "patch_branding_api_v1_admin_branding_patch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrandingPatchRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/admin/branding/logo": { "post": { "tags": [ "admin" ], "summary": "Upload Logo", "operationId": "upload_logo_api_v1_admin_branding_logo_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_logo_api_v1_admin_branding_logo_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/admin/data/exports": { "get": { "tags": [ "admin" ], "summary": "List Exports", "operationId": "list_exports_api_v1_admin_data_exports_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "HTTPBearer": [] } ] }, "post": { "tags": [ "admin" ], "summary": "Create Export", "operationId": "create_export_api_v1_admin_data_exports_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportRequest" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/admin/data/exports/{export_id}": { "get": { "tags": [ "admin" ], "summary": "Get Export", "operationId": "get_export_api_v1_admin_data_exports__export_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "export_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Export Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/data/exports/{export_id}/download": { "get": { "tags": [ "admin" ], "summary": "Download Export", "operationId": "download_export_api_v1_admin_data_exports__export_id__download_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "export_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Export Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/data/purge": { "post": { "tags": [ "admin" ], "summary": "Purge Data", "operationId": "purge_data_api_v1_admin_data_purge_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurgeRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/admin/system/health": { "get": { "tags": [ "admin" ], "summary": "System Health", "operationId": "system_health_api_v1_admin_system_health_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/admin/system/logs": { "get": { "tags": [ "admin" ], "summary": "Get Logs", "operationId": "get_logs_api_v1_admin_system_logs_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "level", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Level" } }, { "name": "since", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Since" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 100, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/system/restart/{service}": { "post": { "tags": [ "admin" ], "summary": "Restart Service", "operationId": "restart_service_api_v1_admin_system_restart__service__post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "service", "in": "path", "required": true, "schema": { "type": "string", "title": "Service" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/system/cache/translate/clear": { "post": { "tags": [ "admin" ], "summary": "Clear Translate Cache", "description": "Delete all hubrix:translate:* Redis keys. Superadmin only.", "operationId": "clear_translate_cache_api_v1_admin_system_cache_translate_clear_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/admin/email/test": { "post": { "tags": [ "admin" ], "summary": "Test Email", "description": "Send a test email via the Resend service. Superadmin only.", "operationId": "test_email_api_v1_admin_email_test_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailTestRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/admin/email/log": { "get": { "tags": [ "admin" ], "summary": "Get Email Log", "description": "Return the email_log rows. Superadmin only.", "operationId": "get_email_log_api_v1_admin_email_log_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "title": "Q" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/me": { "get": { "tags": [ "admin" ], "summary": "Admin Me", "description": "Returns admin context — used by frontend to check admin status.", "operationId": "admin_me_api_v1_admin_me_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/auth/register": { "post": { "tags": [ "auth" ], "summary": "Register", "operationId": "register_api_v1_auth_register_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterRequest" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/auth/login": { "post": { "tags": [ "auth" ], "summary": "Login", "operationId": "login_api_v1_auth_login_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/auth/logout": { "post": { "tags": [ "auth" ], "summary": "Logout", "operationId": "logout_api_v1_auth_logout_post", "parameters": [ { "name": "hubrix_refresh", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hubrix Refresh" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/LogoutRequest" }, { "type": "null" } ], "title": "Body" } } } }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/auth/refresh": { "post": { "tags": [ "auth" ], "summary": "Refresh", "operationId": "refresh_api_v1_auth_refresh_post", "parameters": [ { "name": "hubrix_refresh", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hubrix Refresh" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/RefreshRequest" }, { "type": "null" } ], "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/auth/me": { "get": { "tags": [ "auth" ], "summary": "Me", "operationId": "me_api_v1_auth_me_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserResponse" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/auth/google": { "post": { "tags": [ "auth" ], "summary": "Google Oauth", "operationId": "google_oauth_api_v1_auth_google_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OAuthRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/auth/microsoft": { "post": { "tags": [ "auth" ], "summary": "Microsoft Oauth", "operationId": "microsoft_oauth_api_v1_auth_microsoft_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OAuthRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/auth/2fa/setup": { "post": { "tags": [ "auth" ], "summary": "Totp Setup", "operationId": "totp_setup_api_v1_auth_2fa_setup_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TOTPSetupResponse" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/auth/2fa/verify": { "post": { "tags": [ "auth" ], "summary": "Totp Verify", "operationId": "totp_verify_api_v1_auth_2fa_verify_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TOTPVerifyRequest" } } }, "required": true }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/auth/google/start": { "get": { "tags": [ "auth" ], "summary": "Google Start", "operationId": "google_start_api_v1_auth_google_start_get", "parameters": [ { "name": "return_to", "in": "query", "required": false, "schema": { "type": "string", "default": "/dashboard", "title": "Return To" } }, { "name": "locale", "in": "query", "required": false, "schema": { "type": "string", "default": "en", "title": "Locale" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/auth/google/callback": { "get": { "tags": [ "auth" ], "summary": "Google Callback", "operationId": "google_callback_api_v1_auth_google_callback_get", "parameters": [ { "name": "code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" } }, { "name": "state", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State" } }, { "name": "error", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/auth/microsoft/start": { "get": { "tags": [ "auth" ], "summary": "Microsoft Start", "operationId": "microsoft_start_api_v1_auth_microsoft_start_get", "parameters": [ { "name": "return_to", "in": "query", "required": false, "schema": { "type": "string", "default": "/dashboard", "title": "Return To" } }, { "name": "locale", "in": "query", "required": false, "schema": { "type": "string", "default": "en", "title": "Locale" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/auth/microsoft/callback": { "get": { "tags": [ "auth" ], "summary": "Microsoft Callback", "operationId": "microsoft_callback_api_v1_auth_microsoft_callback_get", "parameters": [ { "name": "code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" } }, { "name": "state", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State" } }, { "name": "error", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/auth/sso/linked": { "get": { "tags": [ "auth" ], "summary": "Sso Linked", "operationId": "sso_linked_api_v1_auth_sso_linked_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Response Sso Linked Api V1 Auth Sso Linked Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/auth/sso/unlink": { "post": { "tags": [ "auth" ], "summary": "Sso Unlink", "operationId": "sso_unlink_api_v1_auth_sso_unlink_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnlinkRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Sso Unlink Api V1 Auth Sso Unlink Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/auth/step-up": { "post": { "tags": [ "auth" ], "summary": "Step Up", "description": "Grant a step-up token valid for 5 minutes.", "operationId": "step_up_api_v1_auth_step_up_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StepUpRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Step Up Api V1 Auth Step Up Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/auth/invitations/preview": { "get": { "tags": [ "auth" ], "summary": "Preview Invitation", "description": "Public endpoint: preview invitation details by token.", "operationId": "preview_invitation_api_v1_auth_invitations_preview_get", "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string", "title": "Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/auth/invitations/accept": { "post": { "tags": [ "auth" ], "summary": "Accept Invitation", "description": "Public endpoint: accept invitation and create account.", "operationId": "accept_invitation_api_v1_auth_invitations_accept_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcceptInvitationRequest" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/tenancy/company": { "get": { "tags": [ "tenancy" ], "summary": "Get Company", "operationId": "get_company_api_v1_tenancy_company_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyResponse" } } } } }, "security": [ { "HTTPBearer": [] } ] }, "patch": { "tags": [ "tenancy" ], "summary": "Update Company", "operationId": "update_company_api_v1_tenancy_company_patch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/tenancy/members": { "get": { "tags": [ "tenancy" ], "summary": "List Members", "operationId": "list_members_api_v1_tenancy_members_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/app__modules__tenancy__schemas__MemberResponse" }, "type": "array", "title": "Response List Members Api V1 Tenancy Members Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/tenancy/members/invite": { "post": { "tags": [ "tenancy" ], "summary": "Invite Member", "operationId": "invite_member_api_v1_tenancy_members_invite_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InviteMemberRequest" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InviteResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/tenancy/members/{user_id}": { "delete": { "tags": [ "tenancy" ], "summary": "Remove Member", "operationId": "remove_member_api_v1_tenancy_members__user_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "User Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/tenancy/api-keys": { "get": { "tags": [ "tenancy" ], "summary": "List Api Keys", "operationId": "list_api_keys_api_v1_tenancy_api_keys_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ApiKeyResponse" }, "type": "array", "title": "Response List Api Keys Api V1 Tenancy Api Keys Get" } } } } }, "security": [ { "HTTPBearer": [] } ] }, "post": { "tags": [ "tenancy" ], "summary": "Create Api Key", "operationId": "create_api_key_api_v1_tenancy_api_keys_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/app__modules__tenancy__schemas__ApiKeyCreateRequest" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyCreatedResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/tenancy/api-keys/{key_id}": { "delete": { "tags": [ "tenancy" ], "summary": "Revoke Api Key", "operationId": "revoke_api_key_api_v1_tenancy_api_keys__key_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "key_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Key Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/billing/plans": { "get": { "tags": [ "billing" ], "summary": "List Plans", "operationId": "list_plans_api_v1_billing_plans_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/PlanResponse" }, "type": "array", "title": "Response List Plans Api V1 Billing Plans Get" } } } } } } }, "/api/v1/billing/subscription": { "get": { "tags": [ "billing" ], "summary": "Get Subscription", "operationId": "get_subscription_api_v1_billing_subscription_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionResponse" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/billing/checkout": { "post": { "tags": [ "billing" ], "summary": "Checkout", "operationId": "checkout_api_v1_billing_checkout_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckoutRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckoutResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/billing/portal": { "post": { "tags": [ "billing" ], "summary": "Portal", "operationId": "portal_api_v1_billing_portal_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/billing/credits": { "get": { "tags": [ "billing" ], "summary": "Get Credits", "operationId": "get_credits_api_v1_billing_credits_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditBalanceResponse" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/billing/credits/reserve": { "post": { "tags": [ "billing" ], "summary": "Reserve Credits", "operationId": "reserve_credits_api_v1_billing_credits_reserve_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReserveRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReserveResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/billing/credits/commit": { "post": { "tags": [ "billing" ], "summary": "Commit Credits", "operationId": "commit_credits_api_v1_billing_credits_commit_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommitRequest" } } }, "required": true }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/billing/credits/refund": { "post": { "tags": [ "billing" ], "summary": "Refund Credits", "operationId": "refund_credits_api_v1_billing_credits_refund_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefundRequest" } } }, "required": true }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/billing/topup-packages": { "get": { "tags": [ "billing" ], "summary": "List Topup Packages", "operationId": "list_topup_packages_api_v1_billing_topup_packages_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/TopupPackageResponse" }, "type": "array", "title": "Response List Topup Packages Api V1 Billing Topup Packages Get" } } } } } } }, "/api/v1/billing/topup": { "post": { "tags": [ "billing" ], "summary": "Topup Checkout", "operationId": "topup_checkout_api_v1_billing_topup_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/app__modules__billing__schemas__TopupRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckoutResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/billing/billing-config": { "get": { "tags": [ "billing" ], "summary": "Get Billing Config", "operationId": "get_billing_config_api_v1_billing_billing_config_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingConfigResponse" } } } } }, "security": [ { "HTTPBearer": [] } ] }, "patch": { "tags": [ "billing" ], "summary": "Update Billing Config", "operationId": "update_billing_config_api_v1_billing_billing_config_patch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingConfigUpdate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingConfigResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/chat/models": { "get": { "tags": [ "chat" ], "summary": "List Models", "operationId": "list_models_api_v1_chat_models_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ModelResponse" }, "type": "array", "title": "Response List Models Api V1 Chat Models Get" } } } } } } }, "/api/v1/chat/sessions": { "get": { "tags": [ "chat" ], "summary": "List Sessions", "operationId": "list_sessions_api_v1_chat_sessions_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Per Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "chat" ], "summary": "Create Session", "operationId": "create_session_api_v1_chat_sessions_post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSessionRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/chat/sessions/{session_id}": { "get": { "tags": [ "chat" ], "summary": "Get Session", "operationId": "get_session_api_v1_chat_sessions__session_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Session Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionWithMessagesResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "chat" ], "summary": "Update Session", "operationId": "update_session_api_v1_chat_sessions__session_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Session Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSessionRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "chat" ], "summary": "Archive Session", "operationId": "archive_session_api_v1_chat_sessions__session_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Session Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/chat/sessions/{session_id}/messages": { "post": { "tags": [ "chat" ], "summary": "Send Message", "description": "Send a user message and receive an SSE stream.\n\nEvent format:\n data: {\"type\": \"token\", \"content\": \"...\"}\n data: {\"type\": \"done\", \"usage\": {...}}\n data: {\"type\": \"error\", \"message\": \"...\"}", "operationId": "send_message_api_v1_chat_sessions__session_id__messages_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Session Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/app__modules__chat__schemas__SendMessageRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/chat/sessions/{session_id}/feedback": { "post": { "tags": [ "chat" ], "summary": "Set Feedback", "operationId": "set_feedback_api_v1_chat_sessions__session_id__feedback_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Session Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeedbackRequest" } } } }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/documents/upload": { "post": { "tags": [ "documents" ], "summary": "Upload Document", "operationId": "upload_document_api_v1_documents_upload_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_document_api_v1_documents_upload_post" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/documents": { "get": { "tags": [ "documents" ], "summary": "List Documents", "operationId": "list_documents_api_v1_documents_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Per Page" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "title": "Q" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/documents/{document_id}": { "get": { "tags": [ "documents" ], "summary": "Get Document", "operationId": "get_document_api_v1_documents__document_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "document_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Document Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "documents" ], "summary": "Delete Document", "operationId": "delete_document_api_v1_documents__document_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "document_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Document Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/documents/{document_id}/reindex": { "post": { "tags": [ "documents" ], "summary": "Reindex Document", "operationId": "reindex_document_api_v1_documents__document_id__reindex_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "document_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Document Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/documents/query": { "post": { "tags": [ "documents" ], "summary": "Query Documents", "operationId": "query_documents_api_v1_documents_query_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueryRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueryResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/agents/templates": { "get": { "tags": [ "agents" ], "summary": "List Templates", "operationId": "list_templates_api_v1_agents_templates_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/AgentTemplateResponse" }, "type": "array", "title": "Response List Templates Api V1 Agents Templates Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/agents/templates/from-template": { "post": { "tags": [ "agents" ], "summary": "Create From Template", "operationId": "create_from_template_api_v1_agents_templates_from_template_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FromTemplateRequest" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/agents/test": { "post": { "tags": [ "agents" ], "summary": "Test Agent", "operationId": "test_agent_api_v1_agents_test_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestAgentRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/agents": { "get": { "tags": [ "agents" ], "summary": "List Agents", "operationId": "list_agents_api_v1_agents_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Per Page" } }, { "name": "scope", "in": "query", "required": false, "schema": { "type": "string", "default": "all", "title": "Scope" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "title": "Q" } }, { "name": "tag", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 50 }, { "type": "null" } ], "title": "Tag" } }, { "name": "model", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ], "title": "Model" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "default": "updated", "title": "Sort" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "agents" ], "summary": "Create Agent", "operationId": "create_agent_api_v1_agents_post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAgentRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/agents/{agent_id}": { "get": { "tags": [ "agents" ], "summary": "Get Agent", "operationId": "get_agent_api_v1_agents__agent_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentDetailResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "agents" ], "summary": "Update Agent", "operationId": "update_agent_api_v1_agents__agent_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAgentRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "agents" ], "summary": "Delete Agent", "operationId": "delete_agent_api_v1_agents__agent_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/agents/{agent_id}/duplicate": { "post": { "tags": [ "agents" ], "summary": "Duplicate Agent", "operationId": "duplicate_agent_api_v1_agents__agent_id__duplicate_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } } ], "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/agents/{agent_id}/pin": { "post": { "tags": [ "agents" ], "summary": "Pin Agent", "operationId": "pin_agent_api_v1_agents__agent_id__pin_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PinResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "agents" ], "summary": "Unpin Agent", "operationId": "unpin_agent_api_v1_agents__agent_id__pin_delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PinResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/agents/{agent_id}/avatar": { "put": { "tags": [ "agents" ], "summary": "Set Avatar", "operationId": "set_avatar_api_v1_agents__agent_id__avatar_put", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetAvatarRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/agents/{agent_id}/versions": { "get": { "tags": [ "agents" ], "summary": "List Versions", "operationId": "list_versions_api_v1_agents__agent_id__versions_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgentVersionResponse" }, "title": "Response List Versions Api V1 Agents Agent Id Versions Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/agents/{agent_id}/versions/{version_number}/restore": { "post": { "tags": [ "agents" ], "summary": "Restore Version", "operationId": "restore_version_api_v1_agents__agent_id__versions__version_number__restore_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } }, { "name": "version_number", "in": "path", "required": true, "schema": { "type": "integer", "title": "Version Number" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/agents/{agent_id}/grants": { "get": { "tags": [ "agents" ], "summary": "List Grants", "operationId": "list_grants_api_v1_agents__agent_id__grants_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgentGrantResponse" }, "title": "Response List Grants Api V1 Agents Agent Id Grants Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "agents" ], "summary": "Create Grant", "operationId": "create_grant_api_v1_agents__agent_id__grants_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/app__modules__agents__schemas__CreateGrantRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentGrantResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/agents/{agent_id}/grants/{grant_id}": { "delete": { "tags": [ "agents" ], "summary": "Delete Grant", "operationId": "delete_grant_api_v1_agents__agent_id__grants__grant_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } }, { "name": "grant_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Grant Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/agents/{agent_id}/analytics": { "get": { "tags": [ "agents" ], "summary": "Get Analytics", "operationId": "get_analytics_api_v1_agents__agent_id__analytics_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentAnalyticsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/agents/{agent_id}/runs": { "post": { "tags": [ "agents" ], "summary": "Create Run", "operationId": "create_run_api_v1_agents__agent_id__runs_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRunRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentRunResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "agents" ], "summary": "List Runs", "operationId": "list_runs_api_v1_agents__agent_id__runs_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Per Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentRunListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/agents/{agent_id}/runs/{run_id}": { "get": { "tags": [ "agents" ], "summary": "Get Run", "operationId": "get_run_api_v1_agents__agent_id__runs__run_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } }, { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentRunWithMessagesResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "agents" ], "summary": "Delete Run", "operationId": "delete_run_api_v1_agents__agent_id__runs__run_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } }, { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/agents/{agent_id}/runs/{run_id}/messages": { "post": { "tags": [ "agents" ], "summary": "Send Message", "operationId": "send_message_api_v1_agents__agent_id__runs__run_id__messages_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } }, { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/app__modules__agents__schemas__SendMessageRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/agents/{agent_id}/memory": { "post": { "tags": [ "agents" ], "summary": "Add Memory", "operationId": "add_memory_api_v1_agents__agent_id__memory_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/app__modules__agents__schemas__AddMemoryRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemoryItemResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "agents" ], "summary": "List Memory", "operationId": "list_memory_api_v1_agents__agent_id__memory_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MemoryItemResponse" }, "title": "Response List Memory Api V1 Agents Agent Id Memory Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/agents/{agent_id}/memory/{memory_id}": { "delete": { "tags": [ "agents" ], "summary": "Delete Memory", "operationId": "delete_memory_api_v1_agents__agent_id__memory__memory_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } }, { "name": "memory_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Memory Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workflows/templates": { "get": { "tags": [ "workflows" ], "summary": "List Templates", "operationId": "list_templates_api_v1_workflows_templates_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/WorkflowTemplateResponse" }, "type": "array", "title": "Response List Templates Api V1 Workflows Templates Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/workflows/from-template": { "post": { "tags": [ "workflows" ], "summary": "Create From Template", "operationId": "create_from_template_api_v1_workflows_from_template_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFromTemplateRequest" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/workflows/runs": { "get": { "tags": [ "workflows" ], "summary": "List Runs Workspace", "operationId": "list_runs_workspace_api_v1_workflows_runs_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Workflow Id" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 16 }, { "type": "null" } ], "title": "Status" } }, { "name": "triggered_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Triggered By" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Per Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRunListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workflows/runs/{run_id}": { "get": { "tags": [ "workflows" ], "summary": "Get Run", "operationId": "get_run_api_v1_workflows_runs__run_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRunResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workflows/runs/{run_id}/steps": { "get": { "tags": [ "workflows" ], "summary": "Get Run Steps", "operationId": "get_run_steps_api_v1_workflows_runs__run_id__steps_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowRunStepResponse" }, "title": "Response Get Run Steps Api V1 Workflows Runs Run Id Steps Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workflows/runs/{run_id}/cancel": { "post": { "tags": [ "workflows" ], "summary": "Cancel Run", "operationId": "cancel_run_api_v1_workflows_runs__run_id__cancel_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRunResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workflows/runs/{run_id}/stream": { "get": { "tags": [ "workflows" ], "summary": "Stream Run", "operationId": "stream_run_api_v1_workflows_runs__run_id__stream_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workflows": { "get": { "tags": [ "workflows" ], "summary": "List Workflows", "operationId": "list_workflows_api_v1_workflows_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "scope", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 16, "default": "mine", "title": "Scope" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "title": "Q" } }, { "name": "tag", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 50 }, { "type": "null" } ], "title": "Tag" } }, { "name": "category", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ], "title": "Category" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 16 }, { "type": "null" } ], "title": "Status" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 16, "default": "recent", "title": "Sort" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Per Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "workflows" ], "summary": "Create Workflow", "operationId": "create_workflow_api_v1_workflows_post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWorkflowRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workflows/{workflow_id}": { "get": { "tags": [ "workflows" ], "summary": "Get Workflow", "operationId": "get_workflow_api_v1_workflows__workflow_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workflow Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "workflows" ], "summary": "Update Workflow", "operationId": "update_workflow_api_v1_workflows__workflow_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workflow Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWorkflowRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "workflows" ], "summary": "Delete Workflow", "operationId": "delete_workflow_api_v1_workflows__workflow_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workflow Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workflows/{workflow_id}/duplicate": { "post": { "tags": [ "workflows" ], "summary": "Duplicate Workflow", "operationId": "duplicate_workflow_api_v1_workflows__workflow_id__duplicate_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workflow Id" } } ], "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workflows/{workflow_id}/archive": { "post": { "tags": [ "workflows" ], "summary": "Archive Workflow", "operationId": "archive_workflow_api_v1_workflows__workflow_id__archive_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workflow Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workflows/{workflow_id}/activate": { "post": { "tags": [ "workflows" ], "summary": "Activate Workflow", "operationId": "activate_workflow_api_v1_workflows__workflow_id__activate_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workflow Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workflows/{workflow_id}/pin": { "post": { "tags": [ "workflows" ], "summary": "Pin Workflow", "operationId": "pin_workflow_api_v1_workflows__workflow_id__pin_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workflow Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workflows/{workflow_id}/unpin": { "post": { "tags": [ "workflows" ], "summary": "Unpin Workflow", "operationId": "unpin_workflow_api_v1_workflows__workflow_id__unpin_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workflow Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workflows/{workflow_id}/versions": { "get": { "tags": [ "workflows" ], "summary": "List Versions", "operationId": "list_versions_api_v1_workflows__workflow_id__versions_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workflow Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowVersionResponse" }, "title": "Response List Versions Api V1 Workflows Workflow Id Versions Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workflows/{workflow_id}/versions/{version_no}": { "get": { "tags": [ "workflows" ], "summary": "Get Version", "operationId": "get_version_api_v1_workflows__workflow_id__versions__version_no__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workflow Id" } }, { "name": "version_no", "in": "path", "required": true, "schema": { "type": "integer", "title": "Version No" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowVersionResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workflows/{workflow_id}/versions/{version_no}/restore": { "post": { "tags": [ "workflows" ], "summary": "Restore Version", "operationId": "restore_version_api_v1_workflows__workflow_id__versions__version_no__restore_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workflow Id" } }, { "name": "version_no", "in": "path", "required": true, "schema": { "type": "integer", "title": "Version No" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workflows/{workflow_id}/grants": { "get": { "tags": [ "workflows" ], "summary": "List Grants", "operationId": "list_grants_api_v1_workflows__workflow_id__grants_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workflow Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowGrantResponse" }, "title": "Response List Grants Api V1 Workflows Workflow Id Grants Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "workflows" ], "summary": "Create Grant", "operationId": "create_grant_api_v1_workflows__workflow_id__grants_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workflow Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/app__modules__workflows__schemas__CreateGrantRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowGrantResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workflows/{workflow_id}/grants/{grant_id}": { "delete": { "tags": [ "workflows" ], "summary": "Delete Grant", "operationId": "delete_grant_api_v1_workflows__workflow_id__grants__grant_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workflow Id" } }, { "name": "grant_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Grant Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workflows/{workflow_id}/schedules": { "get": { "tags": [ "workflows" ], "summary": "List Schedules", "operationId": "list_schedules_api_v1_workflows__workflow_id__schedules_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workflow Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowScheduleResponse" }, "title": "Response List Schedules Api V1 Workflows Workflow Id Schedules Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "workflows" ], "summary": "Create Schedule", "operationId": "create_schedule_api_v1_workflows__workflow_id__schedules_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workflow Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateScheduleRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowScheduleResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workflows/{workflow_id}/schedules/{schedule_id}": { "patch": { "tags": [ "workflows" ], "summary": "Update Schedule", "operationId": "update_schedule_api_v1_workflows__workflow_id__schedules__schedule_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workflow Id" } }, { "name": "schedule_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Schedule Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateScheduleRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowScheduleResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "workflows" ], "summary": "Delete Schedule", "operationId": "delete_schedule_api_v1_workflows__workflow_id__schedules__schedule_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workflow Id" } }, { "name": "schedule_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Schedule Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workflows/{workflow_id}/runs": { "post": { "tags": [ "workflows" ], "summary": "Start Run", "operationId": "start_run_api_v1_workflows__workflow_id__runs_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workflow Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartRunRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartRunResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workflows/{workflow_id}/analytics": { "get": { "tags": [ "workflows" ], "summary": "Get Analytics", "operationId": "get_analytics_api_v1_workflows__workflow_id__analytics_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workflow Id" } }, { "name": "range_days", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 365, "minimum": 1, "default": 30, "title": "Range Days" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowAnalyticsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/translate/languages": { "get": { "tags": [ "translate" ], "summary": "List Languages", "description": "List all supported languages with RTL flag.", "operationId": "list_languages_api_v1_translate_languages_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/LanguageItem" }, "type": "array", "title": "Response List Languages Api V1 Translate Languages Get" } } } } } } }, "/api/v1/translate/voices": { "get": { "tags": [ "translate" ], "summary": "List Voices", "description": "List available ElevenLabs voices. Cached for 24 hours.", "operationId": "list_voices_api_v1_translate_voices_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/VoiceItem" }, "type": "array", "title": "Response List Voices Api V1 Translate Voices Get" } } } } } } }, "/api/v1/translate/text": { "post": { "tags": [ "translate" ], "summary": "Translate Text", "description": "Translate text to the target language.", "operationId": "translate_text_api_v1_translate_text_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranslateTextRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranslateResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/translate/grammar": { "post": { "tags": [ "translate" ], "summary": "Correct Grammar", "description": "Correct grammar and spelling in the given text.", "operationId": "correct_grammar_api_v1_translate_grammar_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GrammarRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GrammarResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/translate/summary": { "post": { "tags": [ "translate" ], "summary": "Summarize Text", "description": "Summarize text concisely.", "operationId": "summarize_text_api_v1_translate_summary_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SummaryRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SummaryResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/translate/ocr": { "post": { "tags": [ "translate" ], "summary": "Ocr File", "description": "Extract text from an image (PNG/JPG/WEBP/GIF), PDF, DOCX, or plain text file.\nOptionally translate the extracted text by providing target_language.\nEngine options: auto | server_only | claude_vision | gpt4o_vision | gemini_vision", "operationId": "ocr_file_api_v1_translate_ocr_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_ocr_file_api_v1_translate_ocr_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OCRResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/translate/tts": { "post": { "tags": [ "translate" ], "summary": "Text To Speech", "description": "Convert text to speech using ElevenLabs. Returns an MP3 audio file.\nCredit cost: 15 credits per 1 000 characters.", "operationId": "text_to_speech_api_v1_translate_tts_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TTSRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/translate/media": { "post": { "tags": [ "translate" ], "summary": "Process Media", "description": "Process media content:\n- youtube: Extract transcript from a YouTube video URL, optionally translate\n- text_to_speech: Convert text to speech, returns base64 MP3 audio", "operationId": "process_media_api_v1_translate_media_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/translate/media/audio": { "post": { "tags": [ "translate" ], "summary": "Process Media Audio", "description": "Transcribe an audio file (MP3/WAV/M4A/WebM) using OpenAI Whisper.\nOptionally translate the transcript by providing target_language.", "operationId": "process_media_audio_api_v1_translate_media_audio_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_process_media_audio_api_v1_translate_media_audio_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/translate/history": { "get": { "tags": [ "translate" ], "summary": "Get History", "description": "Return the user's translation history (all feature types).\nOptionally filter by feature_type: translate, grammar, summary, ocr, tts, media.", "operationId": "get_history_api_v1_translate_history_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Per Page" } }, { "name": "feature_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Feature Type" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranslationHistoryResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workspaces": { "get": { "tags": [ "workspaces" ], "summary": "List Workspaces", "operationId": "list_workspaces_api_v1_workspaces_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Per Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "workspaces" ], "summary": "Create Workspace", "operationId": "create_workspace_api_v1_workspaces_post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWorkspaceRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workspaces/{workspace_id}": { "get": { "tags": [ "workspaces" ], "summary": "Get Workspace", "operationId": "get_workspace_api_v1_workspaces__workspace_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workspace Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "workspaces" ], "summary": "Update Workspace", "operationId": "update_workspace_api_v1_workspaces__workspace_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workspace Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWorkspaceRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "workspaces" ], "summary": "Delete Workspace", "operationId": "delete_workspace_api_v1_workspaces__workspace_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workspace Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workspaces/{workspace_id}/members": { "get": { "tags": [ "workspaces" ], "summary": "List Members", "operationId": "list_members_api_v1_workspaces__workspace_id__members_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workspace Id" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Per Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceMemberListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "workspaces" ], "summary": "Add Member", "operationId": "add_member_api_v1_workspaces__workspace_id__members_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workspace Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddMemberRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceMemberResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workspaces/{workspace_id}/members/{target_user_id}": { "patch": { "tags": [ "workspaces" ], "summary": "Update Member Role", "operationId": "update_member_role_api_v1_workspaces__workspace_id__members__target_user_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workspace Id" } }, { "name": "target_user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Target User Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMemberRoleRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceMemberResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "workspaces" ], "summary": "Remove Member", "operationId": "remove_member_api_v1_workspaces__workspace_id__members__target_user_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workspace Id" } }, { "name": "target_user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Target User Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workspaces/{workspace_id}/docs": { "get": { "tags": [ "workspaces" ], "summary": "List Docs", "operationId": "list_docs_api_v1_workspaces__workspace_id__docs_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workspace Id" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Per Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceDocListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "workspaces" ], "summary": "Create Doc", "operationId": "create_doc_api_v1_workspaces__workspace_id__docs_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workspace Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDocRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceDocResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workspaces/{workspace_id}/docs/{doc_id}": { "patch": { "tags": [ "workspaces" ], "summary": "Update Doc", "operationId": "update_doc_api_v1_workspaces__workspace_id__docs__doc_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workspace Id" } }, { "name": "doc_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Doc Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDocRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceDocResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "workspaces" ], "summary": "Delete Doc", "operationId": "delete_doc_api_v1_workspaces__workspace_id__docs__doc_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workspace Id" } }, { "name": "doc_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Doc Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workspaces/{workspace_id}/prompts": { "get": { "tags": [ "workspaces" ], "summary": "List Prompts", "operationId": "list_prompts_api_v1_workspaces__workspace_id__prompts_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workspace Id" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Per Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspacePromptListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "workspaces" ], "summary": "Create Prompt", "operationId": "create_prompt_api_v1_workspaces__workspace_id__prompts_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workspace Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePromptRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspacePromptResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workspaces/{workspace_id}/prompts/{prompt_id}": { "delete": { "tags": [ "workspaces" ], "summary": "Delete Prompt", "operationId": "delete_prompt_api_v1_workspaces__workspace_id__prompts__prompt_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workspace Id" } }, { "name": "prompt_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Prompt Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workspaces/{workspace_id}/memory": { "get": { "tags": [ "workspaces" ], "summary": "List Memory", "operationId": "list_memory_api_v1_workspaces__workspace_id__memory_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workspace Id" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Per Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceMemoryListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "workspaces" ], "summary": "Add Memory", "operationId": "add_memory_api_v1_workspaces__workspace_id__memory_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workspace Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/app__modules__workspace__schemas__AddMemoryRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceMemoryItemResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workspaces/{workspace_id}/activity": { "get": { "tags": [ "workspaces" ], "summary": "List Activity", "operationId": "list_activity_api_v1_workspaces__workspace_id__activity_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workspace Id" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Per Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceActivityListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/research/start": { "post": { "tags": [ "research" ], "summary": "Start Research", "operationId": "start_research_api_v1_research_start_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartResearchRequest" } } }, "required": true }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartResearchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/research/history": { "get": { "tags": [ "research" ], "summary": "List History", "operationId": "list_history_api_v1_research_history_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Per Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResearchHistoryResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/research/usage": { "get": { "tags": [ "research" ], "summary": "Get Usage", "operationId": "get_usage_api_v1_research_usage_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageResponse" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/research": { "post": { "tags": [ "research" ], "summary": "Create Report", "description": "Create and enqueue a new research report.", "operationId": "create_report_api_v1_research_post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateReportRequest" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Report Api V1 Research Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "research" ], "summary": "List Reports", "operationId": "list_reports_api_v1_research_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "scope", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^(mine|shared|company|all)$", "default": "mine", "title": "Scope" } }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200, "default": "", "title": "Q" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Per Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Reports Api V1 Research Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/research/{report_id}": { "get": { "tags": [ "research" ], "summary": "Get Report", "operationId": "get_report_api_v1_research__report_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "report_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Report Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Report Api V1 Research Report Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "research" ], "summary": "Delete Report", "operationId": "delete_report_api_v1_research__report_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "report_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Report Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Report Api V1 Research Report Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/research/{report_id}/stream": { "get": { "tags": [ "research" ], "summary": "Stream Report", "operationId": "stream_report_api_v1_research__report_id__stream_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "report_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Report Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/research/{report_id}/cancel": { "post": { "tags": [ "research" ], "summary": "Cancel Report", "operationId": "cancel_report_api_v1_research__report_id__cancel_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "report_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Report Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Cancel Report Api V1 Research Report Id Cancel Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/research/{report_id}/rerun": { "post": { "tags": [ "research" ], "summary": "Rerun Report", "operationId": "rerun_report_api_v1_research__report_id__rerun_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "report_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Report Id" } } ], "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Rerun Report Api V1 Research Report Id Rerun Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/research/{report_id}/export": { "get": { "tags": [ "research" ], "summary": "Export Report", "operationId": "export_report_api_v1_research__report_id__export_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "report_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Report Id" } }, { "name": "format", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^(md|html|pdf|docx)$", "default": "md", "title": "Format" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/research/{report_id}/share": { "post": { "tags": [ "research" ], "summary": "Share Report", "operationId": "share_report_api_v1_research__report_id__share_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "report_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Report Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/app__modules__research__schemas__ShareRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Share Report Api V1 Research Report Id Share Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/research/{report_id}/share/{grant_id}": { "delete": { "tags": [ "research" ], "summary": "Revoke Share", "operationId": "revoke_share_api_v1_research__report_id__share__grant_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "report_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Report Id" } }, { "name": "grant_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Grant Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Revoke Share Api V1 Research Report Id Share Grant Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/research/{job_id}/status": { "get": { "tags": [ "research" ], "summary": "Get Status", "operationId": "get_status_api_v1_research__job_id__status_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResearchStatusResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/research/{job_id}/result": { "get": { "tags": [ "research" ], "summary": "Get Result", "operationId": "get_result_api_v1_research__job_id__result_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResearchResultResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/images/generate": { "post": { "tags": [ "images" ], "summary": "Generate Image", "description": "Generate an image using DALL-E 3 or gpt-image-1.", "operationId": "generate_image_api_v1_images_generate_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateImageRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateImageResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/voice/synthesize": { "post": { "tags": [ "voice" ], "summary": "Synthesize", "description": "Stream TTS audio from ElevenLabs as audio/mpeg.", "operationId": "synthesize_api_v1_voice_synthesize_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SynthesizeRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/voice/transcribe": { "post": { "tags": [ "voice" ], "summary": "Transcribe", "description": "Transcribe audio using OpenAI Whisper.", "operationId": "transcribe_api_v1_voice_transcribe_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_transcribe_api_v1_voice_transcribe_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscribeResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/code/execute": { "post": { "tags": [ "code" ], "summary": "Execute Code", "description": "Execute Python code in a Docker sandbox and return results.", "operationId": "execute_code_api_v1_code_execute_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecuteRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecuteResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/me/profile": { "get": { "tags": [ "me" ], "summary": "Get Profile", "operationId": "get_profile_api_v1_me_profile_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Get Profile Api V1 Me Profile Get" } } } } }, "security": [ { "HTTPBearer": [] } ] }, "patch": { "tags": [ "me" ], "summary": "Update Profile", "operationId": "update_profile_api_v1_me_profile_patch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileUpdateBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Update Profile Api V1 Me Profile Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/me/avatar": { "post": { "tags": [ "me" ], "summary": "Upload Avatar", "operationId": "upload_avatar_api_v1_me_avatar_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_avatar_api_v1_me_avatar_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Upload Avatar Api V1 Me Avatar Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] }, "delete": { "tags": [ "me" ], "summary": "Delete Avatar", "operationId": "delete_avatar_api_v1_me_avatar_delete", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Delete Avatar Api V1 Me Avatar Delete" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/me/email/start-change": { "post": { "tags": [ "me" ], "summary": "Email Start Change", "operationId": "email_start_change_api_v1_me_email_start_change_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailStartChangeBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Email Start Change Api V1 Me Email Start Change Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/me/email/confirm": { "post": { "tags": [ "me" ], "summary": "Email Confirm", "operationId": "email_confirm_api_v1_me_email_confirm_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailConfirmBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Email Confirm Api V1 Me Email Confirm Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/me/password": { "post": { "tags": [ "me" ], "summary": "Change Password", "operationId": "change_password_api_v1_me_password_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordChangeBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Change Password Api V1 Me Password Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/me/sessions": { "get": { "tags": [ "me" ], "summary": "List Sessions", "operationId": "list_sessions_api_v1_me_sessions_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Response List Sessions Api V1 Me Sessions Get" } } } } }, "security": [ { "HTTPBearer": [] } ] }, "delete": { "tags": [ "me" ], "summary": "Revoke All Sessions", "operationId": "revoke_all_sessions_api_v1_me_sessions_delete", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Revoke All Sessions Api V1 Me Sessions Delete" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/me/sessions/{session_id}": { "delete": { "tags": [ "me" ], "summary": "Revoke Session", "operationId": "revoke_session_api_v1_me_sessions__session_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Session Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Revoke Session Api V1 Me Sessions Session Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/me/login-attempts": { "get": { "tags": [ "me" ], "summary": "List Login Attempts", "operationId": "list_login_attempts_api_v1_me_login_attempts_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 30, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "title": "Response List Login Attempts Api V1 Me Login Attempts Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/me/mfa/status": { "get": { "tags": [ "me" ], "summary": "Mfa Status", "operationId": "mfa_status_api_v1_me_mfa_status_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Mfa Status Api V1 Me Mfa Status Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/me/notifications/preferences": { "get": { "tags": [ "me" ], "summary": "Get Notification Prefs", "operationId": "get_notification_prefs_api_v1_me_notifications_preferences_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Get Notification Prefs Api V1 Me Notifications Preferences Get" } } } } }, "security": [ { "HTTPBearer": [] } ] }, "put": { "tags": [ "me" ], "summary": "Update Notification Prefs", "operationId": "update_notification_prefs_api_v1_me_notifications_preferences_put", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Body" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Update Notification Prefs Api V1 Me Notifications Preferences Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/me/workspace": { "get": { "tags": [ "me" ], "summary": "Get Workspace", "operationId": "get_workspace_api_v1_me_workspace_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Get Workspace Api V1 Me Workspace Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/me/data-export/request": { "post": { "tags": [ "me" ], "summary": "Request Data Export", "operationId": "request_data_export_api_v1_me_data_export_request_post", "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Request Data Export Api V1 Me Data Export Request Post" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/me/data-export/latest": { "get": { "tags": [ "me" ], "summary": "Get Latest Data Export", "description": "Return the most recent export job for the user, or null if none.", "operationId": "get_latest_data_export_api_v1_me_data_export_latest_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Response Get Latest Data Export Api V1 Me Data Export Latest Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/me/data-export/{job_id}": { "get": { "tags": [ "me" ], "summary": "Get Data Export Status", "operationId": "get_data_export_status_api_v1_me_data_export__job_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Data Export Status Api V1 Me Data Export Job Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/me/data-export/{job_id}/download": { "get": { "tags": [ "me" ], "summary": "Download Data Export", "operationId": "download_data_export_api_v1_me_data_export__job_id__download_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Job Id" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string", "title": "Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/me/account/delete-request": { "post": { "tags": [ "me" ], "summary": "Request Account Deletion", "operationId": "request_account_deletion_api_v1_me_account_delete_request_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteRequestBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Request Account Deletion Api V1 Me Account Delete Request Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/me/account/delete-cancel": { "post": { "tags": [ "me" ], "summary": "Cancel Account Deletion", "operationId": "cancel_account_deletion_api_v1_me_account_delete_cancel_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteCancelBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Cancel Account Deletion Api V1 Me Account Delete Cancel Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/me/cookies": { "get": { "tags": [ "me" ], "summary": "Get Cookie Prefs", "operationId": "get_cookie_prefs_api_v1_me_cookies_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Get Cookie Prefs Api V1 Me Cookies Get" } } } } }, "security": [ { "HTTPBearer": [] } ] }, "put": { "tags": [ "me" ], "summary": "Update Cookie Prefs", "operationId": "update_cookie_prefs_api_v1_me_cookies_put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CookiePrefsBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Update Cookie Prefs Api V1 Me Cookies Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/me/feedback": { "post": { "tags": [ "me" ], "summary": "Submit Feedback", "description": "Store user feedback and forward to feedback inbox.", "operationId": "submit_feedback_api_v1_me_feedback_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeedbackBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Submit Feedback Api V1 Me Feedback Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/docs-feedback": { "post": { "tags": [ "docs" ], "summary": "Submit Docs Feedback", "description": "Accept anonymous feedback from the public docs site.", "operationId": "submit_docs_feedback_api_v1_docs_feedback_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocsFeedbackBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Submit Docs Feedback Api V1 Docs Feedback Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/bulk/upload": { "post": { "tags": [ "bulk" ], "summary": "Upload File", "operationId": "upload_file_api_v1_bulk_upload_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_file_api_v1_bulk_upload_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Upload File Api V1 Bulk Upload Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/bulk/jobs": { "post": { "tags": [ "bulk" ], "summary": "Create Job", "operationId": "create_job_api_v1_bulk_jobs_post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateJobRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Job Api V1 Bulk Jobs Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "bulk" ], "summary": "List Jobs", "operationId": "list_jobs_api_v1_bulk_jobs_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "scope", "in": "query", "required": false, "schema": { "type": "string", "default": "mine", "title": "Scope" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "default": "", "title": "Status" } }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "default": "", "title": "Q" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Page Size" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Jobs Api V1 Bulk Jobs Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/bulk/jobs/{job_id}/start": { "post": { "tags": [ "bulk" ], "summary": "Start Job", "operationId": "start_job_api_v1_bulk_jobs__job_id__start_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Start Job Api V1 Bulk Jobs Job Id Start Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/bulk/jobs/{job_id}": { "get": { "tags": [ "bulk" ], "summary": "Get Job", "operationId": "get_job_api_v1_bulk_jobs__job_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Job Api V1 Bulk Jobs Job Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "bulk" ], "summary": "Delete Job", "operationId": "delete_job_api_v1_bulk_jobs__job_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Job Api V1 Bulk Jobs Job Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/bulk/jobs/{job_id}/rows": { "get": { "tags": [ "bulk" ], "summary": "List Rows", "operationId": "list_rows_api_v1_bulk_jobs__job_id__rows_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Job Id" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "default": "", "title": "Status" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Page Size" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Rows Api V1 Bulk Jobs Job Id Rows Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/bulk/jobs/{job_id}/stream": { "get": { "tags": [ "bulk" ], "summary": "Stream Job", "operationId": "stream_job_api_v1_bulk_jobs__job_id__stream_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/bulk/jobs/{job_id}/cancel": { "post": { "tags": [ "bulk" ], "summary": "Cancel Job", "operationId": "cancel_job_api_v1_bulk_jobs__job_id__cancel_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Cancel Job Api V1 Bulk Jobs Job Id Cancel Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/bulk/jobs/{job_id}/retry-failed": { "post": { "tags": [ "bulk" ], "summary": "Retry Failed", "operationId": "retry_failed_api_v1_bulk_jobs__job_id__retry_failed_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Retry Failed Api V1 Bulk Jobs Job Id Retry Failed Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/bulk/jobs/{job_id}/export": { "get": { "tags": [ "bulk" ], "summary": "Export Job", "operationId": "export_job_api_v1_bulk_jobs__job_id__export_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Job Id" } }, { "name": "format", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^(csv|xlsx)$", "default": "xlsx", "title": "Format" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/bulk/jobs/{job_id}/charts": { "get": { "tags": [ "bulk" ], "summary": "Get Charts", "operationId": "get_charts_api_v1_bulk_jobs__job_id__charts_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Charts Api V1 Bulk Jobs Job Id Charts Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/bulk/jobs/{job_id}/grants": { "post": { "tags": [ "bulk" ], "summary": "Add Grant", "operationId": "add_grant_api_v1_bulk_jobs__job_id__grants_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Job Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/app__modules__bulk__schemas__ShareRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Add Grant Api V1 Bulk Jobs Job Id Grants Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/bulk/jobs/{job_id}/grants/{grant_id}": { "delete": { "tags": [ "bulk" ], "summary": "Remove Grant", "operationId": "remove_grant_api_v1_bulk_jobs__job_id__grants__grant_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Job Id" } }, { "name": "grant_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Grant Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Remove Grant Api V1 Bulk Jobs Job Id Grants Grant Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/bulk/templates": { "get": { "tags": [ "bulk" ], "summary": "Get Templates", "operationId": "get_templates_api_v1_bulk_templates_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": {}, "type": "array", "title": "Response Get Templates Api V1 Bulk Templates Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/bulk/from-template": { "post": { "tags": [ "bulk" ], "summary": "From Template", "operationId": "from_template_api_v1_bulk_from_template_post", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Body" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response From Template Api V1 Bulk From Template Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/bulk/usage": { "get": { "tags": [ "bulk" ], "summary": "Get Usage", "operationId": "get_usage_api_v1_bulk_usage_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "range", "in": "query", "required": false, "schema": { "type": "string", "default": "30d", "title": "Range" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Usage Api V1 Bulk Usage Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/bulk/estimate": { "post": { "tags": [ "bulk" ], "summary": "Estimate Cost", "operationId": "estimate_cost_api_v1_bulk_estimate_post", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Body" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Estimate Cost Api V1 Bulk Estimate Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/comments": { "get": { "tags": [ "comments" ], "summary": "List Comments", "operationId": "list_comments_api_v1_comments_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "parent_type", "in": "query", "required": true, "schema": { "type": "string", "title": "Parent Type" } }, { "name": "parent_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Parent Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommentResponse" }, "title": "Response List Comments Api V1 Comments Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "comments" ], "summary": "Create Comment", "operationId": "create_comment_api_v1_comments_post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCommentRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/comments/{comment_id}": { "patch": { "tags": [ "comments" ], "summary": "Update Comment", "operationId": "update_comment_api_v1_comments__comment_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "comment_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Comment Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCommentRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "comments" ], "summary": "Delete Comment", "operationId": "delete_comment_api_v1_comments__comment_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "comment_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Comment Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/comments/{comment_id}/resolve": { "post": { "tags": [ "comments" ], "summary": "Resolve Comment", "operationId": "resolve_comment_api_v1_comments__comment_id__resolve_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "comment_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Comment Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/comments/{comment_id}/unresolve": { "post": { "tags": [ "comments" ], "summary": "Unresolve Comment", "operationId": "unresolve_comment_api_v1_comments__comment_id__unresolve_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "comment_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Comment Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/notifications": { "get": { "tags": [ "notifications" ], "summary": "List Notifications", "operationId": "list_notifications_api_v1_notifications_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "unread_only", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Unread Only" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 40, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationResponse" }, "title": "Response List Notifications Api V1 Notifications Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/notifications/unread-count": { "get": { "tags": [ "notifications" ], "summary": "Get Unread Count", "operationId": "get_unread_count_api_v1_notifications_unread_count_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnreadCountResponse" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/notifications/{notification_id}/read": { "post": { "tags": [ "notifications" ], "summary": "Mark One Read", "operationId": "mark_one_read_api_v1_notifications__notification_id__read_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "notification_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Notification Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/notifications/read-all": { "post": { "tags": [ "notifications" ], "summary": "Mark All Read", "operationId": "mark_all_read_api_v1_notifications_read_all_post", "responses": { "204": { "description": "Successful Response" } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/notifications/stream": { "get": { "tags": [ "notifications" ], "summary": "Notification Stream", "description": "SSE stream — pushes `ping` every 25s and `notification` events via Redis pubsub.", "operationId": "notification_stream_api_v1_notifications_stream_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/workspace/activity": { "get": { "tags": [ "workspace-collab" ], "summary": "Get Activity Feed", "operationId": "get_activity_feed_api_v1_workspace_activity_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 40, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "object_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Type" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityEventResponse" }, "title": "Response Get Activity Feed Api V1 Workspace Activity Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workspace/members": { "get": { "tags": [ "workspace-collab" ], "summary": "List Members", "operationId": "list_members_api_v1_workspace_members_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/app__modules__workspace_collab__router__MemberResponse" }, "type": "array", "title": "Response List Members Api V1 Workspace Members Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/workspace/kpis": { "get": { "tags": [ "workspace-collab" ], "summary": "Get Kpis", "operationId": "get_kpis_api_v1_workspace_kpis_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KpiResponse" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/workspace/saved-views": { "get": { "tags": [ "workspace-collab" ], "summary": "List Saved Views", "operationId": "list_saved_views_api_v1_workspace_saved_views_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SavedViewResponse" }, "title": "Response List Saved Views Api V1 Workspace Saved Views Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "workspace-collab" ], "summary": "Create Saved View", "operationId": "create_saved_view_api_v1_workspace_saved_views_post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSavedViewRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedViewResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workspace/saved-views/{view_id}": { "delete": { "tags": [ "workspace-collab" ], "summary": "Delete Saved View", "operationId": "delete_saved_view_api_v1_workspace_saved_views__view_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "view_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "View Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/connectors": { "get": { "tags": [ "connectors" ], "summary": "List Connectors", "operationId": "list_connectors_api_v1_connectors_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectorOut" }, "title": "Response List Connectors Api V1 Connectors Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/connectors/usage": { "get": { "tags": [ "connectors" ], "summary": "Get Usage", "operationId": "get_usage_api_v1_connectors_usage_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageOut" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/connectors/{provider}/auth-start": { "get": { "tags": [ "connectors" ], "summary": "Auth Start", "operationId": "auth_start_api_v1_connectors__provider__auth_start_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string", "title": "Provider" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/connectors/{provider}/auth-callback": { "get": { "tags": [ "connectors" ], "summary": "Auth Callback", "operationId": "auth_callback_api_v1_connectors__provider__auth_callback_get", "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string", "title": "Provider" } }, { "name": "code", "in": "query", "required": true, "schema": { "type": "string", "title": "Code" } }, { "name": "state", "in": "query", "required": true, "schema": { "type": "string", "title": "State" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/connectors/{connector_id}": { "get": { "tags": [ "connectors" ], "summary": "Get Connector", "operationId": "get_connector_api_v1_connectors__connector_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Connector Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorDetail" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "connectors" ], "summary": "Update Connector", "operationId": "update_connector_api_v1_connectors__connector_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Connector Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "connectors" ], "summary": "Delete Connector", "operationId": "delete_connector_api_v1_connectors__connector_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Connector Id" } }, { "name": "purge", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Purge" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/connectors/{connector_id}/sync": { "post": { "tags": [ "connectors" ], "summary": "Sync All Folders", "operationId": "sync_all_folders_api_v1_connectors__connector_id__sync_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Connector Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/connectors/{connector_id}/files": { "get": { "tags": [ "connectors" ], "summary": "List Connector Files", "operationId": "list_connector_files_api_v1_connectors__connector_id__files_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Connector Id" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Per Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FileOut" }, "title": "Response List Connector Files Api V1 Connectors Connector Id Files Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/connectors/{connector_id}/sync-runs": { "get": { "tags": [ "connectors" ], "summary": "List Connector Sync Runs", "operationId": "list_connector_sync_runs_api_v1_connectors__connector_id__sync_runs_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Connector Id" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Per Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SyncRunOut" }, "title": "Response List Connector Sync Runs Api V1 Connectors Connector Id Sync Runs Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/connectors/{connector_id}/pause": { "post": { "tags": [ "connectors" ], "summary": "Pause Connector", "operationId": "pause_connector_api_v1_connectors__connector_id__pause_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Connector Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/connectors/{connector_id}/resume": { "post": { "tags": [ "connectors" ], "summary": "Resume Connector", "operationId": "resume_connector_api_v1_connectors__connector_id__resume_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Connector Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/connectors/{connector_id}/folders": { "get": { "tags": [ "connectors" ], "summary": "List Folders", "operationId": "list_folders_api_v1_connectors__connector_id__folders_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Connector Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FolderOut" }, "title": "Response List Folders Api V1 Connectors Connector Id Folders Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "connectors" ], "summary": "Add Folder", "operationId": "add_folder_api_v1_connectors__connector_id__folders_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Connector Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderCreate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/connectors/{connector_id}/browse": { "get": { "tags": [ "connectors" ], "summary": "Browse Folders", "operationId": "browse_folders_api_v1_connectors__connector_id__browse_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Connector Id" } }, { "name": "parent", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/connectors/{connector_id}/folders/{folder_id}": { "patch": { "tags": [ "connectors" ], "summary": "Update Folder", "operationId": "update_folder_api_v1_connectors__connector_id__folders__folder_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Connector Id" } }, { "name": "folder_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Folder Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "connectors" ], "summary": "Remove Folder", "operationId": "remove_folder_api_v1_connectors__connector_id__folders__folder_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Connector Id" } }, { "name": "folder_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Folder Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/connectors/{connector_id}/folders/{folder_id}/sync-now": { "post": { "tags": [ "connectors" ], "summary": "Sync Now", "operationId": "sync_now_api_v1_connectors__connector_id__folders__folder_id__sync_now_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Connector Id" } }, { "name": "folder_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Folder Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/connectors/{connector_id}/folders/{folder_id}/sync": { "post": { "tags": [ "connectors" ], "summary": "Sync Now", "operationId": "sync_now_api_v1_connectors__connector_id__folders__folder_id__sync_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Connector Id" } }, { "name": "folder_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Folder Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/connectors/{connector_id}/folders/{folder_id}/files": { "get": { "tags": [ "connectors" ], "summary": "List Files", "operationId": "list_files_api_v1_connectors__connector_id__folders__folder_id__files_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Connector Id" } }, { "name": "folder_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Folder Id" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FileOut" }, "title": "Response List Files Api V1 Connectors Connector Id Folders Folder Id Files Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/connectors/{connector_id}/folders/{folder_id}/runs": { "get": { "tags": [ "connectors" ], "summary": "List Sync Runs", "operationId": "list_sync_runs_api_v1_connectors__connector_id__folders__folder_id__runs_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Connector Id" } }, { "name": "folder_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Folder Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SyncRunOut" }, "title": "Response List Sync Runs Api V1 Connectors Connector Id Folders Folder Id Runs Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/dashboard/overview": { "get": { "tags": [ "dashboard" ], "summary": "Get Overview", "operationId": "get_overview_api_v1_dashboard_overview_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "range", "in": "query", "required": false, "schema": { "type": "string", "default": "30d", "title": "Range" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/auth/login": { "post": { "x-codeSamples": [ { "lang": "Python", "label": "Python", "source": "from hubrix import HubrixClient, login\n\ntokens = await login('you@example.com', 'YOUR_PASSWORD')\nclient = HubrixClient(api_key=tokens['access_token'])" }, { "lang": "JavaScript", "label": "JavaScript", "source": "import { login } from '@hubrix/sdk';\n\nconst { access_token } = await login('you@example.com', 'YOUR_PASSWORD');" }, { "lang": "Shell", "label": "cURL", "source": "curl -X POST https://api.hubrix.ai/v1/auth/login \\\n -H 'Content-Type: application/json' \\\n -d '{\"email\":\"you@example.com\",\"password\":\"YOUR_PASSWORD\"}'" } ] } }, "/v1/auth/refresh": { "post": { "x-codeSamples": [ { "lang": "Python", "label": "Python", "source": "new_tokens = await client.auth.refresh(refresh_token=tokens['refresh_token'])" }, { "lang": "Shell", "label": "cURL", "source": "curl -X POST https://api.hubrix.ai/v1/auth/refresh \\\n -H 'Content-Type: application/json' \\\n -d '{\"refresh_token\":\"YOUR_REFRESH_TOKEN\"}'" } ] } }, "/v1/workflows": { "get": { "x-codeSamples": [ { "lang": "Python", "label": "Python", "source": "async with HubrixClient(api_key='hbx_...') as c:\n page = await c.workflows.list(limit=20)\n for w in page['items']:\n print(w['name'], w['id'])" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const { items, total } = await client.workflows.list({ limit: 20 });\nitems.forEach(w => console.log(w.name, w.id));" }, { "lang": "Shell", "label": "cURL", "source": "curl https://api.hubrix.ai/v1/workflows?limit=20 \\\n -H 'Authorization: Bearer YOUR_API_KEY'" } ] } }, "/v1/workflows/{id}/runs": { "post": { "x-codeSamples": [ { "lang": "Python", "label": "Python", "source": "run = await c.workflows.create_run(\n workflow_id='your-workflow-id',\n inputs={'query': 'Summarise Q1 sales', 'format': 'markdown'}\n)\nprint('Run ID:', run['id'])" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const run = await client.workflows.createRun(\n 'your-workflow-id',\n { query: 'Summarise Q1 sales', format: 'markdown' }\n);\nconsole.log('Run ID:', run.id);" }, { "lang": "Swift", "label": "Swift", "source": "let run = try await client.workflows.createRun(\n workflowId: \"your-workflow-id\",\n inputs: [\"query\": \"Summarise Q1 sales\"]\n)\nprint(\"Run ID:\", run.id)" }, { "lang": "Shell", "label": "cURL", "source": "curl -X POST https://api.hubrix.ai/v1/workflows/your-id/runs \\\n -H 'Authorization: Bearer YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -H 'Idempotency-Key: $(python3 -c \"import uuid; print(uuid.uuid4())\")' \\\n -d '{\"inputs\":{\"query\":\"Summarise Q1 sales\"}}'" } ] } }, "/v1/workflows/runs/{run_id}": { "get": { "x-codeSamples": [ { "lang": "Python", "label": "Python", "source": "result = await c.workflows.poll_run(\n workflow_id='your-workflow-id',\n run_id=run['id'],\n timeout=120\n)\nprint(result['status'], result.get('outputs'))" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const result = await client.workflows.pollRun(\n 'your-workflow-id',\n run.id,\n { timeout: 120_000 }\n);\nconsole.log(result.status, result.outputs);" }, { "lang": "Shell", "label": "cURL", "source": "curl https://api.hubrix.ai/v1/workflows/runs/RUN_ID \\\n -H 'Authorization: Bearer YOUR_API_KEY'" } ] } }, "/v1/research": { "post": { "x-codeSamples": [ { "lang": "Python", "label": "Python", "source": "job = await c.research.create(\n query='Latest advances in AI reasoning',\n depth='standard' # or 'deep'\n)\nprint('Report ID:', job['id'])" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const job = await client.research.create(\n 'Latest advances in AI reasoning',\n { depth: 'standard' }\n);\nconsole.log('Report ID:', job.id);" }, { "lang": "Shell", "label": "cURL", "source": "curl -X POST https://api.hubrix.ai/v1/research \\\n -H 'Authorization: Bearer YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"query\":\"AI reasoning advances\",\"depth\":\"standard\"}'" } ] } }, "/v1/research/{id}": { "get": { "x-codeSamples": [ { "lang": "Python", "label": "Python", "source": "report = await c.research.poll(job['id'], timeout=120)\nprint(f\"{len(report['content'])} chars, {len(report['sources'])} sources\")" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const report = await client.research.poll(job.id, { timeout: 120_000 });\nconsole.log(report.content?.length, 'chars');" }, { "lang": "Shell", "label": "cURL", "source": "curl https://api.hubrix.ai/v1/research/REPORT_ID \\\n -H 'Authorization: Bearer YOUR_API_KEY'" } ] } }, "/v1/agents/{id}/run": { "post": { "x-codeSamples": [ { "lang": "Python", "label": "Python", "source": "result = await c.agents.run(\n agent_id='your-agent-id',\n input='Analyse this dataset and summarise key trends'\n)\nprint(result['output'])" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const result = await client.agents.run(\n 'your-agent-id',\n { input: 'Analyse this dataset and summarise key trends' }\n);\nconsole.log(result.output);" }, { "lang": "Shell", "label": "cURL", "source": "curl -X POST https://api.hubrix.ai/v1/agents/your-id/run \\\n -H 'Authorization: Bearer YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"input\":\"Analyse this dataset\"}'" } ] } }, "/v1/chat/sessions": { "post": { "x-codeSamples": [ { "lang": "Python", "label": "Python", "source": "session = await c.chat.create_session(title='Q1 Analysis')\nprint('Session ID:', session['id'])" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const session = await client.chat.createSession({ title: 'Q1 Analysis' });\nconsole.log('Session ID:', session.id);" }, { "lang": "Shell", "label": "cURL", "source": "curl -X POST https://api.hubrix.ai/v1/chat/sessions \\\n -H 'Authorization: Bearer YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"title\":\"Q1 Analysis\"}'" } ] } }, "/v1/chat/sessions/{id}/messages": { "post": { "x-codeSamples": [ { "lang": "Python", "label": "Python", "source": "msg = await c.chat.send_message(\n session_id=session['id'],\n content='What are the key trends in Q1?'\n)\nprint(msg['content'])" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const msg = await client.chat.sendMessage(\n session.id,\n 'What are the key trends in Q1?'\n);\nconsole.log(msg.content);" }, { "lang": "Shell", "label": "cURL", "source": "curl -X POST https://api.hubrix.ai/v1/chat/sessions/SESSION_ID/messages \\\n -H 'Authorization: Bearer YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"content\":\"What are the key trends in Q1?\"}'" } ] } }, "/v1/documents/upload": { "post": { "x-codeSamples": [ { "lang": "Python", "label": "Python", "source": "with open('report.pdf', 'rb') as f:\n doc = await c.documents.upload(file=f, filename='report.pdf')\nprint('Doc ID:', doc['id'])" }, { "lang": "Shell", "label": "cURL", "source": "curl -X POST https://api.hubrix.ai/v1/documents/upload \\\n -H 'Authorization: Bearer YOUR_API_KEY' \\\n -F 'file=@report.pdf'" } ] } }, "/v1/bulk/jobs": { "post": { "x-codeSamples": [ { "lang": "Python", "label": "Python", "source": "with open('leads.csv', 'rb') as f:\n job = await c.bulk.create_job(file=f, workflow_id='enrich-leads')\nprint('Job ID:', job['id'])" }, { "lang": "Shell", "label": "cURL", "source": "curl -X POST https://api.hubrix.ai/v1/bulk/jobs \\\n -H 'Authorization: Bearer YOUR_API_KEY' \\\n -F 'file=@leads.csv' \\\n -F 'workflow_id=enrich-leads'" } ] } }, "/v1/bulk/jobs/{id}/rows": { "get": { "x-codeSamples": [ { "lang": "Python", "label": "Python", "source": "rows = await c.bulk.get_rows(job_id=job['id'])\nfor row in rows['items']:\n print(row['status'], row.get('output'))" }, { "lang": "Shell", "label": "cURL", "source": "curl https://api.hubrix.ai/v1/bulk/jobs/JOB_ID/rows \\\n -H 'Authorization: Bearer YOUR_API_KEY'" } ] } }, "/v1/users/me": { "get": { "x-codeSamples": [ { "lang": "Python", "label": "Python", "source": "profile = await c.me()\nprint(profile['email'], profile['role'])" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const profile = await client.me();\nconsole.log(profile.email, profile.role);" }, { "lang": "Swift", "label": "Swift", "source": "let profile = try await client.me()\nprint(profile.email, profile.role)" }, { "lang": "Shell", "label": "cURL", "source": "curl https://api.hubrix.ai/v1/users/me \\\n -H 'Authorization: Bearer YOUR_API_KEY'" } ] } }, "/v1/billing/credits": { "get": { "x-codeSamples": [ { "lang": "Python", "label": "Python", "source": "balance = await c.billing.get_credits()\nprint(f\"Balance: {balance['available']} / {balance['total']} credits\")" }, { "lang": "Shell", "label": "cURL", "source": "curl https://api.hubrix.ai/v1/billing/credits \\\n -H 'Authorization: Bearer YOUR_API_KEY'" } ] } }, "/v1/connectors": { "post": { "x-codeSamples": [ { "lang": "Python", "label": "Python", "source": "connector = await c.connectors.create(provider='google_drive')\nprint('Authorize at:', connector['auth_url'])" }, { "lang": "Shell", "label": "cURL", "source": "curl -X POST https://api.hubrix.ai/v1/connectors \\\n -H 'Authorization: Bearer YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"provider\":\"google_drive\"}'" } ] } }, "/v1/connectors/{id}/folders/{folder_id}/sync": { "get": { "x-codeSamples": [ { "lang": "Python", "label": "Python", "source": "sync = await c.connectors.sync_folder(\n connector_id='your-connector-id',\n folder_id='root'\n)\nprint('Synced files:', sync['files_synced'])" }, { "lang": "Shell", "label": "cURL", "source": "curl https://api.hubrix.ai/v1/connectors/CONNECTOR_ID/folders/root/sync \\\n -H 'Authorization: Bearer YOUR_API_KEY'" } ] } }, "/v1/workspaces/items": { "post": { "x-codeSamples": [ { "lang": "Python", "label": "Python", "source": "item = await c.workspaces.create_item(\n title='Q1 Report',\n content_type='research',\n content_id=report['id']\n)\nprint('Share URL:', item['share_url'])" }, { "lang": "Shell", "label": "cURL", "source": "curl -X POST https://api.hubrix.ai/v1/workspaces/items \\\n -H 'Authorization: Bearer YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"title\":\"Q1 Report\",\"content_type\":\"research\",\"content_id\":\"REPORT_ID\"}'" } ] } }, "/v1/auth/api-keys": { "post": { "x-codeSamples": [ { "lang": "Python", "label": "Python", "source": "key = await c.auth.create_api_key(\n name='Production integration',\n scopes=['workflows:read', 'workflows:write']\n)\nprint('Key:', key['key']) # Only shown once!" }, { "lang": "Shell", "label": "cURL", "source": "curl -X POST https://api.hubrix.ai/v1/auth/api-keys \\\n -H 'Authorization: Bearer YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"name\":\"Production\",\"scopes\":[\"workflows:read\",\"workflows:write\"]}'" } ] } }, "/v1/auth/mfa/totp/setup": { "post": { "x-codeSamples": [ { "lang": "Python", "label": "Python", "source": "setup = await c.auth.setup_totp()\nprint('Scan this QR code:', setup['qr_code_url'])\nprint('Or enter secret:', setup['secret'])" }, { "lang": "Shell", "label": "cURL", "source": "curl -X POST https://api.hubrix.ai/v1/auth/mfa/totp/setup \\\n -H 'Authorization: Bearer YOUR_API_KEY'" } ] } }, "/v1/chat/{session_id}/stream": { "get": { "x-codeSamples": [ { "lang": "Python", "label": "Python", "source": "async for chunk in c.chat.stream(session_id=session['id']):\n print(chunk['delta'], end='', flush=True)" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const stream = await client.chat.stream(session.id);\nfor await (const chunk of stream) {\n process.stdout.write(chunk.delta);\n}" } ] } } }, "components": { "schemas": { "AcceptInvitationRequest": { "properties": { "token": { "type": "string", "title": "Token" }, "password": { "type": "string", "title": "Password" }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Full Name" } }, "type": "object", "required": [ "token", "password" ], "title": "AcceptInvitationRequest" }, "ActivityEventResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "actor_id": { "type": "string", "format": "uuid", "title": "Actor Id" }, "verb": { "type": "string", "title": "Verb" }, "object_type": { "type": "string", "title": "Object Type" }, "object_id": { "type": "string", "format": "uuid", "title": "Object Id" }, "object_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Label" }, "meta": { "additionalProperties": true, "type": "object", "title": "Meta" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "actor_id", "verb", "object_type", "object_id", "object_label", "meta", "created_at" ], "title": "ActivityEventResponse" }, "AddMemberRequest": { "properties": { "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, "role": { "type": "string", "enum": [ "owner", "editor", "viewer" ], "title": "Role", "default": "viewer" } }, "type": "object", "required": [ "user_id" ], "title": "AddMemberRequest" }, "AgentAnalyticsResponse": { "properties": { "total_runs": { "type": "integer", "title": "Total Runs" }, "total_messages": { "type": "integer", "title": "Total Messages" }, "total_tokens_input": { "type": "integer", "title": "Total Tokens Input" }, "total_tokens_output": { "type": "integer", "title": "Total Tokens Output" }, "total_cost_eur": { "type": "number", "title": "Total Cost Eur" }, "total_charge_eur": { "type": "number", "title": "Total Charge Eur" }, "avg_messages_per_run": { "type": "number", "title": "Avg Messages Per Run" }, "runs_last_30d": { "type": "integer", "title": "Runs Last 30D" }, "daily_runs": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Daily Runs" } }, "type": "object", "required": [ "total_runs", "total_messages", "total_tokens_input", "total_tokens_output", "total_cost_eur", "total_charge_eur", "avg_messages_per_run", "runs_last_30d", "daily_runs" ], "title": "AgentAnalyticsResponse" }, "AgentDetailResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "company_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Company Id" }, "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "avatar_emoji": { "type": "string", "title": "Avatar Emoji" }, "avatar_style": { "type": "string", "title": "Avatar Style" }, "avatar_value": { "additionalProperties": true, "type": "object", "title": "Avatar Value" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Slug" }, "system_prompt": { "type": "string", "title": "System Prompt" }, "model_id": { "type": "string", "title": "Model Id" }, "provider": { "type": "string", "title": "Provider" }, "temperature": { "type": "number", "title": "Temperature" }, "max_tokens": { "type": "integer", "title": "Max Tokens" }, "tools_enabled": { "additionalProperties": { "type": "boolean" }, "type": "object", "title": "Tools Enabled" }, "tools_config": { "additionalProperties": true, "type": "object", "title": "Tools Config" }, "document_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Document Ids" }, "is_public": { "type": "boolean", "title": "Is Public" }, "visibility": { "type": "string", "title": "Visibility" }, "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags" }, "welcome_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Welcome Message" }, "suggested_prompts": { "items": { "type": "string" }, "type": "array", "title": "Suggested Prompts" }, "pinned": { "type": "boolean", "title": "Pinned" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "recent_runs": { "items": { "$ref": "#/components/schemas/AgentRunResponse" }, "type": "array", "title": "Recent Runs", "default": [] } }, "type": "object", "required": [ "id", "company_id", "user_id", "name", "description", "avatar_emoji", "avatar_style", "avatar_value", "slug", "system_prompt", "model_id", "provider", "temperature", "max_tokens", "tools_enabled", "tools_config", "document_ids", "is_public", "visibility", "tags", "welcome_message", "suggested_prompts", "pinned", "created_at", "updated_at" ], "title": "AgentDetailResponse" }, "AgentGrantResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "agent_id": { "type": "string", "format": "uuid", "title": "Agent Id" }, "grantee_type": { "type": "string", "title": "Grantee Type" }, "grantee_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Grantee Id" }, "permission": { "type": "string", "title": "Permission" }, "granted_by": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Granted By" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "agent_id", "grantee_type", "grantee_id", "permission", "granted_by", "created_at" ], "title": "AgentGrantResponse" }, "AgentListResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/AgentResponse" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "per_page": { "type": "integer", "title": "Per Page" } }, "type": "object", "required": [ "items", "total", "page", "per_page" ], "title": "AgentListResponse" }, "AgentResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "company_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Company Id" }, "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "avatar_emoji": { "type": "string", "title": "Avatar Emoji" }, "avatar_style": { "type": "string", "title": "Avatar Style" }, "avatar_value": { "additionalProperties": true, "type": "object", "title": "Avatar Value" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Slug" }, "system_prompt": { "type": "string", "title": "System Prompt" }, "model_id": { "type": "string", "title": "Model Id" }, "provider": { "type": "string", "title": "Provider" }, "temperature": { "type": "number", "title": "Temperature" }, "max_tokens": { "type": "integer", "title": "Max Tokens" }, "tools_enabled": { "additionalProperties": { "type": "boolean" }, "type": "object", "title": "Tools Enabled" }, "tools_config": { "additionalProperties": true, "type": "object", "title": "Tools Config" }, "document_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Document Ids" }, "is_public": { "type": "boolean", "title": "Is Public" }, "visibility": { "type": "string", "title": "Visibility" }, "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags" }, "welcome_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Welcome Message" }, "suggested_prompts": { "items": { "type": "string" }, "type": "array", "title": "Suggested Prompts" }, "pinned": { "type": "boolean", "title": "Pinned" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "required": [ "id", "company_id", "user_id", "name", "description", "avatar_emoji", "avatar_style", "avatar_value", "slug", "system_prompt", "model_id", "provider", "temperature", "max_tokens", "tools_enabled", "tools_config", "document_ids", "is_public", "visibility", "tags", "welcome_message", "suggested_prompts", "pinned", "created_at", "updated_at" ], "title": "AgentResponse" }, "AgentRunListResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/AgentRunResponse" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "per_page": { "type": "integer", "title": "Per Page" } }, "type": "object", "required": [ "items", "total", "page", "per_page" ], "title": "AgentRunListResponse" }, "AgentRunMessageResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "run_id": { "type": "string", "format": "uuid", "title": "Run Id" }, "role": { "type": "string", "title": "Role" }, "content": { "type": "string", "title": "Content" }, "tokens_input": { "type": "integer", "title": "Tokens Input" }, "tokens_output": { "type": "integer", "title": "Tokens Output" }, "cost_eur": { "type": "number", "title": "Cost Eur" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "metadata_": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" } }, "type": "object", "required": [ "id", "run_id", "role", "content", "tokens_input", "tokens_output", "cost_eur", "created_at" ], "title": "AgentRunMessageResponse" }, "AgentRunResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "agent_id": { "type": "string", "format": "uuid", "title": "Agent Id" }, "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, "company_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Company Id" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "required": [ "id", "agent_id", "user_id", "company_id", "title", "created_at", "updated_at" ], "title": "AgentRunResponse" }, "AgentRunWithMessagesResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "agent_id": { "type": "string", "format": "uuid", "title": "Agent Id" }, "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, "company_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Company Id" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "messages": { "items": { "$ref": "#/components/schemas/AgentRunMessageResponse" }, "type": "array", "title": "Messages", "default": [] } }, "type": "object", "required": [ "id", "agent_id", "user_id", "company_id", "title", "created_at", "updated_at" ], "title": "AgentRunWithMessagesResponse" }, "AgentTemplateResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "category": { "type": "string", "title": "Category" }, "avatar_emoji": { "type": "string", "title": "Avatar Emoji" }, "avatar_style": { "type": "string", "title": "Avatar Style" }, "avatar_value": { "additionalProperties": true, "type": "object", "title": "Avatar Value" }, "system_prompt": { "type": "string", "title": "System Prompt" }, "model_id": { "type": "string", "title": "Model Id" }, "provider": { "type": "string", "title": "Provider" }, "temperature": { "type": "number", "title": "Temperature" }, "max_tokens": { "type": "integer", "title": "Max Tokens" }, "tools_enabled": { "additionalProperties": true, "type": "object", "title": "Tools Enabled" }, "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags" }, "suggested_prompts": { "items": { "type": "string" }, "type": "array", "title": "Suggested Prompts" }, "welcome_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Welcome Message" } }, "type": "object", "required": [ "id", "name", "description", "category", "avatar_emoji", "avatar_style", "avatar_value", "system_prompt", "model_id", "provider", "temperature", "max_tokens", "tools_enabled", "tags", "suggested_prompts", "welcome_message" ], "title": "AgentTemplateResponse" }, "AgentVersionResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "agent_id": { "type": "string", "format": "uuid", "title": "Agent Id" }, "version_number": { "type": "integer", "title": "Version Number" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "system_prompt": { "type": "string", "title": "System Prompt" }, "model_id": { "type": "string", "title": "Model Id" }, "provider": { "type": "string", "title": "Provider" }, "temperature": { "type": "number", "title": "Temperature" }, "max_tokens": { "type": "integer", "title": "Max Tokens" }, "tools_enabled": { "additionalProperties": true, "type": "object", "title": "Tools Enabled" }, "tools_config": { "additionalProperties": true, "type": "object", "title": "Tools Config" }, "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags" }, "welcome_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Welcome Message" }, "suggested_prompts": { "items": { "type": "string" }, "type": "array", "title": "Suggested Prompts" }, "created_by": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Created By" }, "change_note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Change Note" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "agent_id", "version_number", "name", "description", "system_prompt", "model_id", "provider", "temperature", "max_tokens", "tools_enabled", "tools_config", "tags", "welcome_message", "suggested_prompts", "created_by", "change_note", "created_at" ], "title": "AgentVersionResponse" }, "ApiKeyCreatedResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "scopes": { "items": { "type": "string" }, "type": "array", "title": "Scopes" }, "last_used_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Used At" }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Expires At" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "key": { "type": "string", "title": "Key" } }, "type": "object", "required": [ "id", "name", "scopes", "last_used_at", "expires_at", "created_at", "key" ], "title": "ApiKeyCreatedResponse" }, "ApiKeyResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "scopes": { "items": { "type": "string" }, "type": "array", "title": "Scopes" }, "last_used_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Used At" }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Expires At" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "name", "scopes", "last_used_at", "expires_at", "created_at" ], "title": "ApiKeyResponse" }, "BillingConfigResponse": { "properties": { "company_id": { "type": "string", "format": "uuid", "title": "Company Id" }, "vat_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vat Number" }, "country_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country Code" }, "business_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Business Name" }, "billing_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Billing Email" }, "tax_exempt": { "type": "boolean", "title": "Tax Exempt", "default": false }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" } }, "type": "object", "required": [ "company_id", "vat_number", "country_code", "business_name", "billing_email", "updated_at" ], "title": "BillingConfigResponse" }, "BillingConfigUpdate": { "properties": { "vat_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vat Number" }, "country_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country Code" }, "business_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Business Name" }, "billing_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Billing Email" }, "tax_exempt": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Tax Exempt" } }, "type": "object", "title": "BillingConfigUpdate" }, "Body_ocr_file_api_v1_translate_ocr_post": { "properties": { "file": { "type": "string", "format": "binary", "title": "File" }, "target_language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Language" }, "engine": { "type": "string", "title": "Engine", "default": "auto" } }, "type": "object", "required": [ "file" ], "title": "Body_ocr_file_api_v1_translate_ocr_post" }, "Body_process_media_audio_api_v1_translate_media_audio_post": { "properties": { "file": { "type": "string", "format": "binary", "title": "File" }, "target_language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Language" } }, "type": "object", "required": [ "file" ], "title": "Body_process_media_audio_api_v1_translate_media_audio_post" }, "Body_transcribe_api_v1_voice_transcribe_post": { "properties": { "file": { "type": "string", "format": "binary", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_transcribe_api_v1_voice_transcribe_post" }, "Body_upload_avatar_api_v1_me_avatar_post": { "properties": { "file": { "type": "string", "format": "binary", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_upload_avatar_api_v1_me_avatar_post" }, "Body_upload_document_api_v1_documents_upload_post": { "properties": { "file": { "type": "string", "format": "binary", "title": "File" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" } }, "type": "object", "required": [ "file" ], "title": "Body_upload_document_api_v1_documents_upload_post" }, "Body_upload_file_api_v1_bulk_upload_post": { "properties": { "file": { "type": "string", "format": "binary", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_upload_file_api_v1_bulk_upload_post" }, "Body_upload_logo_api_v1_admin_branding_logo_post": { "properties": { "file": { "type": "string", "format": "binary", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_upload_logo_api_v1_admin_branding_logo_post" }, "BrandingPatchRequest": { "properties": { "company_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Company Name" }, "logo_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Logo Url" }, "primary_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Primary Color" }, "accent_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accent Color" }, "email_footer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email Footer" }, "custom_domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custom Domain" } }, "type": "object", "title": "BrandingPatchRequest" }, "BulkInvitationRequest": { "properties": { "emails": { "items": { "type": "string", "format": "email" }, "type": "array", "title": "Emails" }, "role": { "type": "string", "title": "Role", "default": "member" }, "personal_note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Personal Note" } }, "type": "object", "required": [ "emails" ], "title": "BulkInvitationRequest" }, "CheckoutRequest": { "properties": { "plan_name": { "type": "string", "pattern": "^(starter|professional|enterprise)$", "title": "Plan Name" }, "success_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Success Url" }, "cancel_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cancel Url" } }, "type": "object", "required": [ "plan_name" ], "title": "CheckoutRequest" }, "CheckoutResponse": { "properties": { "checkout_url": { "type": "string", "title": "Checkout Url" } }, "type": "object", "required": [ "checkout_url" ], "title": "CheckoutResponse" }, "ChunkResult": { "properties": { "chunk_id": { "type": "string", "format": "uuid", "title": "Chunk Id" }, "document_id": { "type": "string", "format": "uuid", "title": "Document Id" }, "filename": { "type": "string", "title": "Filename" }, "content": { "type": "string", "title": "Content" }, "chunk_index": { "type": "integer", "title": "Chunk Index" }, "score": { "type": "number", "title": "Score" } }, "type": "object", "required": [ "chunk_id", "document_id", "filename", "content", "chunk_index", "score" ], "title": "ChunkResult" }, "CommentResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "parent_type": { "type": "string", "title": "Parent Type" }, "parent_id": { "type": "string", "format": "uuid", "title": "Parent Id" }, "thread_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Thread Id" }, "body": { "type": "string", "title": "Body" }, "body_text": { "type": "string", "title": "Body Text" }, "author_id": { "type": "string", "format": "uuid", "title": "Author Id" }, "edited_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Edited At" }, "resolved_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Resolved At" }, "resolved_by": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Resolved By" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "parent_type", "parent_id", "thread_id", "body", "body_text", "author_id", "edited_at", "resolved_at", "resolved_by", "created_at" ], "title": "CommentResponse" }, "CommitRequest": { "properties": { "reservation_id": { "type": "string", "format": "uuid", "title": "Reservation Id" } }, "type": "object", "required": [ "reservation_id" ], "title": "CommitRequest" }, "CompanyInfo": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "plan": { "type": "string", "title": "Plan" }, "credits_remaining": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Credits Remaining" }, "role": { "type": "string", "title": "Role", "default": "member" } }, "type": "object", "required": [ "id", "name", "plan" ], "title": "CompanyInfo" }, "CompanyPatchRequest": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "plan": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Plan" } }, "type": "object", "title": "CompanyPatchRequest" }, "CompanyResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "plan": { "type": "string", "title": "Plan" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "name", "plan", "created_at" ], "title": "CompanyResponse" }, "CompanyUpdateRequest": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 255, "minLength": 1 }, { "type": "null" } ], "title": "Name" }, "plan": { "anyOf": [ { "type": "string", "maxLength": 50, "minLength": 1 }, { "type": "null" } ], "title": "Plan" } }, "type": "object", "title": "CompanyUpdateRequest" }, "ConnectorDetail": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "provider": { "type": "string", "title": "Provider" }, "display_name": { "type": "string", "title": "Display Name" }, "account_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Account Email" }, "status": { "type": "string", "title": "Status" }, "scope": { "items": { "type": "string" }, "type": "array", "title": "Scope" }, "last_sync_at": { "anyOf": [ {}, { "type": "null" } ], "title": "Last Sync At" }, "last_error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Error" }, "created_at": { "title": "Created At" }, "folders": { "items": { "$ref": "#/components/schemas/FolderOut" }, "type": "array", "title": "Folders", "default": [] } }, "type": "object", "required": [ "id", "provider", "display_name", "account_email", "status", "scope", "last_sync_at", "last_error", "created_at" ], "title": "ConnectorDetail" }, "ConnectorOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "provider": { "type": "string", "title": "Provider" }, "display_name": { "type": "string", "title": "Display Name" }, "account_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Account Email" }, "status": { "type": "string", "title": "Status" }, "scope": { "items": { "type": "string" }, "type": "array", "title": "Scope" }, "last_sync_at": { "anyOf": [ {}, { "type": "null" } ], "title": "Last Sync At" }, "last_error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Error" }, "created_at": { "title": "Created At" } }, "type": "object", "required": [ "id", "provider", "display_name", "account_email", "status", "scope", "last_sync_at", "last_error", "created_at" ], "title": "ConnectorOut" }, "ConnectorPatch": { "properties": { "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" } }, "type": "object", "title": "ConnectorPatch" }, "CookiePrefsBody": { "properties": { "necessary": { "type": "boolean", "title": "Necessary", "default": true }, "analytics": { "type": "boolean", "title": "Analytics", "default": false }, "marketing": { "type": "boolean", "title": "Marketing", "default": false } }, "type": "object", "title": "CookiePrefsBody" }, "CreateAgentRequest": { "properties": { "name": { "type": "string", "maxLength": 100, "minLength": 1, "title": "Name" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Description" }, "avatar_emoji": { "type": "string", "maxLength": 8, "title": "Avatar Emoji", "default": "🤖" }, "avatar_style": { "type": "string", "maxLength": 20, "title": "Avatar Style", "default": "emoji" }, "avatar_value": { "additionalProperties": true, "type": "object", "title": "Avatar Value" }, "system_prompt": { "type": "string", "maxLength": 50000, "minLength": 1, "title": "System Prompt" }, "model_id": { "type": "string", "maxLength": 100, "title": "Model Id", "default": "claude-sonnet-4-6" }, "provider": { "type": "string", "maxLength": 50, "title": "Provider", "default": "anthropic" }, "temperature": { "type": "number", "maximum": 2, "minimum": 0, "title": "Temperature", "default": 0.7 }, "max_tokens": { "type": "integer", "maximum": 32000, "minimum": 1, "title": "Max Tokens", "default": 4096 }, "tools_enabled": { "$ref": "#/components/schemas/ToolsEnabled" }, "tools_config": { "additionalProperties": true, "type": "object", "title": "Tools Config" }, "document_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Document Ids" }, "is_public": { "type": "boolean", "title": "Is Public", "default": false }, "visibility": { "type": "string", "enum": [ "private", "company", "public" ], "title": "Visibility", "default": "private" }, "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags" }, "welcome_message": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ], "title": "Welcome Message" }, "suggested_prompts": { "items": { "type": "string" }, "type": "array", "title": "Suggested Prompts" } }, "type": "object", "required": [ "name", "system_prompt" ], "title": "CreateAgentRequest" }, "CreateCommentRequest": { "properties": { "parent_type": { "type": "string", "enum": [ "agent", "workflow", "research", "bulk", "document" ], "title": "Parent Type" }, "parent_id": { "type": "string", "format": "uuid", "title": "Parent Id" }, "thread_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Thread Id" }, "body": { "type": "string", "maxLength": 4000, "minLength": 1, "title": "Body" }, "body_text": { "type": "string", "maxLength": 4000, "minLength": 1, "title": "Body Text" } }, "type": "object", "required": [ "parent_type", "parent_id", "body", "body_text" ], "title": "CreateCommentRequest" }, "CreateDocRequest": { "properties": { "title": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Title" }, "content": { "type": "string", "title": "Content", "default": "" } }, "type": "object", "required": [ "title" ], "title": "CreateDocRequest" }, "CreateFromTemplateRequest": { "properties": { "template_slug": { "type": "string", "maxLength": 140, "minLength": 1, "title": "Template Slug" }, "name": { "anyOf": [ { "type": "string", "maxLength": 120 }, { "type": "null" } ], "title": "Name" } }, "type": "object", "required": [ "template_slug" ], "title": "CreateFromTemplateRequest" }, "CreateJobRequest": { "properties": { "name": { "type": "string", "maxLength": 160, "minLength": 1, "title": "Name" }, "upload_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Upload Id" }, "paste_data": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Paste Data" }, "operation": { "type": "string", "enum": [ "prompt", "agent", "extract", "translate", "classify" ], "title": "Operation" }, "config": { "additionalProperties": true, "type": "object", "title": "Config" }, "parallelism": { "type": "integer", "maximum": 25, "minimum": 1, "title": "Parallelism", "default": 5 }, "visibility": { "type": "string", "enum": [ "private", "shared", "company" ], "title": "Visibility", "default": "private" } }, "type": "object", "required": [ "name", "operation" ], "title": "CreateJobRequest" }, "CreatePromptRequest": { "properties": { "title": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Title" }, "content": { "type": "string", "minLength": 1, "title": "Content" }, "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags", "default": [] } }, "type": "object", "required": [ "title", "content" ], "title": "CreatePromptRequest" }, "CreateReportRequest": { "properties": { "question": { "type": "string", "maxLength": 2000, "minLength": 5, "title": "Question" }, "depth": { "type": "string", "enum": [ "quick", "standard", "deep" ], "title": "Depth", "default": "standard" }, "region": { "type": "string", "enum": [ "all", "nl", "eu", "us" ], "title": "Region", "default": "all" }, "use_workspace_docs": { "type": "boolean", "title": "Use Workspace Docs", "default": true }, "document_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Document Ids" }, "language": { "type": "string", "enum": [ "auto", "en", "nl" ], "title": "Language", "default": "auto" } }, "type": "object", "required": [ "question" ], "title": "CreateReportRequest" }, "CreateRunRequest": { "properties": { "title": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ], "title": "Title" } }, "type": "object", "title": "CreateRunRequest" }, "CreateSavedViewRequest": { "properties": { "name": { "type": "string", "maxLength": 120, "minLength": 1, "title": "Name" }, "page": { "type": "string", "maxLength": 40, "minLength": 1, "title": "Page" }, "query": { "additionalProperties": true, "type": "object", "title": "Query" }, "pinned": { "type": "boolean", "title": "Pinned", "default": false } }, "type": "object", "required": [ "name", "page" ], "title": "CreateSavedViewRequest" }, "CreateScheduleRequest": { "properties": { "cron": { "type": "string", "maxLength": 40, "minLength": 1, "title": "Cron" }, "timezone": { "type": "string", "maxLength": 64, "title": "Timezone", "default": "Europe/Amsterdam" }, "inputs": { "additionalProperties": true, "type": "object", "title": "Inputs" }, "enabled": { "type": "boolean", "title": "Enabled", "default": true } }, "type": "object", "required": [ "cron" ], "title": "CreateScheduleRequest" }, "CreateSessionRequest": { "properties": { "title": { "type": "string", "maxLength": 255, "title": "Title", "default": "New Chat" }, "model_id": { "type": "string", "maxLength": 100, "title": "Model Id" }, "provider": { "type": "string", "maxLength": 50, "title": "Provider" }, "system_prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "System Prompt" }, "web_search_enabled": { "type": "boolean", "title": "Web Search Enabled", "default": false } }, "type": "object", "required": [ "model_id", "provider" ], "title": "CreateSessionRequest" }, "CreateWorkflowRequest": { "properties": { "name": { "type": "string", "maxLength": 120, "minLength": 1, "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "emoji": { "anyOf": [ { "type": "string", "maxLength": 8 }, { "type": "null" } ], "title": "Emoji" }, "category": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ], "title": "Category" }, "graph": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Graph" }, "inputs_schema": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Inputs Schema" }, "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags" }, "visibility": { "anyOf": [ { "type": "string", "maxLength": 16 }, { "type": "null" } ], "title": "Visibility" } }, "type": "object", "required": [ "name" ], "title": "CreateWorkflowRequest" }, "CreateWorkspaceRequest": { "properties": { "name": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" } }, "type": "object", "required": [ "name" ], "title": "CreateWorkspaceRequest" }, "CreditBalanceResponse": { "properties": { "company_id": { "type": "string", "format": "uuid", "title": "Company Id" }, "period_month": { "type": "string", "title": "Period Month" }, "credits_allocated": { "type": "integer", "title": "Credits Allocated" }, "credits_used": { "type": "integer", "title": "Credits Used" }, "credits_reserved": { "type": "integer", "title": "Credits Reserved" }, "credits_available": { "type": "integer", "title": "Credits Available" } }, "type": "object", "required": [ "company_id", "period_month", "credits_allocated", "credits_used", "credits_reserved", "credits_available" ], "title": "CreditBalanceResponse" }, "CreditGrantRequest": { "properties": { "amount_eur": { "type": "number", "title": "Amount Eur" }, "note": { "type": "string", "title": "Note", "default": "" } }, "type": "object", "required": [ "amount_eur" ], "title": "CreditGrantRequest" }, "DailyRunStat": { "properties": { "date": { "type": "string", "title": "Date" }, "count": { "type": "integer", "title": "Count" }, "success": { "type": "integer", "title": "Success" }, "failed": { "type": "integer", "title": "Failed" } }, "type": "object", "required": [ "date", "count", "success", "failed" ], "title": "DailyRunStat" }, "DeleteCancelBody": { "properties": { "token": { "type": "string", "title": "Token" } }, "type": "object", "required": [ "token" ], "title": "DeleteCancelBody" }, "DeleteRequestBody": { "properties": { "current_password": { "type": "string", "title": "Current Password" }, "confirmation_phrase": { "type": "string", "title": "Confirmation Phrase" } }, "type": "object", "required": [ "current_password", "confirmation_phrase" ], "title": "DeleteRequestBody" }, "DocsFeedbackBody": { "properties": { "message": { "type": "string", "title": "Message" }, "page_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Url" }, "source": { "type": "string", "title": "Source", "default": "docs" } }, "type": "object", "required": [ "message" ], "title": "DocsFeedbackBody" }, "DocumentListResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/DocumentResponse" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "per_page": { "type": "integer", "title": "Per Page" } }, "type": "object", "required": [ "items", "total", "page", "per_page" ], "title": "DocumentListResponse" }, "DocumentResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "company_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Company Id" }, "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "filename": { "type": "string", "title": "Filename" }, "file_type": { "type": "string", "title": "File Type" }, "file_size": { "type": "integer", "title": "File Size" }, "status": { "type": "string", "title": "Status" }, "chunk_count": { "type": "integer", "title": "Chunk Count" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "required": [ "id", "company_id", "user_id", "title", "filename", "file_type", "file_size", "status", "chunk_count", "error_message", "created_at", "updated_at" ], "title": "DocumentResponse" }, "EmailConfirmBody": { "properties": { "token": { "type": "string", "title": "Token" } }, "type": "object", "required": [ "token" ], "title": "EmailConfirmBody" }, "EmailStartChangeBody": { "properties": { "new_email": { "type": "string", "format": "email", "title": "New Email" }, "current_password": { "type": "string", "title": "Current Password" } }, "type": "object", "required": [ "new_email", "current_password" ], "title": "EmailStartChangeBody" }, "EmailTestRequest": { "properties": { "template": { "type": "string", "enum": [ "verification", "invitation", "password_reset", "welcome", "notification_generic", "account_suspended", "account_unsuspended", "sessions_revoked", "mfa_enabled", "mfa_disabled", "password_changed", "role_changed", "invitation_accepted", "email_change_confirm", "email_changed_notice", "account_deletion_scheduled", "account_deletion_canceled", "data_export_ready", "workflow_notification", "workflow_run_failed", "workflow_shared", "mention_in_comment", "item_shared_with_you", "connector_connected", "connector_sync_failed", "connector_token_revoked", "trial_started", "trial_ending_in_2d", "trial_ended_to_free", "subscription_started", "subscription_renewed", "subscription_cancelled", "payment_succeeded", "payment_failed", "plan_upgraded", "plan_downgraded", "topup_purchased", "credit_balance_low", "margin_alert" ], "title": "Template" }, "to": { "type": "string", "title": "To" }, "locale": { "type": "string", "title": "Locale", "default": "en" }, "args": { "additionalProperties": true, "type": "object", "title": "Args", "default": {} } }, "type": "object", "required": [ "template", "to" ], "title": "EmailTestRequest" }, "ExecuteRequest": { "properties": { "code": { "type": "string", "maxLength": 50000, "minLength": 1, "title": "Code" }, "language": { "type": "string", "pattern": "^python$", "title": "Language", "default": "python" }, "timeout": { "type": "integer", "maximum": 30, "minimum": 1, "title": "Timeout", "default": 30 } }, "type": "object", "required": [ "code" ], "title": "ExecuteRequest" }, "ExecuteResponse": { "properties": { "stdout": { "type": "string", "title": "Stdout" }, "stderr": { "type": "string", "title": "Stderr" }, "exit_code": { "type": "integer", "title": "Exit Code" }, "images": { "items": { "type": "string" }, "type": "array", "title": "Images" }, "duration_ms": { "type": "integer", "title": "Duration Ms" } }, "type": "object", "required": [ "stdout", "stderr", "exit_code", "images", "duration_ms" ], "title": "ExecuteResponse" }, "ExportRequest": { "properties": { "scope": { "type": "string", "title": "Scope", "default": "all" } }, "type": "object", "title": "ExportRequest" }, "FeedbackBody": { "properties": { "message": { "type": "string", "title": "Message" }, "email_optional": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email Optional" }, "page_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Url" } }, "type": "object", "required": [ "message" ], "title": "FeedbackBody" }, "FeedbackRequest": { "properties": { "message_id": { "type": "string", "format": "uuid", "title": "Message Id" }, "feedback": { "type": "integer", "title": "Feedback" } }, "type": "object", "required": [ "message_id", "feedback" ], "title": "FeedbackRequest" }, "FileOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "folder_id": { "type": "string", "format": "uuid", "title": "Folder Id" }, "document_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Document Id" }, "external_id": { "type": "string", "title": "External Id" }, "external_path": { "type": "string", "title": "External Path" }, "mime_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mime Type" }, "size_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Size Bytes" }, "checksum": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Checksum" }, "modified_at": { "anyOf": [ {}, { "type": "null" } ], "title": "Modified At" }, "ingested_at": { "anyOf": [ {}, { "type": "null" } ], "title": "Ingested At" }, "status": { "type": "string", "title": "Status" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "attempt": { "type": "integer", "title": "Attempt" }, "created_at": { "title": "Created At" } }, "type": "object", "required": [ "id", "folder_id", "document_id", "external_id", "external_path", "mime_type", "size_bytes", "checksum", "modified_at", "ingested_at", "status", "error", "attempt", "created_at" ], "title": "FileOut" }, "FolderCreate": { "properties": { "external_id": { "type": "string", "title": "External Id" }, "external_path": { "type": "string", "title": "External Path" }, "recursive": { "type": "boolean", "title": "Recursive", "default": true }, "include_globs": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Include Globs" }, "exclude_globs": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Exclude Globs" }, "schedule_minutes": { "type": "integer", "title": "Schedule Minutes", "default": 60 } }, "type": "object", "required": [ "external_id", "external_path" ], "title": "FolderCreate" }, "FolderOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "connector_id": { "type": "string", "format": "uuid", "title": "Connector Id" }, "external_id": { "type": "string", "title": "External Id" }, "external_path": { "type": "string", "title": "External Path" }, "recursive": { "type": "boolean", "title": "Recursive" }, "include_globs": { "items": { "type": "string" }, "type": "array", "title": "Include Globs" }, "exclude_globs": { "items": { "type": "string" }, "type": "array", "title": "Exclude Globs" }, "schedule_minutes": { "type": "integer", "title": "Schedule Minutes" }, "enabled": { "type": "boolean", "title": "Enabled" }, "last_sync_at": { "anyOf": [ {}, { "type": "null" } ], "title": "Last Sync At" }, "next_sync_at": { "anyOf": [ {}, { "type": "null" } ], "title": "Next Sync At" }, "total_files": { "type": "integer", "title": "Total Files" }, "failed_files": { "type": "integer", "title": "Failed Files" }, "created_at": { "title": "Created At" } }, "type": "object", "required": [ "id", "connector_id", "external_id", "external_path", "recursive", "include_globs", "exclude_globs", "schedule_minutes", "enabled", "last_sync_at", "next_sync_at", "total_files", "failed_files", "created_at" ], "title": "FolderOut" }, "FolderPatch": { "properties": { "schedule_minutes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Schedule Minutes" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" }, "include_globs": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Include Globs" }, "exclude_globs": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Exclude Globs" } }, "type": "object", "title": "FolderPatch" }, "FromTemplateRequest": { "properties": { "template_id": { "type": "string", "title": "Template Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" } }, "type": "object", "required": [ "template_id" ], "title": "FromTemplateRequest" }, "GenerateImageRequest": { "properties": { "prompt": { "type": "string", "maxLength": 4000, "minLength": 1, "title": "Prompt" }, "size": { "type": "string", "pattern": "^(1024x1024|1792x1024|1024x1792)$", "title": "Size", "default": "1024x1024" }, "quality": { "type": "string", "pattern": "^(standard|hd)$", "title": "Quality", "default": "standard" }, "model": { "type": "string", "pattern": "^(dall-e-3|gpt-image-1)$", "title": "Model", "default": "dall-e-3" } }, "type": "object", "required": [ "prompt" ], "title": "GenerateImageRequest" }, "GenerateImageResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" }, "b64_json": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "B64 Json" }, "prompt": { "type": "string", "title": "Prompt" }, "model": { "type": "string", "title": "Model" }, "size": { "type": "string", "title": "Size" }, "quality": { "type": "string", "title": "Quality" }, "cost_eur": { "type": "number", "title": "Cost Eur" } }, "type": "object", "required": [ "id", "url", "b64_json", "prompt", "model", "size", "quality", "cost_eur" ], "title": "GenerateImageResponse" }, "GrammarRequest": { "properties": { "text": { "type": "string", "maxLength": 10000, "minLength": 1, "title": "Text" }, "language": { "type": "string", "title": "Language", "default": "en" }, "provider": { "type": "string", "title": "Provider", "default": "anthropic" }, "model_id": { "type": "string", "title": "Model Id", "default": "claude-sonnet-4-6" }, "mode": { "type": "string", "enum": [ "standard", "advanced", "c1c2" ], "title": "Mode", "default": "standard" } }, "type": "object", "required": [ "text" ], "title": "GrammarRequest" }, "GrammarResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "original_text": { "type": "string", "title": "Original Text" }, "corrected_text": { "type": "string", "title": "Corrected Text" }, "language": { "type": "string", "title": "Language" }, "provider": { "type": "string", "title": "Provider" }, "model_id": { "type": "string", "title": "Model Id" }, "credits_used": { "type": "number", "title": "Credits Used" }, "cached": { "type": "boolean", "title": "Cached", "default": false }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "original_text", "corrected_text", "language", "provider", "model_id", "credits_used", "created_at" ], "title": "GrammarResponse" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "HealthResponse": { "properties": { "status": { "type": "string", "title": "Status" }, "version": { "type": "string", "title": "Version" }, "environment": { "type": "string", "title": "Environment" } }, "type": "object", "required": [ "status", "version", "environment" ], "title": "HealthResponse" }, "InvitationRequest": { "properties": { "email": { "type": "string", "format": "email", "title": "Email" }, "role": { "type": "string", "title": "Role", "default": "member" }, "personal_note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Personal Note" } }, "type": "object", "required": [ "email" ], "title": "InvitationRequest" }, "InviteMemberRequest": { "properties": { "email": { "type": "string", "format": "email", "title": "Email" }, "role": { "type": "string", "pattern": "^(owner|admin|member)$", "title": "Role", "default": "member" } }, "type": "object", "required": [ "email" ], "title": "InviteMemberRequest" }, "InviteRequest": { "properties": { "email": { "type": "string", "format": "email", "title": "Email" }, "role": { "type": "string", "title": "Role", "default": "member" } }, "type": "object", "required": [ "email" ], "title": "InviteRequest" }, "InviteResponse": { "properties": { "invite_token": { "type": "string", "title": "Invite Token" }, "email": { "type": "string", "title": "Email" }, "expires_at": { "type": "string", "format": "date-time", "title": "Expires At" } }, "type": "object", "required": [ "invite_token", "email", "expires_at" ], "title": "InviteResponse" }, "KpiResponse": { "properties": { "total_members": { "type": "integer", "title": "Total Members" }, "events_today": { "type": "integer", "title": "Events Today" }, "events_week": { "type": "integer", "title": "Events Week" } }, "type": "object", "required": [ "total_members", "events_today", "events_week" ], "title": "KpiResponse" }, "LanguageItem": { "properties": { "code": { "type": "string", "title": "Code" }, "name": { "type": "string", "title": "Name" }, "is_rtl": { "type": "boolean", "title": "Is Rtl" } }, "type": "object", "required": [ "code", "name", "is_rtl" ], "title": "LanguageItem" }, "LoginRequest": { "properties": { "email": { "type": "string", "format": "email", "title": "Email" }, "password": { "type": "string", "title": "Password" }, "totp_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Totp Code" } }, "type": "object", "required": [ "email", "password" ], "title": "LoginRequest" }, "LogoutRequest": { "properties": { "refresh_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Refresh Token" } }, "type": "object", "title": "LogoutRequest" }, "MediaRequest": { "properties": { "mode": { "type": "string", "enum": [ "youtube", "text_to_speech" ], "title": "Mode" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Text" }, "target_language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Language" }, "voice_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Voice Id" }, "provider": { "type": "string", "title": "Provider", "default": "anthropic" }, "model_id": { "type": "string", "title": "Model Id", "default": "claude-sonnet-4-6" } }, "type": "object", "required": [ "mode" ], "title": "MediaRequest" }, "MediaResponse": { "properties": { "mode": { "type": "string", "title": "Mode" }, "transcript": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Transcript" }, "translated_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Translated Text" }, "audio_b64": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Audio B64" }, "source_language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Language" }, "credits_used": { "type": "number", "title": "Credits Used" } }, "type": "object", "required": [ "mode", "credits_used" ], "title": "MediaResponse" }, "MemoryItemResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Key" }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Value" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "key", "value", "created_at" ], "title": "MemoryItemResponse" }, "MessageResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "session_id": { "type": "string", "format": "uuid", "title": "Session Id" }, "role": { "type": "string", "title": "Role" }, "content": { "type": "string", "title": "Content" }, "model_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Id" }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" }, "tokens_input": { "type": "integer", "title": "Tokens Input" }, "tokens_output": { "type": "integer", "title": "Tokens Output" }, "cost_eur": { "type": "number", "title": "Cost Eur" }, "charge_eur": { "type": "number", "title": "Charge Eur" }, "reservation_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Reservation Id" }, "feedback": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Feedback" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "session_id", "role", "content", "model_id", "provider", "tokens_input", "tokens_output", "cost_eur", "charge_eur", "reservation_id", "feedback", "created_at" ], "title": "MessageResponse" }, "ModelCreateRequest": { "properties": { "model_id": { "type": "string", "title": "Model Id" }, "provider": { "type": "string", "title": "Provider" }, "cost_per_million": { "type": "number", "title": "Cost Per Million" }, "markup_factor": { "type": "number", "title": "Markup Factor", "default": 1.5 }, "charge_per_million": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Charge Per Million" } }, "type": "object", "required": [ "model_id", "provider", "cost_per_million" ], "title": "ModelCreateRequest" }, "ModelItem": { "properties": { "model_id": { "type": "string", "title": "Model Id" }, "provider": { "type": "string", "title": "Provider" }, "display_name": { "type": "string", "title": "Display Name" } }, "type": "object", "required": [ "model_id", "provider", "display_name" ], "title": "ModelItem" }, "ModelPatchRequest": { "properties": { "markup_factor": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Markup Factor" }, "charge_per_million": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Charge Per Million" }, "blocked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Blocked" } }, "type": "object", "title": "ModelPatchRequest" }, "ModelResponse": { "properties": { "model_id": { "type": "string", "title": "Model Id" }, "provider": { "type": "string", "title": "Provider" }, "cost_per_million": { "type": "number", "title": "Cost Per Million" }, "charge_per_million": { "type": "number", "title": "Charge Per Million" } }, "type": "object", "required": [ "model_id", "provider", "cost_per_million", "charge_per_million" ], "title": "ModelResponse" }, "NotificationResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "kind": { "type": "string", "title": "Kind" }, "title": { "type": "string", "title": "Title" }, "body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Body" }, "url": { "type": "string", "title": "Url" }, "actor_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Actor Id" }, "context_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Context Type" }, "context_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Context Id" }, "read_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Read At" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "kind", "title", "body", "url", "actor_id", "context_type", "context_id", "read_at", "created_at" ], "title": "NotificationResponse" }, "OAuthRequest": { "properties": { "code": { "type": "string", "title": "Code" }, "redirect_uri": { "type": "string", "title": "Redirect Uri" } }, "type": "object", "required": [ "code", "redirect_uri" ], "title": "OAuthRequest" }, "OCRResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "extracted_text": { "type": "string", "title": "Extracted Text" }, "translated_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Translated Text" }, "source_language": { "type": "string", "title": "Source Language" }, "target_language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Language" }, "is_rtl": { "type": "boolean", "title": "Is Rtl" }, "provider": { "type": "string", "title": "Provider" }, "model_id": { "type": "string", "title": "Model Id" }, "credits_used": { "type": "number", "title": "Credits Used" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "extracted_text", "translated_text", "source_language", "target_language", "is_rtl", "provider", "model_id", "credits_used", "created_at" ], "title": "OCRResponse" }, "PasswordChangeBody": { "properties": { "current_password": { "type": "string", "title": "Current Password" }, "new_password": { "type": "string", "title": "New Password" } }, "type": "object", "required": [ "current_password", "new_password" ], "title": "PasswordChangeBody" }, "PinResponse": { "properties": { "pinned": { "type": "boolean", "title": "Pinned" } }, "type": "object", "required": [ "pinned" ], "title": "PinResponse" }, "PlanChangeRequest": { "properties": { "new_plan": { "type": "string", "title": "New Plan" } }, "type": "object", "required": [ "new_plan" ], "title": "PlanChangeRequest" }, "PlanResponse": { "properties": { "plan_name": { "type": "string", "title": "Plan Name" }, "credits_monthly": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Credits Monthly" }, "price_eur": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price Eur" }, "max_users": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Users" }, "stripe_price_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stripe Price Id" } }, "type": "object", "required": [ "plan_name", "credits_monthly", "price_eur", "max_users", "stripe_price_id" ], "title": "PlanResponse" }, "PolicyPatchRequest": { "properties": { "require_mfa": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Require Mfa" }, "password_min_length": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Password Min Length" }, "session_timeout_minutes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Session Timeout Minutes" }, "allowed_email_domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Allowed Email Domains" }, "max_login_attempts": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Login Attempts" }, "allow_open_signup": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Allow Open Signup" }, "max_users": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Users" } }, "type": "object", "title": "PolicyPatchRequest" }, "PortalRequest": { "properties": { "return_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Return Url" } }, "type": "object", "title": "PortalRequest" }, "PortalResponse": { "properties": { "portal_url": { "type": "string", "title": "Portal Url" } }, "type": "object", "required": [ "portal_url" ], "title": "PortalResponse" }, "ProfileUpdateBody": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Locale" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Timezone" } }, "type": "object", "title": "ProfileUpdateBody" }, "PurgeRequest": { "properties": { "scope": { "type": "string", "title": "Scope" }, "confirm": { "type": "string", "title": "Confirm" } }, "type": "object", "required": [ "scope", "confirm" ], "title": "PurgeRequest" }, "QueryRequest": { "properties": { "query": { "type": "string", "maxLength": 2000, "minLength": 1, "title": "Query" }, "document_ids": { "anyOf": [ { "items": { "type": "string", "format": "uuid" }, "type": "array" }, { "type": "null" } ], "title": "Document Ids" }, "top_k": { "type": "integer", "maximum": 20, "minimum": 1, "title": "Top K", "default": 5 } }, "type": "object", "required": [ "query" ], "title": "QueryRequest" }, "QueryResponse": { "properties": { "query": { "type": "string", "title": "Query" }, "results": { "items": { "$ref": "#/components/schemas/ChunkResult" }, "type": "array", "title": "Results" } }, "type": "object", "required": [ "query", "results" ], "title": "QueryResponse" }, "RefreshRequest": { "properties": { "refresh_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Refresh Token" } }, "type": "object", "title": "RefreshRequest" }, "RefundRequest": { "properties": { "reservation_id": { "type": "string", "format": "uuid", "title": "Reservation Id" } }, "type": "object", "required": [ "reservation_id" ], "title": "RefundRequest" }, "RegisterRequest": { "properties": { "email": { "type": "string", "format": "email", "title": "Email" }, "password": { "type": "string", "maxLength": 128, "minLength": 8, "title": "Password" }, "invite_token": { "type": "string", "title": "Invite Token" }, "recaptcha_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Recaptcha Token" } }, "type": "object", "required": [ "email", "password", "invite_token" ], "title": "RegisterRequest" }, "ResearchHistoryResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ResearchJobResponse" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "per_page": { "type": "integer", "title": "Per Page" } }, "type": "object", "required": [ "items", "total", "page", "per_page" ], "title": "ResearchHistoryResponse" }, "ResearchJobResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "company_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Company Id" }, "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, "query": { "type": "string", "title": "Query" }, "depth": { "type": "string", "title": "Depth" }, "status": { "type": "string", "title": "Status" }, "sources_found": { "type": "integer", "title": "Sources Found" }, "sources_used": { "type": "integer", "title": "Sources Used" }, "result_markdown": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Result Markdown" }, "result_summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Result Summary" }, "credits_used": { "type": "string", "title": "Credits Used" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message" }, "started_at": { "type": "string", "format": "date-time", "title": "Started At" }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At" } }, "type": "object", "required": [ "id", "company_id", "user_id", "query", "depth", "status", "sources_found", "sources_used", "result_markdown", "result_summary", "credits_used", "error_message", "started_at", "completed_at" ], "title": "ResearchJobResponse" }, "ResearchResultResponse": { "properties": { "job_id": { "type": "string", "format": "uuid", "title": "Job Id" }, "status": { "type": "string", "title": "Status" }, "result_markdown": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Result Markdown" }, "result_summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Result Summary" }, "sources_used": { "type": "integer", "title": "Sources Used" }, "credits_used": { "type": "string", "title": "Credits Used" } }, "type": "object", "required": [ "job_id", "status", "result_markdown", "result_summary", "sources_used", "credits_used" ], "title": "ResearchResultResponse" }, "ResearchStatusResponse": { "properties": { "job_id": { "type": "string", "format": "uuid", "title": "Job Id" }, "status": { "type": "string", "title": "Status" }, "sources_found": { "type": "integer", "title": "Sources Found" }, "sources_used": { "type": "integer", "title": "Sources Used" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message" } }, "type": "object", "required": [ "job_id", "status", "sources_found", "sources_used", "error_message" ], "title": "ResearchStatusResponse" }, "ReserveRequest": { "properties": { "feature_key": { "type": "string", "title": "Feature Key" }, "quantity": { "type": "number", "exclusiveMinimum": 0, "title": "Quantity", "default": 1 } }, "type": "object", "required": [ "feature_key" ], "title": "ReserveRequest" }, "ReserveResponse": { "properties": { "reservation_id": { "type": "string", "format": "uuid", "title": "Reservation Id" }, "credits_reserved": { "type": "integer", "title": "Credits Reserved" }, "credits_available_after": { "type": "integer", "title": "Credits Available After" } }, "type": "object", "required": [ "reservation_id", "credits_reserved", "credits_available_after" ], "title": "ReserveResponse" }, "SavedViewResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "page": { "type": "string", "title": "Page" }, "query": { "additionalProperties": true, "type": "object", "title": "Query" }, "pinned": { "type": "boolean", "title": "Pinned" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "name", "page", "query", "pinned", "created_at" ], "title": "SavedViewResponse" }, "SessionListResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/SessionResponse" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "per_page": { "type": "integer", "title": "Per Page" } }, "type": "object", "required": [ "items", "total", "page", "per_page" ], "title": "SessionListResponse" }, "SessionResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "company_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Company Id" }, "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, "title": { "type": "string", "title": "Title" }, "model_id": { "type": "string", "title": "Model Id" }, "provider": { "type": "string", "title": "Provider" }, "system_prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "System Prompt" }, "is_archived": { "type": "boolean", "title": "Is Archived" }, "message_count": { "type": "integer", "title": "Message Count" }, "web_search_enabled": { "type": "boolean", "title": "Web Search Enabled" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "required": [ "id", "company_id", "user_id", "title", "model_id", "provider", "system_prompt", "is_archived", "message_count", "web_search_enabled", "created_at", "updated_at" ], "title": "SessionResponse" }, "SessionWithMessagesResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "company_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Company Id" }, "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, "title": { "type": "string", "title": "Title" }, "model_id": { "type": "string", "title": "Model Id" }, "provider": { "type": "string", "title": "Provider" }, "system_prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "System Prompt" }, "is_archived": { "type": "boolean", "title": "Is Archived" }, "message_count": { "type": "integer", "title": "Message Count" }, "web_search_enabled": { "type": "boolean", "title": "Web Search Enabled" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "messages": { "items": { "$ref": "#/components/schemas/MessageResponse" }, "type": "array", "title": "Messages" } }, "type": "object", "required": [ "id", "company_id", "user_id", "title", "model_id", "provider", "system_prompt", "is_archived", "message_count", "web_search_enabled", "created_at", "updated_at", "messages" ], "title": "SessionWithMessagesResponse" }, "SetAvatarRequest": { "properties": { "style": { "type": "string", "enum": [ "emoji", "gradient", "image" ], "title": "Style", "default": "emoji" }, "value": { "additionalProperties": true, "type": "object", "title": "Value" } }, "type": "object", "title": "SetAvatarRequest" }, "StartResearchRequest": { "properties": { "query": { "type": "string", "maxLength": 2000, "minLength": 3, "title": "Query" }, "depth": { "type": "string", "enum": [ "standard", "deep" ], "title": "Depth", "default": "standard" } }, "type": "object", "required": [ "query" ], "title": "StartResearchRequest" }, "StartResearchResponse": { "properties": { "job_id": { "type": "string", "format": "uuid", "title": "Job Id" }, "status": { "type": "string", "title": "Status" }, "depth": { "type": "string", "title": "Depth" }, "credits_reserved": { "type": "integer", "title": "Credits Reserved" } }, "type": "object", "required": [ "job_id", "status", "depth", "credits_reserved" ], "title": "StartResearchResponse" }, "StartRunRequest": { "properties": { "inputs": { "additionalProperties": true, "type": "object", "title": "Inputs" }, "dry_run": { "type": "boolean", "title": "Dry Run", "default": false } }, "type": "object", "title": "StartRunRequest" }, "StartRunResponse": { "properties": { "run_id": { "type": "string", "format": "uuid", "title": "Run Id" } }, "type": "object", "required": [ "run_id" ], "title": "StartRunResponse" }, "StepUpRequest": { "properties": { "password": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Password" }, "mfa_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mfa Code" } }, "type": "object", "title": "StepUpRequest" }, "SubscriptionResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "company_id": { "type": "string", "format": "uuid", "title": "Company Id" }, "plan_name": { "type": "string", "title": "Plan Name" }, "status": { "type": "string", "title": "Status" }, "stripe_subscription_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stripe Subscription Id" }, "current_period_end": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Current Period End" }, "cancel_at_period_end": { "type": "boolean", "title": "Cancel At Period End" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "company_id", "plan_name", "status", "stripe_subscription_id", "current_period_end", "cancel_at_period_end", "created_at" ], "title": "SubscriptionResponse" }, "SummaryRequest": { "properties": { "text": { "type": "string", "maxLength": 50000, "minLength": 1, "title": "Text" }, "output_language": { "type": "string", "title": "Output Language", "default": "en" }, "provider": { "type": "string", "title": "Provider", "default": "anthropic" }, "model_id": { "type": "string", "title": "Model Id", "default": "claude-sonnet-4-6" }, "length": { "type": "string", "enum": [ "short", "medium", "long" ], "title": "Length", "default": "medium" } }, "type": "object", "required": [ "text" ], "title": "SummaryRequest" }, "SummaryResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "source_text": { "type": "string", "title": "Source Text" }, "summary": { "type": "string", "title": "Summary" }, "output_language": { "type": "string", "title": "Output Language" }, "provider": { "type": "string", "title": "Provider" }, "model_id": { "type": "string", "title": "Model Id" }, "credits_used": { "type": "number", "title": "Credits Used" }, "cached": { "type": "boolean", "title": "Cached", "default": false }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "source_text", "summary", "output_language", "provider", "model_id", "credits_used", "created_at" ], "title": "SummaryResponse" }, "SuspendRequest": { "properties": { "reason": { "type": "string", "title": "Reason" } }, "type": "object", "required": [ "reason" ], "title": "SuspendRequest" }, "SyncRunOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "folder_id": { "type": "string", "format": "uuid", "title": "Folder Id" }, "connector_id": { "type": "string", "format": "uuid", "title": "Connector Id" }, "status": { "type": "string", "title": "Status" }, "started_at": { "title": "Started At" }, "ended_at": { "anyOf": [ {}, { "type": "null" } ], "title": "Ended At" }, "files_seen": { "type": "integer", "title": "Files Seen" }, "files_added": { "type": "integer", "title": "Files Added" }, "files_updated": { "type": "integer", "title": "Files Updated" }, "files_removed": { "type": "integer", "title": "Files Removed" }, "files_failed": { "type": "integer", "title": "Files Failed" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "trigger_kind": { "type": "string", "title": "Trigger Kind" } }, "type": "object", "required": [ "id", "folder_id", "connector_id", "status", "started_at", "ended_at", "files_seen", "files_added", "files_updated", "files_removed", "files_failed", "error", "trigger_kind" ], "title": "SyncRunOut" }, "SynthesizeRequest": { "properties": { "text": { "type": "string", "maxLength": 5000, "minLength": 1, "title": "Text" }, "voice_id": { "type": "string", "maxLength": 100, "title": "Voice Id", "default": "21m00Tcm4TlvDq8ikWAM" }, "model_id": { "type": "string", "maxLength": 100, "title": "Model Id", "default": "eleven_multilingual_v2" } }, "type": "object", "required": [ "text" ], "title": "SynthesizeRequest" }, "TOTPSetupResponse": { "properties": { "provisioning_uri": { "type": "string", "title": "Provisioning Uri" }, "secret": { "type": "string", "title": "Secret" } }, "type": "object", "required": [ "provisioning_uri", "secret" ], "title": "TOTPSetupResponse" }, "TOTPVerifyRequest": { "properties": { "code": { "type": "string", "maxLength": 6, "minLength": 6, "title": "Code" } }, "type": "object", "required": [ "code" ], "title": "TOTPVerifyRequest" }, "TTSRequest": { "properties": { "text": { "type": "string", "maxLength": 5000, "minLength": 1, "title": "Text" }, "voice_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Voice Id" }, "model_id": { "type": "string", "title": "Model Id", "default": "eleven_multilingual_v2" } }, "type": "object", "required": [ "text" ], "title": "TTSRequest" }, "TestAgentRequest": { "properties": { "system_prompt": { "type": "string", "maxLength": 50000, "minLength": 1, "title": "System Prompt" }, "model_id": { "type": "string", "maxLength": 100, "title": "Model Id", "default": "claude-sonnet-4-6" }, "provider": { "type": "string", "maxLength": 50, "title": "Provider", "default": "anthropic" }, "temperature": { "type": "number", "maximum": 2, "minimum": 0, "title": "Temperature", "default": 0.7 }, "max_tokens": { "type": "integer", "maximum": 16000, "minimum": 1, "title": "Max Tokens", "default": 2048 }, "tools_enabled": { "$ref": "#/components/schemas/ToolsEnabled" }, "message": { "type": "string", "maxLength": 10000, "minLength": 1, "title": "Message" } }, "type": "object", "required": [ "system_prompt", "message" ], "title": "TestAgentRequest" }, "TokenResponse": { "properties": { "access_token": { "type": "string", "title": "Access Token" }, "token_type": { "type": "string", "title": "Token Type", "default": "bearer" }, "expires_in": { "type": "integer", "title": "Expires In" }, "refresh_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Refresh Token" } }, "type": "object", "required": [ "access_token", "expires_in" ], "title": "TokenResponse" }, "ToolsEnabled": { "properties": { "web": { "type": "boolean", "title": "Web", "default": false }, "code": { "type": "boolean", "title": "Code", "default": false }, "image": { "type": "boolean", "title": "Image", "default": false }, "tts": { "type": "boolean", "title": "Tts", "default": false } }, "type": "object", "title": "ToolsEnabled" }, "TopupPackageResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "credits_amount": { "type": "integer", "title": "Credits Amount" }, "price_eur": { "type": "number", "title": "Price Eur" }, "stripe_price_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stripe Price Id" }, "active": { "type": "boolean", "title": "Active" }, "sort_order": { "type": "integer", "title": "Sort Order" } }, "type": "object", "required": [ "id", "name", "credits_amount", "price_eur", "stripe_price_id", "active", "sort_order" ], "title": "TopupPackageResponse" }, "TranscribeResponse": { "properties": { "text": { "type": "string", "title": "Text" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, "type": "object", "required": [ "text" ], "title": "TranscribeResponse" }, "TranslateResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "source_text": { "type": "string", "title": "Source Text" }, "translated_text": { "type": "string", "title": "Translated Text" }, "source_language": { "type": "string", "title": "Source Language" }, "target_language": { "type": "string", "title": "Target Language" }, "is_rtl": { "type": "boolean", "title": "Is Rtl" }, "provider": { "type": "string", "title": "Provider" }, "model_id": { "type": "string", "title": "Model Id" }, "credits_used": { "type": "number", "title": "Credits Used" }, "cached": { "type": "boolean", "title": "Cached", "default": false }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "source_text", "translated_text", "source_language", "target_language", "is_rtl", "provider", "model_id", "credits_used", "created_at" ], "title": "TranslateResponse" }, "TranslateTextRequest": { "properties": { "text": { "type": "string", "maxLength": 10000, "minLength": 1, "title": "Text" }, "source_language": { "type": "string", "title": "Source Language", "default": "auto" }, "target_language": { "type": "string", "maxLength": 10, "minLength": 2, "title": "Target Language" }, "provider": { "type": "string", "title": "Provider", "default": "anthropic" }, "model_id": { "type": "string", "title": "Model Id", "default": "claude-sonnet-4-6" }, "mode": { "type": "string", "enum": [ "standard", "formal", "informal", "technical" ], "title": "Mode", "default": "standard" }, "style": { "type": "string", "enum": [ "text", "word_list", "word_dict" ], "title": "Style", "default": "text" } }, "type": "object", "required": [ "text", "target_language" ], "title": "TranslateTextRequest" }, "TranslationHistoryItem": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "feature_type": { "type": "string", "title": "Feature Type" }, "source_text": { "type": "string", "title": "Source Text" }, "translated_text": { "type": "string", "title": "Translated Text" }, "source_language": { "type": "string", "title": "Source Language" }, "target_language": { "type": "string", "title": "Target Language" }, "provider": { "type": "string", "title": "Provider" }, "model_id": { "type": "string", "title": "Model Id" }, "credits_used": { "type": "number", "title": "Credits Used" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "feature_type", "source_text", "translated_text", "source_language", "target_language", "provider", "model_id", "credits_used", "created_at" ], "title": "TranslationHistoryItem" }, "TranslationHistoryResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/TranslationHistoryItem" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "per_page": { "type": "integer", "title": "Per Page" } }, "type": "object", "required": [ "items", "total", "page", "per_page" ], "title": "TranslationHistoryResponse" }, "UnlinkRequest": { "properties": { "provider": { "type": "string", "title": "Provider" } }, "type": "object", "required": [ "provider" ], "title": "UnlinkRequest" }, "UnreadCountResponse": { "properties": { "unread": { "type": "integer", "title": "Unread" } }, "type": "object", "required": [ "unread" ], "title": "UnreadCountResponse" }, "UpdateAgentRequest": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ], "title": "Name" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Description" }, "avatar_emoji": { "anyOf": [ { "type": "string", "maxLength": 8 }, { "type": "null" } ], "title": "Avatar Emoji" }, "avatar_style": { "anyOf": [ { "type": "string", "maxLength": 20 }, { "type": "null" } ], "title": "Avatar Style" }, "avatar_value": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Avatar Value" }, "system_prompt": { "anyOf": [ { "type": "string", "maxLength": 50000 }, { "type": "null" } ], "title": "System Prompt" }, "model_id": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ], "title": "Model Id" }, "provider": { "anyOf": [ { "type": "string", "maxLength": 50 }, { "type": "null" } ], "title": "Provider" }, "temperature": { "anyOf": [ { "type": "number", "maximum": 2, "minimum": 0 }, { "type": "null" } ], "title": "Temperature" }, "max_tokens": { "anyOf": [ { "type": "integer", "maximum": 32000, "minimum": 1 }, { "type": "null" } ], "title": "Max Tokens" }, "tools_enabled": { "anyOf": [ { "$ref": "#/components/schemas/ToolsEnabled" }, { "type": "null" } ] }, "tools_config": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Tools Config" }, "document_ids": { "anyOf": [ { "items": { "type": "string", "format": "uuid" }, "type": "array" }, { "type": "null" } ], "title": "Document Ids" }, "is_public": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Public" }, "visibility": { "anyOf": [ { "type": "string", "enum": [ "private", "company", "public" ] }, { "type": "null" } ], "title": "Visibility" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "welcome_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Welcome Message" }, "suggested_prompts": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Suggested Prompts" }, "change_note": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Change Note" } }, "type": "object", "title": "UpdateAgentRequest" }, "UpdateCommentRequest": { "properties": { "body": { "type": "string", "maxLength": 4000, "minLength": 1, "title": "Body" }, "body_text": { "type": "string", "maxLength": 4000, "minLength": 1, "title": "Body Text" } }, "type": "object", "required": [ "body", "body_text" ], "title": "UpdateCommentRequest" }, "UpdateDocRequest": { "properties": { "title": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ], "title": "Title" }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content" } }, "type": "object", "title": "UpdateDocRequest" }, "UpdateMemberRoleRequest": { "properties": { "role": { "type": "string", "enum": [ "owner", "editor", "viewer" ], "title": "Role" } }, "type": "object", "required": [ "role" ], "title": "UpdateMemberRoleRequest" }, "UpdateScheduleRequest": { "properties": { "cron": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ], "title": "Cron" }, "timezone": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "Timezone" }, "inputs": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Inputs" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" } }, "type": "object", "title": "UpdateScheduleRequest" }, "UpdateSessionRequest": { "properties": { "title": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ], "title": "Title" }, "model_id": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ], "title": "Model Id" } }, "type": "object", "title": "UpdateSessionRequest" }, "UpdateWorkflowRequest": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 120 }, { "type": "null" } ], "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "emoji": { "anyOf": [ { "type": "string", "maxLength": 8 }, { "type": "null" } ], "title": "Emoji" }, "category": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ], "title": "Category" }, "visibility": { "anyOf": [ { "type": "string", "maxLength": 16 }, { "type": "null" } ], "title": "Visibility" }, "status": { "anyOf": [ { "type": "string", "maxLength": 16 }, { "type": "null" } ], "title": "Status" }, "graph": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Graph" }, "inputs_schema": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Inputs Schema" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "pinned": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Pinned" }, "change_note": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Change Note" } }, "type": "object", "title": "UpdateWorkflowRequest" }, "UpdateWorkspaceRequest": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ], "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active" } }, "type": "object", "title": "UpdateWorkspaceRequest" }, "UsageOut": { "properties": { "total_files": { "type": "integer", "title": "Total Files" }, "total_bytes": { "type": "integer", "title": "Total Bytes" }, "connector_count": { "type": "integer", "title": "Connector Count" } }, "type": "object", "required": [ "total_files", "total_bytes", "connector_count" ], "title": "UsageOut" }, "UsageResponse": { "properties": { "quick_used": { "type": "integer", "title": "Quick Used" }, "quick_limit": { "type": "integer", "title": "Quick Limit" }, "standard_used": { "type": "integer", "title": "Standard Used" }, "standard_limit": { "type": "integer", "title": "Standard Limit" }, "deep_used": { "type": "integer", "title": "Deep Used" }, "deep_limit": { "type": "integer", "title": "Deep Limit" } }, "type": "object", "required": [ "quick_used", "quick_limit", "standard_used", "standard_limit", "deep_used", "deep_limit" ], "title": "UsageResponse" }, "UserPatchRequest": { "properties": { "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Full Name" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Locale" }, "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role" }, "must_change_password": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Must Change Password" } }, "type": "object", "title": "UserPatchRequest" }, "UserResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "email": { "type": "string", "title": "Email" }, "is_active": { "type": "boolean", "title": "Is Active" }, "is_verified": { "type": "boolean", "title": "Is Verified" }, "has_totp": { "type": "boolean", "title": "Has Totp" }, "company_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Company Id" }, "is_superadmin": { "type": "boolean", "title": "Is Superadmin", "default": false }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Full Name" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "company": { "anyOf": [ { "$ref": "#/components/schemas/CompanyInfo" }, { "type": "null" } ] } }, "type": "object", "required": [ "id", "email", "is_active", "is_verified", "has_totp", "company_id", "created_at" ], "title": "UserResponse" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "VoiceItem": { "properties": { "voice_id": { "type": "string", "title": "Voice Id" }, "name": { "type": "string", "title": "Name" }, "category": { "type": "string", "title": "Category" }, "preview_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Preview Url" } }, "type": "object", "required": [ "voice_id", "name", "category", "preview_url" ], "title": "VoiceItem" }, "WorkflowAnalyticsResponse": { "properties": { "total_runs": { "type": "integer", "title": "Total Runs" }, "success_runs": { "type": "integer", "title": "Success Runs" }, "failed_runs": { "type": "integer", "title": "Failed Runs" }, "avg_duration_ms": { "type": "number", "title": "Avg Duration Ms" }, "total_tokens": { "type": "integer", "title": "Total Tokens" }, "total_cost_eur": { "type": "number", "title": "Total Cost Eur" }, "daily_runs": { "items": { "$ref": "#/components/schemas/DailyRunStat" }, "type": "array", "title": "Daily Runs" } }, "type": "object", "required": [ "total_runs", "success_runs", "failed_runs", "avg_duration_ms", "total_tokens", "total_cost_eur", "daily_runs" ], "title": "WorkflowAnalyticsResponse" }, "WorkflowGrantResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "workflow_id": { "type": "string", "format": "uuid", "title": "Workflow Id" }, "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, "role": { "type": "string", "title": "Role" }, "invited_by": { "type": "string", "format": "uuid", "title": "Invited By" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "workflow_id", "user_id", "role", "invited_by", "created_at" ], "title": "WorkflowGrantResponse" }, "WorkflowListItem": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "company_id": { "type": "string", "format": "uuid", "title": "Company Id" }, "owner_id": { "type": "string", "format": "uuid", "title": "Owner Id" }, "name": { "type": "string", "title": "Name" }, "slug": { "type": "string", "title": "Slug" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "emoji": { "type": "string", "title": "Emoji" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" }, "visibility": { "type": "string", "title": "Visibility" }, "status": { "type": "string", "title": "Status" }, "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags" }, "pinned": { "type": "boolean", "title": "Pinned" }, "total_runs": { "type": "integer", "title": "Total Runs" }, "last_run_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Run At" }, "last_run_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Run Status" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" } }, "type": "object", "required": [ "id", "company_id", "owner_id", "name", "slug", "description", "emoji", "category", "visibility", "status", "tags", "pinned", "total_runs", "last_run_at", "last_run_status", "created_at", "updated_at" ], "title": "WorkflowListItem" }, "WorkflowListResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/WorkflowListItem" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "per_page": { "type": "integer", "title": "Per Page" } }, "type": "object", "required": [ "items", "total", "page", "per_page" ], "title": "WorkflowListResponse" }, "WorkflowResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "company_id": { "type": "string", "format": "uuid", "title": "Company Id" }, "owner_id": { "type": "string", "format": "uuid", "title": "Owner Id" }, "name": { "type": "string", "title": "Name" }, "slug": { "type": "string", "title": "Slug" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "emoji": { "type": "string", "title": "Emoji" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" }, "visibility": { "type": "string", "title": "Visibility" }, "status": { "type": "string", "title": "Status" }, "graph": { "additionalProperties": true, "type": "object", "title": "Graph" }, "inputs_schema": { "items": {}, "type": "array", "title": "Inputs Schema" }, "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags" }, "pinned": { "type": "boolean", "title": "Pinned" }, "total_runs": { "type": "integer", "title": "Total Runs" }, "last_run_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Run At" }, "last_run_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Run Status" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "deleted_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Deleted At" } }, "type": "object", "required": [ "id", "company_id", "owner_id", "name", "slug", "description", "emoji", "category", "visibility", "status", "graph", "inputs_schema", "tags", "pinned", "total_runs", "last_run_at", "last_run_status", "created_at", "updated_at", "deleted_at" ], "title": "WorkflowResponse" }, "WorkflowRunListResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/WorkflowRunResponse" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "per_page": { "type": "integer", "title": "Per Page" } }, "type": "object", "required": [ "items", "total", "page", "per_page" ], "title": "WorkflowRunListResponse" }, "WorkflowRunResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "workflow_id": { "type": "string", "format": "uuid", "title": "Workflow Id" }, "workflow_version_no": { "type": "integer", "title": "Workflow Version No" }, "triggered_by": { "type": "string", "format": "uuid", "title": "Triggered By" }, "trigger_kind": { "type": "string", "title": "Trigger Kind" }, "status": { "type": "string", "title": "Status" }, "inputs": { "additionalProperties": true, "type": "object", "title": "Inputs" }, "outputs": { "additionalProperties": true, "type": "object", "title": "Outputs" }, "context": { "additionalProperties": true, "type": "object", "title": "Context" }, "total_tokens": { "type": "integer", "title": "Total Tokens" }, "total_cost_eur": { "type": "number", "title": "Total Cost Eur" }, "duration_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Duration Ms" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "arq_job_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Arq Job Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "started_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Started At" }, "ended_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Ended At" }, "cancelled_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Cancelled At" } }, "type": "object", "required": [ "id", "workflow_id", "workflow_version_no", "triggered_by", "trigger_kind", "status", "inputs", "outputs", "context", "total_tokens", "total_cost_eur", "duration_ms", "error", "arq_job_id", "created_at", "started_at", "ended_at", "cancelled_at" ], "title": "WorkflowRunResponse" }, "WorkflowRunStepResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "run_id": { "type": "string", "format": "uuid", "title": "Run Id" }, "step_id": { "type": "string", "title": "Step Id" }, "step_type": { "type": "string", "title": "Step Type" }, "step_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Step Label" }, "status": { "type": "string", "title": "Status" }, "input": { "additionalProperties": true, "type": "object", "title": "Input" }, "output": { "additionalProperties": true, "type": "object", "title": "Output" }, "tokens": { "type": "integer", "title": "Tokens" }, "cost_eur": { "type": "number", "title": "Cost Eur" }, "duration_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Duration Ms" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "attempt": { "type": "integer", "title": "Attempt" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "started_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Started At" }, "ended_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Ended At" } }, "type": "object", "required": [ "id", "run_id", "step_id", "step_type", "step_label", "status", "input", "output", "tokens", "cost_eur", "duration_ms", "error", "attempt", "created_at", "started_at", "ended_at" ], "title": "WorkflowRunStepResponse" }, "WorkflowScheduleResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "workflow_id": { "type": "string", "format": "uuid", "title": "Workflow Id" }, "cron": { "type": "string", "title": "Cron" }, "timezone": { "type": "string", "title": "Timezone" }, "inputs": { "additionalProperties": true, "type": "object", "title": "Inputs" }, "enabled": { "type": "boolean", "title": "Enabled" }, "created_by": { "type": "string", "format": "uuid", "title": "Created By" }, "next_run_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Next Run At" }, "last_run_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Run At" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "workflow_id", "cron", "timezone", "inputs", "enabled", "created_by", "next_run_at", "last_run_at", "created_at" ], "title": "WorkflowScheduleResponse" }, "WorkflowTemplateResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "slug": { "type": "string", "title": "Slug" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "emoji": { "type": "string", "title": "Emoji" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" }, "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags" }, "graph": { "additionalProperties": true, "type": "object", "title": "Graph" }, "inputs_schema": { "items": {}, "type": "array", "title": "Inputs Schema" } }, "type": "object", "required": [ "id", "slug", "name", "description", "emoji", "category", "tags", "graph", "inputs_schema" ], "title": "WorkflowTemplateResponse" }, "WorkflowVersionResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "workflow_id": { "type": "string", "format": "uuid", "title": "Workflow Id" }, "version_no": { "type": "integer", "title": "Version No" }, "graph": { "additionalProperties": true, "type": "object", "title": "Graph" }, "inputs_schema": { "items": {}, "type": "array", "title": "Inputs Schema" }, "changed_by": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Changed By" }, "change_note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Change Note" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "workflow_id", "version_no", "graph", "inputs_schema", "changed_by", "change_note", "created_at" ], "title": "WorkflowVersionResponse" }, "WorkspaceActivityItem": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "workspace_id": { "type": "string", "format": "uuid", "title": "Workspace Id" }, "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, "action": { "type": "string", "title": "Action" }, "target_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Type" }, "target_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Target Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "workspace_id", "user_id", "action", "target_type", "target_id", "created_at" ], "title": "WorkspaceActivityItem" }, "WorkspaceActivityListResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/WorkspaceActivityItem" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "per_page": { "type": "integer", "title": "Per Page" } }, "type": "object", "required": [ "items", "total", "page", "per_page" ], "title": "WorkspaceActivityListResponse" }, "WorkspaceDocListResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/WorkspaceDocResponse" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "per_page": { "type": "integer", "title": "Per Page" } }, "type": "object", "required": [ "items", "total", "page", "per_page" ], "title": "WorkspaceDocListResponse" }, "WorkspaceDocResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "workspace_id": { "type": "string", "format": "uuid", "title": "Workspace Id" }, "title": { "type": "string", "title": "Title" }, "content": { "type": "string", "title": "Content" }, "created_by": { "type": "string", "format": "uuid", "title": "Created By" }, "updated_by": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Updated By" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "required": [ "id", "workspace_id", "title", "content", "created_by", "updated_by", "created_at", "updated_at" ], "title": "WorkspaceDocResponse" }, "WorkspaceListResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/WorkspaceResponse" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "per_page": { "type": "integer", "title": "Per Page" } }, "type": "object", "required": [ "items", "total", "page", "per_page" ], "title": "WorkspaceListResponse" }, "WorkspaceMemberListResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/WorkspaceMemberResponse" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "per_page": { "type": "integer", "title": "Per Page" } }, "type": "object", "required": [ "items", "total", "page", "per_page" ], "title": "WorkspaceMemberListResponse" }, "WorkspaceMemberResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "workspace_id": { "type": "string", "format": "uuid", "title": "Workspace Id" }, "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, "role": { "type": "string", "title": "Role" }, "added_by": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Added By" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "workspace_id", "user_id", "role", "added_by", "created_at" ], "title": "WorkspaceMemberResponse" }, "WorkspaceMemoryItemResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "workspace_id": { "type": "string", "format": "uuid", "title": "Workspace Id" }, "content": { "type": "string", "title": "Content" }, "created_by": { "type": "string", "format": "uuid", "title": "Created By" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "workspace_id", "content", "created_by", "created_at" ], "title": "WorkspaceMemoryItemResponse" }, "WorkspaceMemoryListResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/WorkspaceMemoryItemResponse" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "per_page": { "type": "integer", "title": "Per Page" } }, "type": "object", "required": [ "items", "total", "page", "per_page" ], "title": "WorkspaceMemoryListResponse" }, "WorkspacePromptListResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/WorkspacePromptResponse" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "per_page": { "type": "integer", "title": "Per Page" } }, "type": "object", "required": [ "items", "total", "page", "per_page" ], "title": "WorkspacePromptListResponse" }, "WorkspacePromptResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "workspace_id": { "type": "string", "format": "uuid", "title": "Workspace Id" }, "title": { "type": "string", "title": "Title" }, "content": { "type": "string", "title": "Content" }, "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags" }, "created_by": { "type": "string", "format": "uuid", "title": "Created By" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "required": [ "id", "workspace_id", "title", "content", "tags", "created_by", "created_at", "updated_at" ], "title": "WorkspacePromptResponse" }, "WorkspaceResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "company_id": { "type": "string", "format": "uuid", "title": "Company Id" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "created_by": { "type": "string", "format": "uuid", "title": "Created By" }, "is_active": { "type": "boolean", "title": "Is Active" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "required": [ "id", "company_id", "name", "description", "created_by", "is_active", "created_at", "updated_at" ], "title": "WorkspaceResponse" }, "app__modules__admin__api_keys__ApiKeyCreateRequest": { "properties": { "name": { "type": "string", "title": "Name" }, "scopes": { "items": { "type": "string" }, "type": "array", "title": "Scopes", "default": [] } }, "type": "object", "required": [ "name" ], "title": "ApiKeyCreateRequest" }, "app__modules__admin__billing__TopupRequest": { "properties": { "amount_eur": { "type": "number", "title": "Amount Eur" } }, "type": "object", "required": [ "amount_eur" ], "title": "TopupRequest" }, "app__modules__agents__schemas__AddMemoryRequest": { "properties": { "key": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Key" }, "value": { "type": "string", "minLength": 1, "title": "Value" } }, "type": "object", "required": [ "key", "value" ], "title": "AddMemoryRequest" }, "app__modules__agents__schemas__CreateGrantRequest": { "properties": { "grantee_type": { "type": "string", "enum": [ "user", "company", "everyone" ], "title": "Grantee Type" }, "grantee_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Grantee Id" }, "permission": { "type": "string", "enum": [ "view", "use", "edit" ], "title": "Permission", "default": "use" } }, "type": "object", "required": [ "grantee_type" ], "title": "CreateGrantRequest" }, "app__modules__agents__schemas__SendMessageRequest": { "properties": { "content": { "type": "string", "maxLength": 100000, "minLength": 1, "title": "Content" } }, "type": "object", "required": [ "content" ], "title": "SendMessageRequest" }, "app__modules__billing__schemas__TopupRequest": { "properties": { "package_id": { "type": "string", "title": "Package Id" }, "success_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Success Url" }, "cancel_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cancel Url" } }, "type": "object", "required": [ "package_id" ], "title": "TopupRequest" }, "app__modules__bulk__schemas__ShareRequest": { "properties": { "user_email": { "type": "string", "title": "User Email" }, "role": { "type": "string", "enum": [ "viewer", "runner", "editor" ], "title": "Role", "default": "viewer" } }, "type": "object", "required": [ "user_email" ], "title": "ShareRequest" }, "app__modules__chat__schemas__SendMessageRequest": { "properties": { "content": { "type": "string", "maxLength": 100000, "minLength": 1, "title": "Content" }, "model_id": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ], "title": "Model Id" }, "document_ids": { "anyOf": [ { "items": { "type": "string", "format": "uuid" }, "type": "array" }, { "type": "null" } ], "title": "Document Ids" }, "web_search": { "type": "boolean", "title": "Web Search", "default": false }, "code_exec": { "type": "boolean", "title": "Code Exec", "default": false } }, "type": "object", "required": [ "content" ], "title": "SendMessageRequest" }, "app__modules__research__schemas__ShareRequest": { "properties": { "user_email": { "type": "string", "title": "User Email" }, "role": { "type": "string", "const": "viewer", "title": "Role", "default": "viewer" } }, "type": "object", "required": [ "user_email" ], "title": "ShareRequest" }, "app__modules__tenancy__schemas__ApiKeyCreateRequest": { "properties": { "name": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Name" }, "scopes": { "items": { "type": "string" }, "type": "array", "title": "Scopes" }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Expires At" } }, "type": "object", "required": [ "name" ], "title": "ApiKeyCreateRequest" }, "app__modules__tenancy__schemas__MemberResponse": { "properties": { "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, "email": { "type": "string", "title": "Email" }, "role": { "type": "string", "title": "Role" }, "joined_at": { "type": "string", "format": "date-time", "title": "Joined At" } }, "type": "object", "required": [ "user_id", "email", "role", "joined_at" ], "title": "MemberResponse" }, "app__modules__workflows__schemas__CreateGrantRequest": { "properties": { "user_email": { "type": "string", "maxLength": 254, "minLength": 1, "title": "User Email" }, "role": { "type": "string", "maxLength": 16, "title": "Role", "default": "viewer" } }, "type": "object", "required": [ "user_email" ], "title": "CreateGrantRequest" }, "app__modules__workspace__schemas__AddMemoryRequest": { "properties": { "content": { "type": "string", "maxLength": 10000, "minLength": 1, "title": "Content" } }, "type": "object", "required": [ "content" ], "title": "AddMemoryRequest" }, "app__modules__workspace_collab__router__MemberResponse": { "properties": { "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, "role": { "type": "string", "title": "Role" }, "joined_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Joined At" } }, "type": "object", "required": [ "user_id", "role" ], "title": "MemberResponse" }, "ProblemDetail": { "type": "object", "description": "RFC 9457 Problem Details for HTTP APIs.", "properties": { "type": { "type": "string", "format": "uri", "description": "URI identifying the problem type.", "example": "https://api.hubrix.ai/errors/insufficient_credits" }, "title": { "type": "string", "description": "Short human-readable summary.", "example": "Insufficient credits" }, "status": { "type": "integer", "description": "HTTP status code.", "example": 402 }, "detail": { "type": "string", "description": "Detailed explanation specific to this occurrence.", "example": "This action requires 40 credits; current balance is 13." }, "instance": { "type": "string", "description": "URI of the request that triggered this problem.", "example": "/v1/research" }, "request_id": { "type": "string", "description": "Unique request identifier for support enquiries.", "example": "req_01HZ3K9ABCDEF" } }, "required": [ "type", "title", "status" ] } }, "securitySchemes": { "HTTPBearer": { "type": "http", "scheme": "bearer" } }, "responses": { "Unauthorized": { "description": "Missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" }, "example": { "type": "https://api.hubrix.ai/errors/session_expired", "title": "Session expired", "status": 401, "detail": "Your session has expired. Re-authenticate to continue.", "instance": "/v1/me/profile" } } } }, "Forbidden": { "description": "Authenticated but not authorised for this resource.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" }, "example": { "type": "https://api.hubrix.ai/errors/forbidden", "title": "Forbidden", "status": 403, "detail": "You do not have access to this resource.", "instance": "/v1/admin/overview" } } } }, "NotFound": { "description": "Resource not found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" }, "example": { "type": "https://api.hubrix.ai/errors/not_found", "title": "Not found", "status": 404, "detail": "The requested resource does not exist.", "instance": "/v1/workflows/00000000-0000-0000-0000-000000000000" } } } }, "InsufficientCredits": { "description": "Insufficient credits for this operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" }, "example": { "type": "https://api.hubrix.ai/errors/insufficient_credits", "title": "Insufficient credits", "status": 402, "detail": "This action requires 40 credits; current balance is 13.", "instance": "/v1/research" } } } }, "RateLimited": { "description": "Too many requests. Retry after X-RateLimit-Reset.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" }, "example": { "type": "https://api.hubrix.ai/errors/rate_limited", "title": "Rate limited", "status": 429, "detail": "Too many requests. Retry after 1746373800.", "instance": "/v1/auth/login" } } } }, "UnprocessableEntity": { "description": "Request body validation failed.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" }, "example": { "type": "https://api.hubrix.ai/errors/validation_error", "title": "Validation error", "status": 422, "detail": "email: value is not a valid email address", "instance": "/v1/auth/register" } } } } } }, "tags": [ { "name": "Authentication", "description": "Register, log in, refresh sessions, reset passwords, configure TOTP MFA, and initiate Google/Microsoft SSO. All endpoints in this group are **public** (no Bearer token required) unless otherwise noted. Tokens expire after 15 minutes; use `POST /auth/refresh` to rotate. See the [Authentication guide](https://api.hubrix.ai/authentication)." }, { "name": "Users & Profile", "description": "Read and update the authenticated user's own profile, avatar, locale, notification preferences, and MFA settings. All endpoints operate on the currently authenticated user — you cannot access another user's profile via these routes. Admin-scoped user management lives under the Admin tag." }, { "name": "Workspace & Tenancy", "description": "Manage companies, team memberships, and invitations. An **invitation** is a one-time token e-mailed to a new team member. Accepting it creates their account and a `membership` row linking them to the company. API keys (format `hbx_…`) are also managed here." }, { "name": "Smart Chat", "description": "Multi-model streaming chat with optional web search and document retrieval (RAG). Chat is the highest-throughput surface on the API. Responses stream as Server-Sent Events: each `data:` event carries a partial token chunk; a final `data: [DONE]` signals the end of the stream. Session context is persisted in `chat_sessions` and `chat_messages`. **Credit cost:** 1 credit per message (varies by model tier). See [04. AI Pipeline](https://docs.hubrix.ai/engineering/architecture/04-ai-pipeline)." }, { "name": "Translate Studio", "description": "Document translation with glossary support. Accepts text or uploaded documents (PDF, DOCX, TXT). Translations are performed by an LLM with a system prompt that enforces terminology from the active glossary. **Credit cost:** 5 credits per 1,000 words translated." }, { "name": "Documents", "description": "Upload, list, search, and delete documents in the company knowledge base. Uploaded files are chunked into 512-token segments with 50-token overlap, embedded via `text-embedding-3-small`, and stored in pgvector. The `GET /documents/search` endpoint performs cosine-similarity retrieval and is the programmatic entry point for RAG. **Max file size:** 50 MB. Supported formats: PDF, DOCX, CSV, TXT, PPTX. See [04. AI Pipeline](https://docs.hubrix.ai/engineering/architecture/04-ai-pipeline)." }, { "name": "Custom Agents", "description": "Build, version, share, and invoke AI agents. An agent has a system prompt, an optional knowledge base (RAG), and access to configurable tools (web search, code execution). Each published agent gets a stable `agent_id` that integrators can call via `POST /agents/{id}/run`. Versioning is immutable: each edit creates a new `agent_version`. **Credit cost:** varies by model and tool use." }, { "name": "Workflows", "description": "Visual workflow automation. A workflow is a DAG of up to 50 nodes with 10 step types: `llm`, `condition`, `transform`, `web_search`, `rag_query`, `http_request`, `agent_call`, `email_send`, `delay`, `set_variable`. Workflows run in the ARQ background worker; results are polled via `GET /workflows/runs/{run_id}`. Scheduled workflows use cron expressions. **Credit cost:** per LLM step; web_search = 2 credits. See [04. AI Pipeline](https://docs.hubrix.ai/engineering/architecture/04-ai-pipeline)." }, { "name": "Deep Research", "description": "Multi-source deep research pipeline: web search (Serper) → URL fetch → relevance ranking → Anthropic synthesis. Returns a structured markdown report with citations. Standard depth uses 1 search pass (≤60 s); Deep uses 2 passes with angle variants (≤180 s). Progress streams via SSE. **Credit cost:** 40 credits (standard) · 120 credits (deep). See [04. AI Pipeline](https://docs.hubrix.ai/engineering/architecture/04-ai-pipeline)." }, { "name": "Bulk Processing", "description": "Process CSV rows at scale with LLM operations: translate, classify, extract, summarise, transform, sentiment analysis. Upload a CSV → define the operation → poll for progress → download results. Uses `asyncio.Semaphore(10)` for concurrency control. Rows that fail are marked individually; the job continues. **Credit cost:** per-row, depends on operation and model." }, { "name": "Team Workspace", "description": "Collaborative workspace: shared items, comments, @mentions, real-time notifications, and activity feeds. Workspace items are typed containers (research, chat, workflow) that can be shared with team members. Comments support @mentions which trigger email notifications." }, { "name": "Data Connectors", "description": "Connect Google Drive and OneDrive to automatically synchronise files into the Hubrix knowledge base. OAuth uses incremental scopes separate from SSO. Sync is periodic (configurable, default 60 min) using the provider's incremental change API. Files are Fernet-encrypted at rest. See [06. Connectors & Sync](https://docs.hubrix.ai/engineering/architecture/06-connectors-and-sync)." }, { "name": "Dashboard", "description": "Aggregated metrics endpoint for the main dashboard view. Returns usage stats, recent activity, credit balance, and quick-access items in a single request to minimise round-trips on app load." }, { "name": "Billing", "description": "Manage plans, credits, top-ups, and invoices. Plan changes go through Stripe Checkout; credit top-ups are available à-la-carte. The credit ledger uses `SELECT FOR UPDATE` to prevent double-spending under concurrent requests. Stripe webhooks (received at `/billing/webhook`) drive subscription state. See [03. Credits & Billing](https://docs.hubrix.ai/engineering/architecture/03-credits-and-billing)." }, { "name": "Admin", "description": "Platform-level administration. Requires `is_superadmin=true`. Endpoints cover user lifecycle management, company oversight, audit log access, credit grants, plan overrides, connector health, and system health. **Not intended for integrators.** Internal use only.", "x-internal": true }, { "name": "Health", "description": "Liveness and readiness checks. Public. Used by load balancers and uptime monitors." }, { "name": "Models", "description": "List available AI models with display names and provider information. Used to populate model-selector UIs. Public endpoint." } ] }