{ "openapi": "3.1.0", "info": { "title": "Onyx API", "description": "Onyx API for AI-powered enterprise search and chat", "version": "Development" }, "servers": [ { "url": "https://cloud.onyx.app/api" } ], "paths": { "/chat/get-user-chat-sessions": { "get": { "tags": ["public"], "summary": "Get User Chat Sessions", "operationId": "get_user_chat_sessions", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Project Id" } }, { "name": "only_non_project_chats", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Only Non Project Chats" } }, { "name": "include_failed_chats", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Failed Chats" } }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Page Size" } }, { "name": "before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Before" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatSessionsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/chat/get-chat-session/{session_id}": { "get": { "tags": ["public"], "summary": "Get Chat Session", "operationId": "get_chat_session", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Session Id" } }, { "name": "is_shared", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Is Shared" } }, { "name": "include_deleted", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Deleted" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatSessionDetailResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/chat/create-chat-session": { "post": { "tags": ["public"], "summary": "Create New Chat Session", "operationId": "create_new_chat_session", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatSessionCreationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateChatSessionID" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/chat/delete-all-chat-sessions": { "delete": { "tags": ["public"], "summary": "Delete All Chat Sessions", "operationId": "delete_all_chat_sessions", "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/chat/delete-chat-session/{session_id}": { "delete": { "tags": ["public"], "summary": "Delete Chat Session By Id", "operationId": "delete_chat_session_by_id", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Session Id" } }, { "name": "hard_delete", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Hard Delete" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/chat/end-incognito-session/{session_id}": { "post": { "tags": ["public"], "summary": "End Incognito Session", "description": "Drop an incognito session's live context the moment the chat closes.\n\nThe context TTL is only the backstop for when this never arrives, such as\na hard tab close. Uploads are found by session id, so one still in flight\nwhen the user leaves, or one attached before any message created the\nsession, is queued for deletion just the same.", "operationId": "end_incognito_session", "security": [ { "BearerAuth": [] } ], "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": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/chat/send-chat-message": { "post": { "tags": ["public"], "summary": "Handle Send Chat Message", "description": "This endpoint is used to send a new chat message.\n\nArgs:\n chat_message_req (SendMessageRequest): Details about the new chat message.\n - When stream=True (default): Returns StreamingResponse with SSE\n - When stream=False: Returns ChatFullResponse with complete data\n request (Request): The current HTTP request context.\n user (User): The current user, obtained via dependency injection.\n _ (None): Rate limit check is run if user/group/global rate limits are enabled.\n\nReturns:\n StreamingResponse | ChatFullResponse: Either streams or returns complete response.", "operationId": "handle_send_chat_message", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendMessageRequest" } } } }, "responses": { "200": { "description": "If `stream=true`, returns `text/event-stream`.\nIf `stream=false`, returns `application/json` (ChatFullResponse).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatFullResponse" } }, "text/event-stream": { "schema": { "type": "string" }, "examples": { "stream": { "summary": "Stream of NDJSON AnswerStreamPart's", "value": "string" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/chat/file/{file_id}": { "get": { "tags": ["public"], "summary": "Fetch Chat File", "operationId": "fetch_chat_file", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "file_id", "in": "path", "required": true, "schema": { "type": "string", "title": "File Id" } }, { "name": "parsed", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Parsed" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/chat/search": { "get": { "tags": ["public"], "summary": "Search Chats", "description": "Search for chat sessions based on the provided query.\nIf no query is provided, returns recent chat sessions.", "operationId": "search_chats", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "query", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Query" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "default": 10, "title": "Page Size" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatSearchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/chat/stop-chat-session/{chat_session_id}": { "post": { "tags": ["public"], "summary": "Stop Chat Session", "description": "Stop the requested execution without affecting a later request.", "operationId": "stop_chat_session", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "chat_session_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Chat Session Id" } }, { "name": "stream_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Stream Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StopChatResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/users/admin-access": { "patch": { "tags": ["public"], "summary": "Set User Admin Access Endpoint", "operationId": "set_user_admin_access_endpoint", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserAdminAccessUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/users/accepted": { "get": { "tags": ["public"], "summary": "List Accepted Users", "operationId": "list_accepted_users", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "name": "page_num", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Page Num" } }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 10, "title": "Page Size" } }, { "name": "is_active", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active" } }, { "name": "account_types", "in": "query", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccountType" }, "default": [], "title": "Account Types" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedReturn_FullUserSnapshot_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/users/accepted/all": { "get": { "tags": ["public"], "summary": "List All Accepted Users", "description": "Returns all accepted users without pagination.\nUsed by the admin Users page for client-side filtering/sorting.", "operationId": "list_all_accepted_users", "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FullUserSnapshot" }, "title": "Response List All Accepted Users Manage Users Accepted All Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/users/invited": { "get": { "tags": ["public"], "summary": "List Invited Users", "operationId": "list_invited_users", "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvitedUserSnapshot" }, "title": "Response List Invited Users Manage Users Invited Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/users": { "get": { "tags": ["public"], "summary": "List All Users", "operationId": "list_all_users", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "name": "accepted_page", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Accepted Page" } }, { "name": "slack_users_page", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Slack Users Page" } }, { "name": "invited_page", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Invited Page" } }, { "name": "include_api_keys", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Api Keys" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllUsersResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/users": { "put": { "tags": ["public"], "summary": "Bulk Invite Users", "description": "emails are string validated. If any email fails validation, no emails are\ninvited and an exception is raised.", "operationId": "bulk_invite_users", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_bulk_invite_users_manage_admin_users_put" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkInviteResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/remove-invited-user": { "patch": { "tags": ["public"], "summary": "Remove Invited User", "operationId": "remove_invited_user", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserByEmail" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "integer", "title": "Response Remove Invited User Manage Admin Remove Invited User Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/deactivate-user": { "patch": { "tags": ["public"], "summary": "Deactivate User Api", "operationId": "deactivate_user_api", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserByEmail" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/delete-user": { "delete": { "tags": ["public"], "summary": "Delete User", "operationId": "delete_user", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserByEmail" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/activate-user": { "patch": { "tags": ["public"], "summary": "Activate User Api", "operationId": "activate_user_api", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserByEmail" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users": { "get": { "tags": ["public"], "summary": "List All Users Basic Info", "operationId": "list_all_users_basic_info", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "include_api_keys", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Api Keys" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MinimalUserSnapshot" }, "title": "Response List All Users Basic Info Users Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/me/permissions": { "get": { "tags": ["public"], "summary": "Get Current User Permissions", "operationId": "get_current_user_permissions", "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPermissionsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/me": { "get": { "tags": ["public"], "summary": "Verify User Logged In", "operationId": "verify_user_logged_in", "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserInfo" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/deletion-attempt": { "post": { "tags": ["public"], "summary": "Create Deletion Attempt For Connector Id", "operationId": "create_deletion_attempt_for_connector_id", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorCredentialPairIdentifier" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/connector/file/upload": { "post": { "tags": ["public"], "summary": "Upload Files Api", "operationId": "upload_files_api", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "unzip", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Unzip" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_files_api_manage_admin_connector_file_upload_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/connector/{connector_id}/files": { "get": { "tags": ["public"], "summary": "List Connector Files", "description": "One page of a file connector's files, in config order.\n\n``total_items`` always counts every file. Without ``page_size`` the\nresponse holds all of them, which is what callers of the unpaginated\nendpoint still expect; a zip of thousands of files needs a page size.", "operationId": "list_connector_files", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Connector Id" } }, { "name": "page_num", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Page Num" } }, { "name": "page_size", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 200, "minimum": 1 }, { "type": "null" } ], "title": "Page Size" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorFilesResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/connector/{connector_id}/files/update": { "post": { "tags": ["public"], "summary": "Update Connector Files", "description": "Update files in a connector by adding new files and/or removing existing ones.\nThis is an atomic operation that validates, updates the connector config, and triggers indexing.", "operationId": "update_connector_files", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Connector Id" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_update_connector_files_manage_admin_connector__connector_id__files_update_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/connector": { "get": { "tags": ["public"], "summary": "Get Connectors By Credential", "description": "Get a list of connectors. Allow filtering by a specific credential id.", "operationId": "get_connectors_by_credential", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "credential", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Credential" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectorSnapshot" }, "title": "Response Get Connectors By Credential Manage Admin Connector Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": ["public"], "summary": "Create Connector From Model", "operationId": "create_connector_from_model", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectCreationIdResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/connector/failed-indexing-status": { "get": { "tags": ["public"], "summary": "Get Currently Failed Indexing Status", "operationId": "get_currently_failed_indexing_status", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "secondary_index", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Secondary Index" } }, { "name": "get_editable", "in": "query", "required": false, "schema": { "type": "boolean", "description": "If true, return editable document sets", "default": false, "title": "Get Editable" }, "description": "If true, return editable document sets" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FailedConnectorIndexingStatus" }, "title": "Response Get Currently Failed Indexing Status Manage Admin Connector Failed Indexing Status Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/connector/status": { "get": { "tags": ["public"], "summary": "Get Connector Status", "operationId": "get_connector_status", "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectorStatus" }, "title": "Response Get Connector Status Manage Admin Connector Status Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/connector/indexing-status": { "post": { "tags": ["public"], "summary": "Get Connector Indexing Status", "operationId": "get_connector_indexing_status", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexingStatusRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectorIndexingStatusLiteResponse" }, "title": "Response Get Connector Indexing Status Manage Admin Connector Indexing Status Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/connector/{connector_id}": { "patch": { "tags": ["public"], "summary": "Update Connector From Model", "operationId": "update_connector_from_model", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Connector Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ConnectorSnapshot" }, { "$ref": "#/components/schemas/StatusResponse_int_" } ], "title": "Response Update Connector From Model Manage Admin Connector Connector Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": ["public"], "summary": "Delete Connector By Id", "operationId": "delete_connector_by_id", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Connector Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusResponse_int_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/connector/run-once": { "post": { "tags": ["public"], "summary": "Connector Run Once", "description": "Used to trigger indexing on a set of cc_pairs associated with a\nsingle connector.", "operationId": "connector_run_once", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunConnectorRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusResponse_int_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/connector": { "get": { "tags": ["public"], "summary": "Get Connectors", "operationId": "get_connectors", "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectorSnapshot" }, "title": "Response Get Connectors Manage Connector Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/indexed-sources": { "get": { "tags": ["public"], "summary": "Get Indexed Sources", "operationId": "get_indexed_sources", "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexedSourcesResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/connector/{connector_id}": { "get": { "tags": ["public"], "summary": "Get Connector By Id", "operationId": "get_connector_by_id", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Connector Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ConnectorSnapshot" }, { "$ref": "#/components/schemas/StatusResponse_int_" } ], "title": "Response Get Connector By Id Manage Connector Connector Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/connector-status": { "get": { "tags": ["public"], "summary": "Get Basic Connector Indexing Status", "operationId": "get_basic_connector_indexing_status", "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BasicCCPairInfo" }, "title": "Response Get Basic Connector Indexing Status Manage Connector Status Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/credential": { "get": { "tags": ["public"], "summary": "List Credentials Admin", "description": "Lists all public credentials", "operationId": "list_credentials_admin", "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CredentialSnapshot" }, "title": "Response List Credentials Admin Manage Admin Credential Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/similar-credentials/{source_type}": { "get": { "tags": ["public"], "summary": "Get Cc Source Full Info", "description": "The credentials a ``source_type`` connector can use, shown in that\nsource's keys. Each lists the connectors using it that the user can manage,\nwith their credential-bound config values, and says whether the user may\nuse it, to help pick one.", "operationId": "get_cc_source_full_info", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "source_type", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/DocumentSource" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SimilarCredentialSnapshot" }, "title": "Response Get Cc Source Full Info Manage Admin Similar Credentials Source Type Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/credential/{credential_id}": { "delete": { "tags": ["public"], "summary": "Delete Credential By Id Admin", "description": "Same as the user endpoint: only the owner may delete a credential.", "operationId": "delete_credential_by_id_admin", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "credential_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Credential Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": ["public"], "summary": "Update Credential Data", "operationId": "update_credential_data", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "credential_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Credential Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialDataUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialBase" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/credential/swap": { "put": { "tags": ["public"], "summary": "Swap Credentials For Connector", "operationId": "swap_credentials_for_connector", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialSwapRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/credential": { "post": { "tags": ["public"], "summary": "Create Credential From Model", "operationId": "create_credential_from_model", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialBase" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectCreationIdResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": ["public"], "summary": "List Credentials", "operationId": "list_credentials", "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CredentialSnapshot" }, "title": "Response List Credentials Manage Credential Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/credential/private-key": { "post": { "tags": ["public"], "summary": "Create Credential With Private Key", "operationId": "create_credential_with_private_key", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_create_credential_with_private_key_manage_credential_private_key_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectCreationIdResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/credential/{credential_id}": { "get": { "tags": ["public"], "summary": "Get Credential By Id", "operationId": "get_credential_by_id", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "credential_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Credential Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/CredentialSnapshot" }, { "$ref": "#/components/schemas/StatusResponse_int_" } ], "title": "Response Get Credential By Id Manage Credential Credential Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": ["public"], "summary": "Update Credential From Model", "operationId": "update_credential_from_model", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "credential_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Credential Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialBase" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/CredentialSnapshot" }, { "$ref": "#/components/schemas/StatusResponse_int_" } ], "title": "Response Update Credential From Model Manage Credential Credential Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": ["public"], "summary": "Delete Credential By Id", "operationId": "delete_credential_by_id", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "credential_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Credential Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/credential/private-key/{credential_id}": { "put": { "tags": ["public"], "summary": "Update Credential Private Key", "operationId": "update_credential_private_key", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "credential_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Credential Id" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_update_credential_private_key_manage_admin_credential_private_key__credential_id__put" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialBase" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/credential/{credential_id}/sharing": { "put": { "tags": ["public"], "summary": "Update Credential Sharing Endpoint", "description": "Changes who may reuse a saved credential. Only its owner may do this, so\na credential with no owner keeps its sharing. ``name`` changes the name\nwhen set.", "operationId": "update_credential_sharing_endpoint", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "credential_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Credential Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialSharing" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialSnapshot" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/credential/force/{credential_id}": { "delete": { "tags": ["public"], "summary": "Force Delete Credential By Id", "operationId": "force_delete_credential_by_id", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "credential_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Credential Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/cc-pair/{cc_pair_id}/index-attempts": { "get": { "tags": ["public"], "summary": "Get Cc Pair Index Attempts", "operationId": "get_cc_pair_index_attempts", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "cc_pair_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Cc Pair Id" } }, { "name": "page_num", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Page Num" } }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 10, "title": "Page Size" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedReturn_IndexAttemptSnapshot_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/cc-pair/{cc_pair_id}": { "get": { "tags": ["public"], "summary": "Get Cc Pair Full Info", "operationId": "get_cc_pair_full_info", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "cc_pair_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Cc Pair Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CCPairFullInfo" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/cc-pair/{cc_pair_id}/status": { "put": { "tags": ["public"], "summary": "Update Cc Pair Status", "description": "This method returns nearly immediately. It simply sets some signals and\noptimistically assumes any running background processes will clean themselves up.\nThis is done to improve the perceived end user experience.\n\nReturns HTTPStatus.OK if everything finished.", "operationId": "update_cc_pair_status", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "cc_pair_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Cc Pair Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CCStatusUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/cc-pair/{cc_pair_id}/prune": { "post": { "tags": ["public"], "summary": "Prune Cc Pair", "description": "Triggers pruning on a particular cc_pair immediately", "operationId": "prune_cc_pair", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "cc_pair_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Cc Pair Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusResponse_list_int__" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/cc-pair/{cc_pair_id}/errors": { "get": { "tags": ["public"], "summary": "Get Cc Pair Indexing Errors", "description": "Gives back all errors for a given CC Pair. Allows pagination based on page and page_size params.\n\nArgs:\n cc_pair_id: ID of the connector-credential pair to get errors for\n include_resolved: Whether to include resolved errors in the results\n page_num: Page number for pagination, starting at 0\n page_size: Number of errors to return per page\n index_attempt_id: Keeps only the errors of this attempt\n q: Keeps only errors whose message or document id contains this text\n user: Current user; must be able to read this CC pair\n db_session: Database session\n\nReturns:\n Paginated list of indexing errors for the CC pair.", "operationId": "get_cc_pair_indexing_errors", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "cc_pair_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Cc Pair Id" } }, { "name": "include_resolved", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Resolved" } }, { "name": "page_num", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Page Num" } }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 10, "title": "Page Size" } }, { "name": "index_attempt_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Index Attempt Id" } }, { "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/PaginatedReturn_IndexAttemptErrorPydantic_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/connector/{connector_id}/credential/{credential_id}": { "put": { "tags": ["public"], "summary": "Associate Credential To Connector", "description": "NOTE(rkuo): internally discussed and the consensus is this endpoint\nand create_connector_with_mock_credential should be combined.\n\nThe intent of this endpoint is to handle connectors that actually need credentials.", "operationId": "associate_credential_to_connector", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Connector Id" } }, { "name": "credential_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Credential Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorCredentialPairMetadata" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusResponse_int_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": ["public"], "summary": "Dissociate Credential From Connector", "operationId": "dissociate_credential_from_connector", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Connector Id" } }, { "name": "credential_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Credential Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusResponse_int_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/user/projects": { "get": { "tags": ["public"], "summary": "Get Projects", "operationId": "get_projects", "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserProjectSnapshot" }, "title": "Response Get Projects User Projects Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/user/projects/create": { "post": { "tags": ["public"], "summary": "Create Project", "operationId": "create_project", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string", "title": "Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserProjectSnapshot" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/user/projects/file/upload": { "post": { "tags": ["public"], "summary": "Upload User Files", "operationId": "upload_user_files", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_user_files_user_projects_file_upload_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategorizedFilesSnapshot" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/user/projects/{project_id}": { "get": { "tags": ["public"], "summary": "Get Project", "operationId": "get_project", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserProjectSnapshot" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": ["public"], "summary": "Update Project", "operationId": "update_project", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProjectRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserProjectSnapshot" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": ["public"], "summary": "Delete Project", "operationId": "delete_project", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/user/projects/files/{project_id}": { "get": { "tags": ["public"], "summary": "Get Files In Project", "operationId": "get_files_in_project", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserFileSnapshot" }, "title": "Response Get Files In Project User Projects Files Project Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/user/projects/{project_id}/files/{file_id}": { "delete": { "tags": ["public"], "summary": "Unlink User File From Project", "description": "Unlink an existing user file from a specific project for the current user.\n\nDoes not delete the underlying file; only removes the association.", "operationId": "unlink_user_file_from_project", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "file_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "File Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": ["public"], "summary": "Link User File To Project", "description": "Link an existing user file to a specific project for the current user.\n\nCreates the association in the Project__UserFile join table if it does not exist.\nReturns the linked user file snapshot.", "operationId": "link_user_file_to_project", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "file_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "File Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserFileSnapshot" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/user/projects/{project_id}/instructions": { "get": { "tags": ["public"], "summary": "Get Project Instructions", "operationId": "get_project_instructions", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectInstructionsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": ["public"], "summary": "Upsert Project Instructions", "description": "Create or update this project's instructions stored on the project itself.", "operationId": "upsert_project_instructions", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertProjectInstructionsRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectInstructionsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/user/projects/{project_id}/details": { "get": { "tags": ["public"], "summary": "Get Project Details", "operationId": "get_project_details", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectPayload" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/user/projects/file/{file_id}": { "delete": { "tags": ["public"], "summary": "Delete User File", "description": "Delete a user file belonging to the current user.\n\nThis will also remove any project associations for the file.", "operationId": "delete_user_file", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "file_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "File Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserFileDeleteResult" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": ["public"], "summary": "Get User File", "description": "Fetch a single user file by ID for the current user.\n\nIncludes files in any status (including FAILED) to allow status polling.", "operationId": "get_user_file", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "file_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "File Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserFileSnapshot" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/user/projects/file/statuses": { "post": { "tags": ["public"], "summary": "Get User File Statuses", "description": "Fetch statuses for a set of user file IDs owned by the current user.\n\nIncludes files in any status so the client can detect transitions to FAILED.", "operationId": "get_user_file_statuses", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserFileIdsRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserFileSnapshot" }, "title": "Response Get User File Statuses User Projects File Statuses Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/user/projects/session/{chat_session_id}/files": { "get": { "tags": ["public"], "summary": "Get Chat Session Project Files", "description": "Return user files for the project linked to the given chat session.\n\nIf the chat session has no project, returns an empty list.\nOnly returns files owned by the current user and not FAILED.", "operationId": "get_chat_session_project_files", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "chat_session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Chat Session Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserFileSnapshot" }, "title": "Response Get Chat Session Project Files User Projects Session Chat Session Id Files Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/search": { "post": { "tags": ["public"], "summary": "Search", "description": "Search the Onyx index and get back ranked document sections.\n\nRuns the same multi-stage retrieval as the Search action in chat \u2014 query\nexpansion, hybrid retrieval, reranking and section merging \u2014 and returns the\nranked sections without generating an answer. Results are ordered most\nrelevant first and are always filtered by the calling user's document\npermissions.", "operationId": "search", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/persona": { "post": { "tags": ["public"], "summary": "Create Persona", "operationId": "create_persona", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonaUpsertRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonaSnapshot" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/persona/{persona_id}": { "patch": { "tags": ["public"], "summary": "Update Persona", "operationId": "update_persona", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "persona_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Persona Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonaUpsertRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonaSnapshot" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": ["public"], "summary": "Delete Persona", "operationId": "delete_persona", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "persona_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Persona Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": ["public"], "summary": "Get Persona", "operationId": "get_persona", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "persona_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Persona Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FullPersonaSnapshot" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/persona": { "get": { "tags": ["public"], "summary": "List Personas Admin", "operationId": "list_personas_admin", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "include_deleted", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Deleted" } }, { "name": "get_editable", "in": "query", "required": false, "schema": { "type": "boolean", "description": "If true, return editable personas", "default": false, "title": "Get Editable" }, "description": "If true, return editable personas" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PersonaSnapshot" }, "title": "Response List Personas Admin Admin Persona Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/persona/{persona_id}/undelete": { "patch": { "tags": ["public"], "summary": "Undelete Persona", "operationId": "undelete_persona", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "persona_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Persona Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/agents": { "get": { "tags": ["public"], "summary": "Get Agents Paginated", "description": "Paginated endpoint for listing agents available to the user.\n\nReturns items for the requested page plus total count.\nPersonas are ordered by display_priority (ASC, nulls last) then by ID (ASC).\n\nNOTE: persona_ids filter is not supported with pagination. Use the\nnon-paginated endpoint if filtering by specific IDs is needed.", "operationId": "get_agents_paginated", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "page_num", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Page number (0-indexed).", "default": 0, "title": "Page Num" }, "description": "Page number (0-indexed)." }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "description": "Items per page.", "default": 10, "title": "Page Size" }, "description": "Items per page." }, { "name": "include_deleted", "in": "query", "required": false, "schema": { "type": "boolean", "description": "If true, includes deleted personas.", "default": false, "title": "Include Deleted" }, "description": "If true, includes deleted personas." }, { "name": "get_editable", "in": "query", "required": false, "schema": { "type": "boolean", "description": "If true, only returns editable personas.", "default": false, "title": "Get Editable" }, "description": "If true, only returns editable personas." }, { "name": "include_default", "in": "query", "required": false, "schema": { "type": "boolean", "description": "If true, includes builtin/default personas.", "default": true, "title": "Include Default" }, "description": "If true, includes builtin/default personas." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedReturn_MinimalPersonaSnapshot_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/agents": { "get": { "tags": ["public"], "summary": "Get Agents Admin Paginated", "description": "Paginated endpoint for listing agents (formerly personas) (admin view).\n\nReturns items for the requested page plus total count.\nAgents are ordered by display_priority (ASC, nulls last) then by ID (ASC).", "operationId": "get_agents_admin_paginated", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "page_num", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Page number (0-indexed).", "default": 0, "title": "Page Num" }, "description": "Page number (0-indexed)." }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "description": "Items per page.", "default": 10, "title": "Page Size" }, "description": "Items per page." }, { "name": "include_deleted", "in": "query", "required": false, "schema": { "type": "boolean", "description": "If true, includes deleted personas.", "default": false, "title": "Include Deleted" }, "description": "If true, includes deleted personas." }, { "name": "get_editable", "in": "query", "required": false, "schema": { "type": "boolean", "description": "If true, only returns editable personas.", "default": false, "title": "Get Editable" }, "description": "If true, only returns editable personas." }, { "name": "include_default", "in": "query", "required": false, "schema": { "type": "boolean", "description": "If true, includes builtin/default personas.", "default": true, "title": "Include Default" }, "description": "If true, includes builtin/default personas." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedReturn_PersonaSnapshot_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tool/openapi": { "get": { "tags": ["public"], "summary": "List Openapi Tools", "operationId": "list_openapi_tools", "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ToolSnapshot" }, "title": "Response List Openapi Tools Tool Openapi Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tool/{tool_id}": { "get": { "tags": ["public"], "summary": "Get Custom Tool", "operationId": "get_custom_tool", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Tool Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolSnapshot" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tool/{tool_id}/preferences": { "patch": { "tags": ["public"], "summary": "Update Tool User Preferences", "operationId": "update_tool_user_preferences", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Tool Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolUserPreferences" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolUserPreferences" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tool": { "get": { "tags": ["public"], "summary": "List Tools", "operationId": "list_tools", "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ToolSnapshot" }, "title": "Response List Tools Tool Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/tool/custom": { "post": { "tags": ["public"], "summary": "Create Custom Tool", "operationId": "create_custom_tool", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomToolCreate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolSnapshot" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/tool/custom/{tool_id}": { "put": { "tags": ["public"], "summary": "Update Custom Tool", "operationId": "update_custom_tool", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Tool Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomToolUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolSnapshot" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": ["public"], "summary": "Delete Custom Tool", "operationId": "delete_custom_tool", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Tool Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/tool/custom/validate": { "post": { "tags": ["public"], "summary": "Validate Tool", "operationId": "validate_tool", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateToolRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateToolResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/health/ready": { "get": { "tags": ["public"], "summary": "Readiness", "description": "Readiness probe. Wire this to readinessProbe and to load balancers.\n\nSync endpoints run in the anyio threadpool, so a saturated pool means the\nserver cannot serve real traffic even though the event loop still turns.\nThis handler stays async on purpose: a sync handler would borrow a token of\nthe pool it is measuring, adding load exactly when there is none to spare,\nand would queue rather than answer. Liveness lives at /health.", "operationId": "readiness", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/health": { "get": { "tags": ["public"], "summary": "Healthcheck", "description": "Liveness probe. Answers only \"is this process still running\".\n\nDeliberately checks nothing else. Liveness failures restart the container,\nand saturation is load-induced and correlated across replicas, so gating\nrestarts on it would turn a slowdown into an outage. Use /health/ready for\nthat.", "operationId": "healthcheck", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusResponse" } } } } } } }, "/auth/type": { "get": { "tags": ["public"], "summary": "Get Auth Type", "operationId": "get_auth_type", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthConfigResponse" } } } } } } }, "/version": { "get": { "tags": ["public"], "summary": "Get Version", "operationId": "get_version", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionResponse" } } } } } } }, "/versions": { "get": { "tags": ["public"], "summary": "Get Versions", "description": "Fetches the latest stable and beta versions of Onyx Docker images.\nSince DockerHub does not explicitly flag stable and beta images,\nthis endpoint can be used to programmatically check for new images.", "operationId": "get_versions", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllVersions" } } } } } } }, "/onyx-api/connector-docs/{cc_pair_id}": { "get": { "tags": ["public"], "summary": "Get Docs By Connector Credential Pair", "operationId": "get_docs_by_connector_credential_pair", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "cc_pair_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Cc Pair Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocMinimalInfo" }, "title": "Response Get Docs By Connector Credential Pair Onyx Api Connector Docs Cc Pair Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/onyx-api/ingestion": { "get": { "tags": ["public"], "summary": "Get Ingestion Docs", "operationId": "get_ingestion_docs", "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocMinimalInfo" }, "title": "Response Get Ingestion Docs Onyx Api Ingestion Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": ["public"], "summary": "Upsert Ingestion Doc", "operationId": "upsert_ingestion_doc", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IngestionDocument" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IngestionResult" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/onyx-api/ingestion/{document_id}": { "delete": { "tags": ["public"], "summary": "Delete Ingestion Doc", "operationId": "delete_ingestion_doc", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "document_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Document Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/web-search/search": { "post": { "tags": ["public"], "summary": "Execute Web Search", "description": "Perform a web search and immediately fetch content for the returned URLs.\n\nUse this when you want both snippets and page contents from one call.\n\nIf you want to selectively fetch content (i.e. let the LLM decide which URLs to read),\nuse `/search-lite` and then call `/open-urls` separately.", "operationId": "execute_web_search", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebSearchToolRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebSearchWithContentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/web-search/search-lite": { "post": { "tags": ["public"], "summary": "Execute Web Search Lite", "description": "Lightweight search-only endpoint. Returns search snippets and URLs without\nfetching page contents. Pair with `/open-urls` if you need to fetch content\nlater.", "operationId": "execute_web_search_lite", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebSearchToolRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebSearchToolResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/web-search/open-urls": { "post": { "tags": ["public"], "summary": "Execute Open Urls", "description": "Fetch content for specific URLs using the configured content provider.\nIntended to complement `/search-lite` when you need content for a subset of URLs.", "operationId": "execute_open_urls", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenUrlsToolRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenUrlsToolResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/cost-overrides": { "get": { "tags": ["public"], "summary": "List Cost Overrides", "operationId": "list_cost_overrides", "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CostOverride" }, "title": "Response List Cost Overrides Admin Cost Overrides Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": ["public"], "summary": "Create Cost Override Endpoint", "operationId": "create_cost_override_endpoint", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostOverrideCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostOverride" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/cost-overrides/{model_configuration_id}": { "put": { "tags": ["public"], "summary": "Update Cost Override Endpoint", "operationId": "update_cost_override_endpoint", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "model_configuration_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Model Configuration Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostOverrideUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostOverride" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": ["public"], "summary": "Delete Cost Override Endpoint", "operationId": "delete_cost_override_endpoint", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "model_configuration_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Model Configuration Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/user/usage": { "get": { "tags": ["public"], "summary": "Get My Usage", "description": "Caller's token/cost usage for the Usage tab.", "operationId": "get_my_usage", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "days", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 3650, "minimum": 1 }, { "type": "null" } ], "title": "Days" } }, { "name": "start", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Start" } }, { "name": "end", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "End" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserUsageResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/usage/export": { "get": { "tags": ["public"], "summary": "Export Usage", "description": "Company-wide daily usage export by email.", "operationId": "export_usage", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "start", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Start" } }, { "name": "end", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "End" } }, { "name": "model", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageExportResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/usage/system": { "get": { "tags": ["public"], "summary": "Get System Usage", "operationId": "get_system_usage", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "start", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Start" } }, { "name": "end", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "End" } }, { "name": "model", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemUsageResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/usage/reset": { "post": { "tags": ["public"], "summary": "Reset Usage", "description": "Clear a user's usage across every applicable active limit window.", "operationId": "reset_usage", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResetUsageRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResetUsageResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/user-group": { "get": { "tags": ["public"], "summary": "List User Groups", "operationId": "list_user_groups", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "include_default", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Default" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" }, "title": "Response List User Groups Manage Admin User Group Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": ["public"], "summary": "Create User Group", "operationId": "create_user_group", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupCreate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroup" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/user-group/{user_group_id}": { "get": { "tags": ["public"], "summary": "Get User Group", "description": "Read one group with its nested connector, document-set and agent snapshots.", "operationId": "get_user_group", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "user_group_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "User Group Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroup" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": ["public"], "summary": "Patch User Group", "operationId": "patch_user_group", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "user_group_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "User Group Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroup" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": ["public"], "summary": "Delete User Group", "operationId": "delete_user_group", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "user_group_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "User Group Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/user-groups/minimal": { "get": { "tags": ["public"], "summary": "List Minimal User Groups", "operationId": "list_minimal_user_groups", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "include_default", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Default" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MinimalUserGroupSnapshot" }, "title": "Response List Minimal User Groups Manage User Groups Minimal Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/permissions/registry": { "get": { "tags": ["public"], "summary": "Get Permission Registry", "operationId": "get_permission_registry", "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionRegistryEntry" }, "title": "Response Get Permission Registry Manage Admin Permissions Registry Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/user-group/{user_group_id}/permissions": { "get": { "tags": ["public"], "summary": "Get User Group Permissions", "operationId": "get_user_group_permissions", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "user_group_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "User Group Id" } }, { "name": "include_non_toggleable", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Non Toggleable" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Permission" }, "title": "Response Get User Group Permissions Manage Admin User Group User Group Id Permissions Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": ["public"], "summary": "Set User Group Permissions", "operationId": "set_user_group_permissions", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "user_group_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "User Group Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkSetPermissionsRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Permission" }, "title": "Response Set User Group Permissions Manage Admin User Group User Group Id Permissions Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/user-group/rename": { "patch": { "tags": ["public"], "summary": "Rename User Group Endpoint", "operationId": "rename_user_group_endpoint", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupRename" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroup" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/user-group/{user_group_id}/incognito": { "patch": { "tags": ["public"], "summary": "Patch User Group Incognito", "description": "Only meaningful while the security setting is groups-only, but always\nstorable so admins can stage membership before flipping the mode.", "operationId": "patch_user_group_incognito", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "user_group_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "User Group Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupIncognitoUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroup" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/user-group/{user_group_id}/data-access-cc-pairs": { "put": { "tags": ["public"], "summary": "Set User Group Data Access Cc Pairs Endpoint", "description": "Sets the private and restricted connectors whose documents the group's\nmembers may read.", "operationId": "set_user_group_data_access_cc_pairs_endpoint", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "user_group_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "User Group Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupDataAccessCCPairs" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupDataAccessCCPairs" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/user-group/{user_group_id}/managed-cc-pairs": { "put": { "tags": ["public"], "summary": "Set Group Managed Cc Pairs", "description": "Replace the connectors this group manages, and its role on each. Authorized\nas a group edit: the caller manages the group, and a scoped manager may only\nattach (or re-role) pairs within their managed scope.", "operationId": "set_group_managed_cc_pairs", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "user_group_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "User Group Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupManagedCCPairsUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ManagedCCPairEntry" }, "title": "Response Set Group Managed Cc Pairs Manage Admin User Group User Group Id Managed Cc Pairs Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/user-group/{user_group_id}/add-users": { "post": { "tags": ["public"], "summary": "Add Users", "operationId": "add_users", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "user_group_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "User Group Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddUsersToUserGroupRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroup" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/user-group/{user_group_id}/agents": { "patch": { "tags": ["public"], "summary": "Update Group Agents", "operationId": "update_group_agents", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "user_group_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "User Group Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateGroupAgentsRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/user-group/{user_group_id}/document-sets": { "patch": { "tags": ["public"], "summary": "Update Group Document Sets", "description": "Share document sets with a group from the group's side \u2014 the document-set route is\ngated on MANAGE_DOCUMENT_SETS, which a groups admin doesn't hold.", "operationId": "update_group_document_sets", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "user_group_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "User Group Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateGroupDocumentSetsRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/manage/admin/user-group/{user_group_id}/manager": { "put": { "tags": ["public"], "summary": "Set Group Manager", "operationId": "set_group_manager", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "user_group_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "User Group Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetGroupManagerRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/analytics/admin/query": { "get": { "tags": ["public"], "summary": "Get Query Analytics", "operationId": "get_query_analytics", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "start", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Start" } }, { "name": "end", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryAnalyticsResponse" }, "title": "Response Get Query Analytics Analytics Admin Query Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/analytics/admin/user": { "get": { "tags": ["public"], "summary": "Get User Analytics", "operationId": "get_user_analytics", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "start", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Start" } }, { "name": "end", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserAnalyticsResponse" }, "title": "Response Get User Analytics Analytics Admin User Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/analytics/admin/onyxbot": { "get": { "tags": ["public"], "summary": "Get Onyxbot Analytics", "operationId": "get_onyxbot_analytics", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "start", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Start" } }, { "name": "end", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OnyxbotAnalyticsResponse" }, "title": "Response Get Onyxbot Analytics Analytics Admin Onyxbot Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/analytics/admin/persona/messages": { "get": { "tags": ["public"], "summary": "Get Persona Messages", "description": "Fetch daily message counts for a single persona within the given time range.", "operationId": "get_persona_messages", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "persona_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Persona Id" } }, { "name": "start", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Start" } }, { "name": "end", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PersonaMessageAnalyticsResponse" }, "title": "Response Get Persona Messages Analytics Admin Persona Messages Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/analytics/admin/persona/unique-users": { "get": { "tags": ["public"], "summary": "Get Persona Unique Users", "description": "Get unique users per day for a single persona.", "operationId": "get_persona_unique_users", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "persona_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Persona Id" } }, { "name": "start", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time", "title": "Start" } }, { "name": "end", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time", "title": "End" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PersonaUniqueUsersResponse" }, "title": "Response Get Persona Unique Users Analytics Admin Persona Unique Users Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/analytics/assistant/{assistant_id}/stats": { "get": { "tags": ["public"], "summary": "Get Assistant Stats", "description": "Returns daily message and unique user counts for a user's assistant,\nalong with the overall total messages and total distinct users.", "operationId": "get_assistant_stats", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "assistant_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Assistant Id" } }, { "name": "start", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Start" } }, { "name": "end", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssistantStatsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/query-history/start-export": { "post": { "tags": ["public"], "summary": "Start Query History Export", "operationId": "start_query_history_export", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "start", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Start" } }, { "name": "end", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" }, "title": "Response Start Query History Export Admin Query History Start Export Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/query-history/export-status": { "get": { "tags": ["public"], "summary": "Get Query History Export Status", "operationId": "get_query_history_export_status", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "request_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Request Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" }, "title": "Response Get Query History Export Status Admin Query History Export Status Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/query-history/download": { "get": { "tags": ["public"], "summary": "Download Query History Csv", "operationId": "download_query_history_csv", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "request_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Request Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/search/search-flow-classification": { "post": { "tags": ["public"], "summary": "Search Flow Classification", "description": "Classify whether a query should be answered by search or by chat.\n\nQueries longer than 200 characters are classified as a chat flow without an\nLLM call. A failed classification falls back to ``is_search_flow: false``\nrather than raising.", "operationId": "search_flow_classification", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchFlowClassificationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchFlowClassificationResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/search/send-search-message": { "post": { "tags": ["public"], "summary": "Handle Send Search Message", "description": "Executes a search query with optional streaming.\n\nIf hybrid_alpha is unset and ONYX_SEARCH_UI_USES_OPENSEARCH_KEYWORD_SEARCH\nis True, executes pure keyword search.\n\nReturns:\n StreamingResponse with SSE if stream=True, otherwise SearchFullResponse.", "operationId": "handle_send_search_message", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendSearchQueryRequest" } } } }, "responses": { "200": { "description": "If `stream=true`, returns `text/event-stream`.\nIf `stream=false` (the default), returns `application/json` (SearchFullResponse).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchFullResponse" } }, "text/event-stream": { "schema": { "type": "string" }, "examples": { "stream": { "summary": "Stream of NDJSON search packets", "value": "string" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/search/search-history": { "get": { "tags": ["public"], "summary": "Get Search History", "description": "Fetch past search queries for the authenticated user.\n\nArgs:\n limit: Maximum number of queries to return (default 100)\n filter_days: Only return queries from the last N days (optional)\n\nReturns:\n SearchHistoryResponse with list of search queries, ordered by most recent first.", "operationId": "get_search_history", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 100, "title": "Limit" } }, { "name": "filter_days", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Filter Days" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchHistoryResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/token-rate-limits/global": { "get": { "tags": ["public"], "summary": "Get Global Token Limit Settings", "operationId": "get_global_token_limit_settings", "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TokenRateLimitDisplay" }, "title": "Response Get Global Token Limit Settings Admin Token Rate Limits Global Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": ["public"], "summary": "Create Global Token Limit Settings", "operationId": "create_global_token_limit_settings", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenRateLimitArgs" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenRateLimitDisplay" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/token-rate-limits/rate-limit/{token_rate_limit_id}": { "put": { "tags": ["public"], "summary": "Update Token Limit Settings", "operationId": "update_token_limit_settings", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "token_rate_limit_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Token Rate Limit Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenRateLimitUpdateArgs" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenRateLimitDisplay" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": ["public"], "summary": "Delete Token Limit Settings", "operationId": "delete_token_limit_settings", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "token_rate_limit_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Token Rate Limit Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/token-rate-limits/user-groups": { "get": { "tags": ["public"], "summary": "Get All Group Token Limit Settings", "operationId": "get_all_group_token_limit_settings", "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/TokenRateLimitDisplay" } }, "title": "Response Get All Group Token Limit Settings Admin Token Rate Limits User Groups Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/token-rate-limits/user-group/{group_id}": { "get": { "tags": ["public"], "summary": "Get Group Token Limit Settings", "operationId": "get_group_token_limit_settings", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "group_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Group Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TokenRateLimitDisplay" }, "title": "Response Get Group Token Limit Settings Admin Token Rate Limits User Group Group Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": ["public"], "summary": "Create Group Token Limit Settings", "operationId": "create_group_token_limit_settings", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "group_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Group Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenRateLimitArgs" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenRateLimitDisplay" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/token-rate-limits/user-group/{group_id}/rate-limit/{rate_limit_id}": { "put": { "tags": ["public"], "summary": "Update Group Token Limit Settings", "operationId": "update_group_token_limit_settings", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "group_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Group Id" } }, { "name": "rate_limit_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Rate Limit Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenRateLimitUpdateArgs" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenRateLimitDisplay" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": ["public"], "summary": "Delete Group Token Limit Settings", "operationId": "delete_group_token_limit_settings", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "group_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Group Id" } }, { "name": "rate_limit_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Rate Limit Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/token-rate-limits/users": { "get": { "tags": ["public"], "summary": "Get User Token Limit Settings", "operationId": "get_user_token_limit_settings", "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TokenRateLimitDisplay" }, "title": "Response Get User Token Limit Settings Admin Token Rate Limits Users Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": ["public"], "summary": "Create User Token Limit Settings", "operationId": "create_user_token_limit_settings", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenRateLimitArgs" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenRateLimitDisplay" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "components": { "schemas": { "AccessType": { "type": "string", "enum": ["public", "private", "sync", "sync_restricted"], "title": "AccessType" }, "AccountType": { "type": "string", "enum": [ "STANDARD", "BOT", "EXT_PERM_USER", "SERVICE_ACCOUNT", "ANONYMOUS" ], "title": "AccountType", "description": "What kind of account this is \u2014 determines whether the user\nenters the group-based permission system.\n\nSTANDARD + SERVICE_ACCOUNT \u2192 participate in group system\nBOT, EXT_PERM_USER, ANONYMOUS \u2192 fixed behavior" }, "AddUsersToUserGroupRequest": { "properties": { "user_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "User Ids" } }, "type": "object", "required": ["user_ids"], "title": "AddUsersToUserGroupRequest" }, "AgentResponseDelta": { "properties": { "type": { "type": "string", "const": "message_delta", "title": "Type", "default": "message_delta" }, "content": { "type": "string", "title": "Content" } }, "type": "object", "required": ["content"], "title": "AgentResponseDelta" }, "AgentResponseStart": { "properties": { "type": { "type": "string", "const": "message_start", "title": "Type", "default": "message_start" }, "final_documents": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SearchDoc" }, "type": "array" }, { "type": "null" } ], "title": "Final Documents" }, "pre_answer_processing_seconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Pre Answer Processing Seconds" } }, "type": "object", "title": "AgentResponseStart" }, "AllUsersResponse": { "properties": { "accepted": { "items": { "$ref": "#/components/schemas/FullUserSnapshot" }, "type": "array", "title": "Accepted" }, "invited": { "items": { "$ref": "#/components/schemas/InvitedUserSnapshot" }, "type": "array", "title": "Invited" }, "slack_users": { "items": { "$ref": "#/components/schemas/FullUserSnapshot" }, "type": "array", "title": "Slack Users" }, "accepted_pages": { "type": "integer", "title": "Accepted Pages" }, "invited_pages": { "type": "integer", "title": "Invited Pages" }, "slack_users_pages": { "type": "integer", "title": "Slack Users Pages" } }, "type": "object", "required": [ "accepted", "invited", "slack_users", "accepted_pages", "invited_pages", "slack_users_pages" ], "title": "AllUsersResponse" }, "AllVersions": { "properties": { "stable": { "$ref": "#/components/schemas/ContainerVersions" }, "dev": { "$ref": "#/components/schemas/ContainerVersions" }, "migration": { "$ref": "#/components/schemas/ContainerVersions" } }, "type": "object", "required": ["stable", "dev", "migration"], "title": "AllVersions" }, "AssistantDailyUsageResponse": { "properties": { "date": { "type": "string", "format": "date", "title": "Date" }, "total_messages": { "type": "integer", "title": "Total Messages" }, "total_unique_users": { "type": "integer", "title": "Total Unique Users" } }, "type": "object", "required": ["date", "total_messages", "total_unique_users"], "title": "AssistantDailyUsageResponse" }, "AssistantStatsResponse": { "properties": { "daily_stats": { "items": { "$ref": "#/components/schemas/AssistantDailyUsageResponse" }, "type": "array", "title": "Daily Stats" }, "total_messages": { "type": "integer", "title": "Total Messages" }, "total_unique_users": { "type": "integer", "title": "Total Unique Users" } }, "type": "object", "required": ["daily_stats", "total_messages", "total_unique_users"], "title": "AssistantStatsResponse" }, "AttachedDocumentSnapshot": { "properties": { "id": { "type": "string", "title": "Id" }, "title": { "type": "string", "title": "Title" }, "link": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Link" }, "parent_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Parent Id" }, "last_modified": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Modified" }, "last_synced": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Synced" }, "source": { "anyOf": [ { "$ref": "#/components/schemas/DocumentSource" }, { "type": "null" } ] } }, "type": "object", "required": [ "id", "title", "link", "parent_id", "last_modified", "last_synced", "source" ], "title": "AttachedDocumentSnapshot", "description": "Minimal representation of an attached document for persona responses." }, "AuthConfigResponse": { "properties": { "multi_tenant": { "type": "boolean", "title": "Multi Tenant" }, "requires_verification": { "type": "boolean", "title": "Requires Verification" }, "anonymous_user_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Anonymous User Enabled" }, "password_min_length": { "type": "integer", "title": "Password Min Length" }, "password_max_length": { "type": "integer", "title": "Password Max Length" }, "password_require_uppercase": { "type": "boolean", "title": "Password Require Uppercase", "default": false }, "password_require_lowercase": { "type": "boolean", "title": "Password Require Lowercase", "default": false }, "password_require_digit": { "type": "boolean", "title": "Password Require Digit", "default": false }, "password_require_special_char": { "type": "boolean", "title": "Password Require Special Char", "default": false }, "has_users": { "type": "boolean", "title": "Has Users", "default": true }, "oauth_enabled": { "type": "boolean", "title": "Oauth Enabled", "default": false }, "password_auth_enabled": { "type": "boolean", "title": "Password Auth Enabled", "default": true }, "sso_providers": { "items": { "$ref": "#/components/schemas/SSOProviderOption" }, "type": "array", "title": "Sso Providers", "default": [] }, "default_language": { "anyOf": [ { "$ref": "#/components/schemas/SupportedLanguage" }, { "type": "null" } ] } }, "type": "object", "required": [ "multi_tenant", "requires_verification", "password_min_length", "password_max_length" ], "title": "AuthConfigResponse" }, "BaseFilters": { "properties": { "source_type": { "anyOf": [ { "items": { "$ref": "#/components/schemas/DocumentSource" }, "type": "array" }, { "type": "null" } ], "title": "Source Type" }, "document_set": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Document Set" }, "created_at_range": { "anyOf": [ { "$ref": "#/components/schemas/TimeRange" }, { "type": "null" } ] }, "updated_at_range": { "anyOf": [ { "$ref": "#/components/schemas/TimeRange" }, { "type": "null" } ] }, "tags": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Tag" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "time_cutoff": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Time Cutoff" } }, "type": "object", "title": "BaseFilters" }, "BashToolDelta": { "properties": { "type": { "type": "string", "const": "bash_tool_delta", "title": "Type", "default": "bash_tool_delta" }, "stdout": { "type": "string", "title": "Stdout", "default": "" }, "stderr": { "type": "string", "title": "Stderr", "default": "" }, "exit_code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Exit Code" }, "timed_out": { "type": "boolean", "title": "Timed Out", "default": false } }, "type": "object", "title": "BashToolDelta" }, "BashToolStart": { "properties": { "type": { "type": "string", "const": "bash_tool_start", "title": "Type", "default": "bash_tool_start" }, "cmd": { "type": "string", "title": "Cmd" } }, "type": "object", "required": ["cmd"], "title": "BashToolStart" }, "BasicCCPairInfo": { "properties": { "has_successful_run": { "type": "boolean", "title": "Has Successful Run" }, "source": { "$ref": "#/components/schemas/DocumentSource" }, "status": { "$ref": "#/components/schemas/ConnectorCredentialPairStatus" } }, "type": "object", "required": ["has_successful_run", "source", "status"], "title": "BasicCCPairInfo" }, "BasicExpertInfo": { "properties": { "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First Name" }, "middle_initial": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Middle Initial" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Name" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" } }, "type": "object", "title": "BasicExpertInfo", "description": "Basic Information for the owner of a document, any of the fields can be left as None\nDisplay fallback goes as follows:\n- first_name + (optional middle_initial) + last_name\n- display_name\n- email\n- first_name" }, "Body_bulk_invite_users_manage_admin_users_put": { "properties": { "emails": { "items": { "type": "string" }, "type": "array", "title": "Emails" } }, "type": "object", "required": ["emails"], "title": "Body_bulk_invite_users_manage_admin_users_put" }, "Body_create_credential_with_private_key_manage_credential_private_key_post": { "properties": { "credential_json": { "type": "string", "title": "Credential Json" }, "admin_public": { "type": "boolean", "title": "Admin Public", "default": false }, "curator_public": { "type": "boolean", "title": "Curator Public", "default": false }, "groups": { "items": { "type": "integer" }, "type": "array", "title": "Groups", "default": [] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "source": { "type": "string", "title": "Source" }, "uploaded_file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "Uploaded File" }, "field_key": { "type": "string", "title": "Field Key" }, "type_definition_key": { "type": "string", "title": "Type Definition Key" } }, "type": "object", "required": [ "credential_json", "source", "uploaded_file", "field_key", "type_definition_key" ], "title": "Body_create_credential_with_private_key_manage_credential_private_key_post" }, "Body_update_connector_files_manage_admin_connector__connector_id__files_update_post": { "properties": { "files": { "anyOf": [ { "items": { "type": "string", "contentMediaType": "application/octet-stream" }, "type": "array" }, { "type": "null" } ], "title": "Files" }, "file_ids_to_remove": { "type": "string", "title": "File Ids To Remove", "default": "[]" } }, "type": "object", "title": "Body_update_connector_files_manage_admin_connector__connector_id__files_update_post" }, "Body_update_credential_private_key_manage_admin_credential_private_key__credential_id__put": { "properties": { "name": { "type": "string", "title": "Name" }, "credential_json": { "type": "string", "title": "Credential Json" }, "uploaded_file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "Uploaded File" }, "field_key": { "type": "string", "title": "Field Key" }, "type_definition_key": { "type": "string", "title": "Type Definition Key" } }, "type": "object", "required": [ "name", "credential_json", "uploaded_file", "field_key", "type_definition_key" ], "title": "Body_update_credential_private_key_manage_admin_credential_private_key__credential_id__put" }, "Body_upload_files_api_manage_admin_connector_file_upload_post": { "properties": { "files": { "items": { "type": "string", "contentMediaType": "application/octet-stream" }, "type": "array", "title": "Files" } }, "type": "object", "required": ["files"], "title": "Body_upload_files_api_manage_admin_connector_file_upload_post" }, "Body_upload_user_files_user_projects_file_upload_post": { "properties": { "files": { "items": { "type": "string", "contentMediaType": "application/octet-stream" }, "type": "array", "title": "Files" }, "project_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Project Id" }, "temp_id_map": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Temp Id Map" }, "incognito_session_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Incognito Session Id" } }, "type": "object", "required": ["files"], "title": "Body_upload_user_files_user_projects_file_upload_post" }, "BulkInviteResponse": { "properties": { "invited_count": { "type": "integer", "title": "Invited Count" }, "email_invite_status": { "$ref": "#/components/schemas/EmailInviteStatus" } }, "type": "object", "required": ["invited_count", "email_invite_status"], "title": "BulkInviteResponse" }, "BulkSetPermissionsRequest": { "properties": { "permissions": { "items": { "$ref": "#/components/schemas/Permission" }, "type": "array", "title": "Permissions" } }, "type": "object", "required": ["permissions"], "title": "BulkSetPermissionsRequest" }, "CCPairFullInfo": { "properties": { "id": { "type": "integer", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "status": { "$ref": "#/components/schemas/ConnectorCredentialPairStatus" }, "in_repeated_error_state": { "type": "boolean", "title": "In Repeated Error State" }, "num_docs_indexed": { "type": "integer", "title": "Num Docs Indexed" }, "connector": { "$ref": "#/components/schemas/ConnectorSnapshot" }, "credential": { "$ref": "#/components/schemas/CredentialSnapshot" }, "number_of_index_attempts": { "type": "integer", "title": "Number Of Index Attempts" }, "last_index_attempt_status": { "anyOf": [ { "$ref": "#/components/schemas/IndexingStatus" }, { "type": "null" } ] }, "latest_deletion_attempt": { "anyOf": [ { "$ref": "#/components/schemas/DeletionAttemptSnapshot" }, { "type": "null" } ] }, "access_type": { "$ref": "#/components/schemas/AccessType" }, "is_editable_for_current_user": { "type": "boolean", "title": "Is Editable For Current User" }, "permissions": { "additionalProperties": { "type": "boolean" }, "type": "object", "title": "Permissions" }, "deletion_failure_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deletion Failure Message" }, "indexing": { "type": "boolean", "title": "Indexing" }, "creator": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Creator" }, "creator_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Creator Email" }, "last_indexed": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Indexed" }, "last_pruned": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Pruned" }, "last_full_permission_sync": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Full Permission Sync" }, "last_time_perm_sync": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Time Perm Sync" }, "last_time_external_group_sync": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Time External Group Sync" }, "overall_indexing_speed": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Overall Indexing Speed" }, "latest_checkpoint_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Latest Checkpoint Description" }, "last_permission_sync_attempt_status": { "anyOf": [ { "$ref": "#/components/schemas/PermissionSyncStatus" }, { "type": "null" } ] }, "permission_syncing": { "type": "boolean", "title": "Permission Syncing" }, "last_permission_sync_attempt_finished": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Permission Sync Attempt Finished" }, "last_permission_sync_attempt_error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Permission Sync Attempt Error Message" }, "supports_doc_permission_sync": { "type": "boolean", "title": "Supports Doc Permission Sync" }, "supports_targeted_reindex": { "type": "boolean", "title": "Supports Targeted Reindex" }, "has_named_checks": { "type": "boolean", "title": "Has Named Checks" }, "groups": { "items": { "type": "integer" }, "type": "array", "title": "Groups" }, "auto_sync_options": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Auto Sync Options" }, "processing_mode": { "$ref": "#/components/schemas/ProcessingMode" }, "indexing_hold": { "anyOf": [ { "$ref": "#/components/schemas/IndexingHold" }, { "type": "null" } ] }, "pending_backfills": { "items": { "$ref": "#/components/schemas/PendingBackfillSnapshot" }, "type": "array", "title": "Pending Backfills" } }, "type": "object", "required": [ "id", "name", "status", "in_repeated_error_state", "num_docs_indexed", "connector", "credential", "number_of_index_attempts", "last_index_attempt_status", "latest_deletion_attempt", "access_type", "is_editable_for_current_user", "permissions", "deletion_failure_message", "indexing", "creator", "creator_email", "last_indexed", "last_pruned", "last_full_permission_sync", "last_time_perm_sync", "last_time_external_group_sync", "overall_indexing_speed", "latest_checkpoint_description", "last_permission_sync_attempt_status", "permission_syncing", "last_permission_sync_attempt_finished", "last_permission_sync_attempt_error_message", "supports_doc_permission_sync", "supports_targeted_reindex", "has_named_checks", "groups", "auto_sync_options", "processing_mode", "pending_backfills" ], "title": "CCPairFullInfo" }, "CCPairManageAccessEntry": { "properties": { "group_id": { "type": "integer", "title": "Group Id" }, "role": { "$ref": "#/components/schemas/ConnectorManageRole" } }, "type": "object", "required": ["group_id", "role"], "title": "CCPairManageAccessEntry" }, "CCPairSummary": { "properties": { "id": { "type": "integer", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "source": { "$ref": "#/components/schemas/DocumentSource" }, "access_type": { "$ref": "#/components/schemas/AccessType" } }, "type": "object", "required": ["id", "name", "source", "access_type"], "title": "CCPairSummary", "description": "Simplified connector-credential pair information with just essential data" }, "CCStatusUpdateRequest": { "properties": { "status": { "$ref": "#/components/schemas/ConnectorCredentialPairStatus" } }, "type": "object", "required": ["status"], "title": "CCStatusUpdateRequest" }, "CategorizedFilesSnapshot": { "properties": { "user_files": { "items": { "$ref": "#/components/schemas/UserFileSnapshot" }, "type": "array", "title": "User Files" }, "rejected_files": { "items": { "$ref": "#/components/schemas/RejectedFile" }, "type": "array", "title": "Rejected Files" } }, "type": "object", "required": ["user_files", "rejected_files"], "title": "CategorizedFilesSnapshot" }, "ChatFileType": { "type": "string", "enum": ["image", "document", "plain_text", "tabular"], "title": "ChatFileType" }, "ChatFullResponse": { "properties": { "answer": { "type": "string", "title": "Answer" }, "answer_citationless": { "type": "string", "title": "Answer Citationless" }, "pre_answer_reasoning": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pre Answer Reasoning" }, "tool_calls": { "items": { "$ref": "#/components/schemas/ToolCallResponse" }, "type": "array", "title": "Tool Calls", "default": [] }, "top_documents": { "items": { "$ref": "#/components/schemas/SearchDoc" }, "type": "array", "title": "Top Documents" }, "citation_info": { "items": { "$ref": "#/components/schemas/CitationInfo" }, "type": "array", "title": "Citation Info" }, "message_id": { "type": "integer", "title": "Message Id" }, "chat_session_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Chat Session Id" }, "incognito": { "type": "boolean", "title": "Incognito", "default": false }, "error_msg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Msg" } }, "type": "object", "required": [ "answer", "answer_citationless", "top_documents", "citation_info", "message_id" ], "title": "ChatFullResponse", "description": "Complete non-streaming response with all available data.\nNOTE: This model is used for the core flow of the Onyx application, any changes to it should be reviewed and approved by an\nexperienced team member. It is very important to 1. avoid bloat and 2. that this remains backwards compatible across versions." }, "ChatHeartbeat": { "properties": { "type": { "type": "string", "const": "chat_heartbeat", "title": "Type", "default": "chat_heartbeat" } }, "type": "object", "title": "ChatHeartbeat" }, "ChatMessageDetail": { "properties": { "chat_session_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Chat Session Id" }, "message_id": { "type": "integer", "title": "Message Id" }, "parent_message": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Parent Message" }, "latest_child_message": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Latest Child Message" }, "message": { "type": "string", "title": "Message" }, "reasoning_tokens": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reasoning Tokens" }, "message_type": { "$ref": "#/components/schemas/MessageType" }, "context_docs": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SavedSearchDoc" }, "type": "array" }, { "type": "null" } ], "title": "Context Docs" }, "citations": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Citations" }, "time_sent": { "type": "string", "format": "date-time", "title": "Time Sent" }, "files": { "items": { "$ref": "#/components/schemas/FileDescriptor" }, "type": "array", "title": "Files" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "current_feedback": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Current Feedback" }, "processing_duration_seconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Processing Duration Seconds" }, "preferred_response_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Preferred Response Id" }, "model_display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Display Name" }, "request_params": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Request Params" } }, "type": "object", "required": [ "message_id", "message", "message_type", "time_sent", "files" ], "title": "ChatMessageDetail" }, "ChatMinimalTextMessage": { "properties": { "message": { "type": "string", "title": "Message" }, "message_type": { "$ref": "#/components/schemas/MessageType" } }, "type": "object", "required": ["message", "message_type"], "title": "ChatMinimalTextMessage" }, "ChatSearchResponse": { "properties": { "groups": { "items": { "$ref": "#/components/schemas/ChatSessionGroup" }, "type": "array", "title": "Groups" }, "has_more": { "type": "boolean", "title": "Has More" }, "next_page": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next Page" } }, "type": "object", "required": ["groups", "has_more"], "title": "ChatSearchResponse" }, "ChatSessionCreationRequest": { "properties": { "persona_id": { "type": "integer", "title": "Persona Id", "default": 0 }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "project_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Project Id" }, "incognito": { "type": "boolean", "title": "Incognito", "default": false }, "incognito_session_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Incognito Session Id" } }, "type": "object", "title": "ChatSessionCreationRequest" }, "ChatSessionDetailResponse": { "properties": { "chat_session_id": { "type": "string", "format": "uuid", "title": "Chat Session Id" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "persona_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Persona Id" }, "persona_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Persona Name" }, "personal_icon_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Personal Icon Name" }, "messages": { "items": { "$ref": "#/components/schemas/ChatMessageDetail" }, "type": "array", "title": "Messages" }, "time_created": { "type": "string", "format": "date-time", "title": "Time Created" }, "shared_status": { "$ref": "#/components/schemas/ChatSessionSharedStatus" }, "current_alternate_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Current Alternate Model" }, "current_temperature_override": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Current Temperature Override" }, "current_reasoning_effort_override": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Current Reasoning Effort Override" }, "deleted": { "type": "boolean", "title": "Deleted", "default": false }, "owner_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner Name" }, "packets": { "items": { "items": { "$ref": "#/components/schemas/Packet" }, "type": "array" }, "type": "array", "title": "Packets" }, "current_stream": { "anyOf": [ { "$ref": "#/components/schemas/CurrentStreamInfo" }, { "type": "null" } ] }, "incognito": { "type": "boolean", "title": "Incognito", "default": false } }, "type": "object", "required": [ "chat_session_id", "description", "persona_name", "personal_icon_name", "messages", "time_created", "shared_status", "current_alternate_model", "current_temperature_override", "current_reasoning_effort_override", "packets" ], "title": "ChatSessionDetailResponse" }, "ChatSessionDetails": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "persona_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Persona Id" }, "time_created": { "type": "string", "title": "Time Created" }, "time_updated": { "type": "string", "title": "Time Updated" }, "shared_status": { "$ref": "#/components/schemas/ChatSessionSharedStatus" }, "current_alternate_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Current Alternate Model" }, "current_temperature_override": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Current Temperature Override" }, "current_reasoning_effort_override": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Current Reasoning Effort Override" } }, "type": "object", "required": [ "id", "name", "time_created", "time_updated", "shared_status" ], "title": "ChatSessionDetails" }, "ChatSessionGroup": { "properties": { "title": { "type": "string", "title": "Title" }, "chats": { "items": { "$ref": "#/components/schemas/ChatSessionSummary" }, "type": "array", "title": "Chats" } }, "type": "object", "required": ["title", "chats"], "title": "ChatSessionGroup" }, "ChatSessionSharedStatus": { "type": "string", "enum": ["public", "private"], "title": "ChatSessionSharedStatus" }, "ChatSessionSummary": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "persona_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Persona Id" }, "time_created": { "type": "string", "format": "date-time", "title": "Time Created" }, "shared_status": { "$ref": "#/components/schemas/ChatSessionSharedStatus" }, "current_alternate_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Current Alternate Model" }, "current_temperature_override": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Current Temperature Override" }, "current_reasoning_effort_override": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Current Reasoning Effort Override" } }, "type": "object", "required": ["id", "time_created", "shared_status"], "title": "ChatSessionSummary" }, "ChatSessionsResponse": { "properties": { "sessions": { "items": { "$ref": "#/components/schemas/ChatSessionDetails" }, "type": "array", "title": "Sessions" }, "has_more": { "type": "boolean", "title": "Has More", "default": false } }, "type": "object", "required": ["sessions"], "title": "ChatSessionsResponse" }, "CitationInfo": { "properties": { "type": { "type": "string", "const": "citation_info", "title": "Type", "default": "citation_info" }, "citation_number": { "type": "integer", "title": "Citation Number" }, "document_id": { "type": "string", "title": "Document Id" } }, "type": "object", "required": ["citation_number", "document_id"], "title": "CitationInfo" }, "CodingAgentFinal": { "properties": { "type": { "type": "string", "const": "coding_agent_final", "title": "Type", "default": "coding_agent_final" }, "answer": { "type": "string", "title": "Answer" } }, "type": "object", "required": ["answer"], "title": "CodingAgentFinal" }, "CodingAgentStart": { "properties": { "type": { "type": "string", "const": "coding_agent_start", "title": "Type", "default": "coding_agent_start" }, "query": { "type": "string", "title": "Query" }, "repo": { "type": "string", "title": "Repo" } }, "type": "object", "required": ["query", "repo"], "title": "CodingAgentStart" }, "CodingAgentThinkingDelta": { "properties": { "type": { "type": "string", "const": "coding_agent_thinking_delta", "title": "Type", "default": "coding_agent_thinking_delta" }, "content": { "type": "string", "title": "Content" } }, "type": "object", "required": ["content"], "title": "CodingAgentThinkingDelta" }, "ConnectorCredentialPairDescriptor": { "properties": { "id": { "type": "integer", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "connector": { "$ref": "#/components/schemas/ConnectorSnapshot" }, "credential": { "$ref": "#/components/schemas/CredentialSnapshot" }, "access_type": { "$ref": "#/components/schemas/AccessType" } }, "type": "object", "required": ["id", "name", "connector", "credential", "access_type"], "title": "ConnectorCredentialPairDescriptor" }, "ConnectorCredentialPairIdentifier": { "properties": { "connector_id": { "type": "integer", "title": "Connector Id" }, "credential_id": { "type": "integer", "title": "Credential Id" } }, "type": "object", "required": ["connector_id", "credential_id"], "title": "ConnectorCredentialPairIdentifier" }, "ConnectorCredentialPairMetadata": { "properties": { "name": { "type": "string", "title": "Name" }, "access_type": { "$ref": "#/components/schemas/AccessType" }, "auto_sync_options": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Auto Sync Options" }, "groups": { "items": { "type": "integer" }, "type": "array", "title": "Groups" }, "manage_access": { "items": { "$ref": "#/components/schemas/CCPairManageAccessEntry" }, "type": "array", "title": "Manage Access" }, "data_access": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Data Access" }, "processing_mode": { "$ref": "#/components/schemas/ProcessingMode", "default": "REGULAR" } }, "type": "object", "required": ["name", "access_type"], "title": "ConnectorCredentialPairMetadata" }, "ConnectorCredentialPairStatus": { "type": "string", "enum": [ "SCHEDULED", "INITIAL_INDEXING", "ACTIVE", "PAUSED", "DELETING", "INVALID" ], "title": "ConnectorCredentialPairStatus" }, "ConnectorFileInfo": { "properties": { "file_id": { "type": "string", "title": "File Id" }, "file_name": { "type": "string", "title": "File Name" }, "file_size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "File Size" }, "upload_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Upload Date" } }, "type": "object", "required": ["file_id", "file_name"], "title": "ConnectorFileInfo" }, "ConnectorFilesResponse": { "properties": { "files": { "items": { "$ref": "#/components/schemas/ConnectorFileInfo" }, "type": "array", "title": "Files" }, "total_items": { "type": "integer", "title": "Total Items" } }, "type": "object", "required": ["files", "total_items"], "title": "ConnectorFilesResponse" }, "ConnectorIndexingStatusLite": { "properties": { "cc_pair_id": { "type": "integer", "title": "Cc Pair Id" }, "name": { "type": "string", "title": "Name" }, "source": { "$ref": "#/components/schemas/DocumentSource" }, "access_type": { "$ref": "#/components/schemas/AccessType" }, "cc_pair_status": { "$ref": "#/components/schemas/ConnectorCredentialPairStatus" }, "in_progress": { "type": "boolean", "title": "In Progress" }, "in_repeated_error_state": { "type": "boolean", "title": "In Repeated Error State" }, "last_finished_status": { "anyOf": [ { "$ref": "#/components/schemas/IndexingStatus" }, { "type": "null" } ] }, "last_status": { "anyOf": [ { "$ref": "#/components/schemas/IndexingStatus" }, { "type": "null" } ] }, "last_success": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Success" }, "is_editable": { "type": "boolean", "title": "Is Editable" }, "permissions": { "additionalProperties": { "type": "boolean" }, "type": "object", "title": "Permissions" }, "docs_indexed": { "type": "integer", "title": "Docs Indexed" }, "latest_index_attempt_docs_indexed": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Latest Index Attempt Docs Indexed" } }, "type": "object", "required": [ "cc_pair_id", "name", "source", "access_type", "cc_pair_status", "in_progress", "in_repeated_error_state", "last_finished_status", "last_status", "last_success", "is_editable", "permissions", "docs_indexed", "latest_index_attempt_docs_indexed" ], "title": "ConnectorIndexingStatusLite" }, "ConnectorIndexingStatusLiteResponse": { "properties": { "source": { "$ref": "#/components/schemas/DocumentSource" }, "summary": { "$ref": "#/components/schemas/SourceSummary" }, "current_page": { "type": "integer", "title": "Current Page" }, "total_pages": { "type": "integer", "title": "Total Pages" }, "indexing_statuses": { "items": { "anyOf": [ { "$ref": "#/components/schemas/ConnectorIndexingStatusLite" }, { "$ref": "#/components/schemas/FederatedConnectorStatus" } ] }, "type": "array", "title": "Indexing Statuses" } }, "type": "object", "required": [ "source", "summary", "current_page", "total_pages", "indexing_statuses" ], "title": "ConnectorIndexingStatusLiteResponse" }, "ConnectorManageRole": { "type": "string", "enum": ["editor", "operator"], "title": "ConnectorManageRole", "description": "A group's role on a cc-pair it manages. Editors change and delete the\nconfiguration; Operators schedule and monitor indexing." }, "ConnectorSnapshot": { "properties": { "name": { "type": "string", "title": "Name" }, "source": { "$ref": "#/components/schemas/DocumentSource" }, "input_type": { "$ref": "#/components/schemas/InputType" }, "connector_specific_config": { "additionalProperties": true, "type": "object", "title": "Connector Specific Config" }, "refresh_freq": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Refresh Freq" }, "prune_freq": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Prune Freq" }, "check_freq": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Check Freq" }, "indexing_start": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Indexing Start" }, "id": { "type": "integer", "title": "Id" }, "credential_ids": { "items": { "type": "integer" }, "type": "array", "title": "Credential Ids" }, "time_created": { "type": "string", "format": "date-time", "title": "Time Created" }, "time_updated": { "type": "string", "format": "date-time", "title": "Time Updated" } }, "type": "object", "required": [ "name", "source", "input_type", "connector_specific_config", "id", "credential_ids", "time_created", "time_updated" ], "title": "ConnectorSnapshot" }, "ConnectorStatus": { "properties": { "cc_pair_id": { "type": "integer", "title": "Cc Pair Id" }, "name": { "type": "string", "title": "Name" }, "connector": { "$ref": "#/components/schemas/ConnectorSnapshot" }, "credential": { "$ref": "#/components/schemas/CredentialSnapshot" }, "access_type": { "$ref": "#/components/schemas/AccessType" }, "groups": { "items": { "type": "integer" }, "type": "array", "title": "Groups" } }, "type": "object", "required": [ "cc_pair_id", "name", "connector", "credential", "access_type", "groups" ], "title": "ConnectorStatus", "description": "Represents the status of a connector,\nincluding indexing status elated information" }, "ConnectorUpdateRequest": { "properties": { "name": { "type": "string", "title": "Name" }, "source": { "$ref": "#/components/schemas/DocumentSource" }, "input_type": { "$ref": "#/components/schemas/InputType" }, "connector_specific_config": { "additionalProperties": true, "type": "object", "title": "Connector Specific Config" }, "refresh_freq": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Refresh Freq" }, "prune_freq": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Prune Freq" }, "check_freq": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Check Freq" }, "indexing_start": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Indexing Start" }, "access_type": { "$ref": "#/components/schemas/AccessType" }, "groups": { "items": { "type": "integer" }, "type": "array", "title": "Groups" } }, "type": "object", "required": [ "name", "source", "input_type", "connector_specific_config", "access_type" ], "title": "ConnectorUpdateRequest" }, "ContainerVersions": { "properties": { "onyx": { "type": "string", "title": "Onyx" }, "relational_db": { "type": "string", "title": "Relational Db" }, "index": { "type": "string", "title": "Index" }, "nginx": { "type": "string", "title": "Nginx" } }, "type": "object", "required": ["onyx", "relational_db", "index", "nginx"], "title": "ContainerVersions" }, "CostOverride": { "properties": { "model_configuration_id": { "type": "integer", "title": "Model Configuration Id" }, "model_name": { "type": "string", "title": "Model Name" }, "model_display_name": { "type": "string", "title": "Model Display Name" }, "llm_provider_id": { "type": "integer", "title": "Llm Provider Id" }, "llm_provider_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Llm Provider Name" }, "provider": { "type": "string", "title": "Provider" }, "input_cost_per_mtok": { "type": "number", "title": "Input Cost Per Mtok" }, "output_cost_per_mtok": { "type": "number", "title": "Output Cost Per Mtok" }, "cache_read_cost_per_mtok": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cache Read Cost Per Mtok" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "required": [ "model_configuration_id", "model_name", "model_display_name", "llm_provider_id", "llm_provider_name", "provider", "input_cost_per_mtok", "output_cost_per_mtok", "cache_read_cost_per_mtok", "updated_at" ], "title": "CostOverride" }, "CostOverrideCreateRequest": { "properties": { "input_cost_per_mtok": { "type": "number", "minimum": 0.0, "title": "Input Cost Per Mtok" }, "output_cost_per_mtok": { "type": "number", "minimum": 0.0, "title": "Output Cost Per Mtok" }, "cache_read_cost_per_mtok": { "anyOf": [ { "type": "number", "minimum": 0.0 }, { "type": "null" } ], "title": "Cache Read Cost Per Mtok" }, "model_configuration_id": { "type": "integer", "title": "Model Configuration Id" } }, "type": "object", "required": [ "input_cost_per_mtok", "output_cost_per_mtok", "model_configuration_id" ], "title": "CostOverrideCreateRequest" }, "CostOverrideUpdateRequest": { "properties": { "input_cost_per_mtok": { "type": "number", "minimum": 0.0, "title": "Input Cost Per Mtok" }, "output_cost_per_mtok": { "type": "number", "minimum": 0.0, "title": "Output Cost Per Mtok" }, "cache_read_cost_per_mtok": { "anyOf": [ { "type": "number", "minimum": 0.0 }, { "type": "null" } ], "title": "Cache Read Cost Per Mtok" }, "model_configuration_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Model Configuration Id" } }, "type": "object", "required": ["input_cost_per_mtok", "output_cost_per_mtok"], "title": "CostOverrideUpdateRequest" }, "CreateChatSessionID": { "properties": { "chat_session_id": { "type": "string", "format": "uuid", "title": "Chat Session Id" }, "incognito": { "type": "boolean", "title": "Incognito", "default": false } }, "type": "object", "required": ["chat_session_id"], "title": "CreateChatSessionID" }, "CredentialBase": { "properties": { "credential_json": { "additionalProperties": true, "type": "object", "title": "Credential Json" }, "admin_public": { "type": "boolean", "title": "Admin Public" }, "source": { "$ref": "#/components/schemas/DocumentSource" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "curator_public": { "type": "boolean", "title": "Curator Public", "default": false }, "groups": { "items": { "type": "integer" }, "type": "array", "title": "Groups" } }, "type": "object", "required": ["credential_json", "admin_public", "source"], "title": "CredentialBase" }, "CredentialBinding": { "properties": {}, "type": "object", "title": "CredentialBinding", "description": "The config fields whose valid values depend on the account behind the\ncredential, e.g. a site URL, a cloud vs. data center flag, or a national-cloud\nhost. A connector config inherits its binding model, so the stored config\nstays flat. Validated on its own from a full config, it ignores the other keys." }, "CredentialCapability": { "type": "string", "enum": ["indexing", "doc_permission_sync", "external_group_sync"], "title": "CredentialCapability", "description": "User-visible capabilities a credential may or may not support for a source." }, "CredentialDataUpdateRequest": { "properties": { "name": { "type": "string", "title": "Name" }, "credential_json": { "additionalProperties": true, "type": "object", "title": "Credential Json" } }, "type": "object", "required": ["name", "credential_json"], "title": "CredentialDataUpdateRequest" }, "CredentialSharing": { "properties": { "admin_public": { "type": "boolean", "title": "Admin Public", "default": true }, "curator_public": { "type": "boolean", "title": "Curator Public", "default": false }, "groups": { "items": { "type": "integer" }, "type": "array", "title": "Groups" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" } }, "type": "object", "title": "CredentialSharing", "description": "Who may reuse a credential: ``CredentialBase``'s sharing fields.\n\n``admin_public`` shares with every admin (global MANAGE_CONNECTORS).\n``groups`` (EE) shares with the users who hold Manage Connectors in one of\nthe groups: its managers, and members who hold the permission globally.\n``curator_public`` is kept for older clients and grants nothing." }, "CredentialSnapshot": { "properties": { "credential_json": { "additionalProperties": true, "type": "object", "title": "Credential Json" }, "admin_public": { "type": "boolean", "title": "Admin Public" }, "source": { "$ref": "#/components/schemas/DocumentSource" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "curator_public": { "type": "boolean", "title": "Curator Public", "default": false }, "groups": { "items": { "type": "integer" }, "type": "array", "title": "Groups" }, "id": { "type": "integer", "title": "Id" }, "user_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "User Id" }, "user_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Email" }, "user_personal_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Personal Name" }, "time_created": { "type": "string", "format": "date-time", "title": "Time Created" }, "time_updated": { "type": "string", "format": "date-time", "title": "Time Updated" }, "is_owner": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Owner" } }, "type": "object", "required": [ "credential_json", "admin_public", "source", "id", "user_id", "time_created", "time_updated" ], "title": "CredentialSnapshot" }, "CredentialSwapRequest": { "properties": { "new_credential_id": { "type": "integer", "title": "New Credential Id" }, "connector_id": { "type": "integer", "title": "Connector Id" }, "access_type": { "$ref": "#/components/schemas/AccessType" } }, "type": "object", "required": ["new_credential_id", "connector_id", "access_type"], "title": "CredentialSwapRequest" }, "CredentialUsage": { "properties": { "cc_pair_id": { "type": "integer", "title": "Cc Pair Id" }, "cc_pair_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cc Pair Name" }, "connector_id": { "type": "integer", "title": "Connector Id" }, "source": { "$ref": "#/components/schemas/DocumentSource" }, "credential_binding": { "anyOf": [ { "$ref": "#/components/schemas/CredentialBinding" }, { "type": "null" } ] } }, "type": "object", "required": [ "cc_pair_id", "cc_pair_name", "connector_id", "source", "credential_binding" ], "title": "CredentialUsage", "description": "A connector that uses a credential, as a hint for picking a credential." }, "CurrentStreamInfo": { "properties": { "stream_id": { "type": "integer", "title": "Stream Id" } }, "type": "object", "required": ["stream_id"], "title": "CurrentStreamInfo", "description": "Unfinished response available for stream reconnection." }, "CustomToolArgs": { "properties": { "type": { "type": "string", "const": "custom_tool_args", "title": "Type", "default": "custom_tool_args" }, "tool_name": { "type": "string", "title": "Tool Name" }, "tool_args": { "additionalProperties": true, "type": "object", "title": "Tool Args" } }, "type": "object", "required": ["tool_name", "tool_args"], "title": "CustomToolArgs" }, "CustomToolCreate": { "properties": { "default_chat_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Default Chat Enabled" }, "enabled": { "type": "boolean", "title": "Enabled", "default": true }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "definition": { "additionalProperties": true, "type": "object", "title": "Definition" }, "custom_headers": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Header" }, "type": "array" }, { "type": "null" } ], "title": "Custom Headers" }, "passthrough_auth": { "type": "boolean", "title": "Passthrough Auth" }, "oauth_config_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Oauth Config Id" } }, "type": "object", "required": ["name", "definition", "passthrough_auth"], "title": "CustomToolCreate" }, "CustomToolDelta": { "properties": { "type": { "type": "string", "const": "custom_tool_delta", "title": "Type", "default": "custom_tool_delta" }, "tool_name": { "type": "string", "title": "Tool Name" }, "tool_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Tool Id" }, "response_type": { "type": "string", "title": "Response Type" }, "data": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "items": {}, "type": "array" }, { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ], "title": "Data" }, "file_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "File Ids" }, "error": { "anyOf": [ { "$ref": "#/components/schemas/CustomToolErrorInfo" }, { "type": "null" } ] } }, "type": "object", "required": ["tool_name", "response_type"], "title": "CustomToolDelta" }, "CustomToolErrorInfo": { "properties": { "is_auth_error": { "type": "boolean", "title": "Is Auth Error", "default": false }, "is_unreachable": { "type": "boolean", "title": "Is Unreachable", "default": false }, "status_code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Status Code" }, "message": { "type": "string", "title": "Message" } }, "type": "object", "required": ["status_code", "message"], "title": "CustomToolErrorInfo" }, "CustomToolStart": { "properties": { "type": { "type": "string", "const": "custom_tool_start", "title": "Type", "default": "custom_tool_start" }, "tool_name": { "type": "string", "title": "Tool Name" }, "tool_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Tool Id" } }, "type": "object", "required": ["tool_name"], "title": "CustomToolStart" }, "CustomToolUpdate": { "properties": { "default_chat_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Default Chat Enabled" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "definition": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Definition" }, "custom_headers": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Header" }, "type": "array" }, { "type": "null" } ], "title": "Custom Headers" }, "passthrough_auth": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Passthrough Auth" }, "oauth_config_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Oauth Config Id" } }, "type": "object", "title": "CustomToolUpdate" }, "DeepResearchPlanDelta": { "properties": { "type": { "type": "string", "const": "deep_research_plan_delta", "title": "Type", "default": "deep_research_plan_delta" }, "content": { "type": "string", "title": "Content" } }, "type": "object", "required": ["content"], "title": "DeepResearchPlanDelta" }, "DeepResearchPlanStart": { "properties": { "type": { "type": "string", "const": "deep_research_plan_start", "title": "Type", "default": "deep_research_plan_start" } }, "type": "object", "title": "DeepResearchPlanStart" }, "DefaultAppMode": { "type": "string", "enum": ["AUTO", "CHAT", "SEARCH"], "title": "DefaultAppMode" }, "DeletionAttemptSnapshot": { "properties": { "connector_id": { "type": "integer", "title": "Connector Id" }, "credential_id": { "type": "integer", "title": "Credential Id" }, "status": { "$ref": "#/components/schemas/TaskStatus" } }, "type": "object", "required": ["connector_id", "credential_id", "status"], "title": "DeletionAttemptSnapshot" }, "DocMinimalInfo": { "properties": { "document_id": { "type": "string", "title": "Document Id" }, "semantic_id": { "type": "string", "title": "Semantic Id" }, "link": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Link" } }, "type": "object", "required": ["document_id", "semantic_id"], "title": "DocMinimalInfo" }, "DocsCountOperator": { "type": "string", "enum": [">", "<", "="], "title": "DocsCountOperator" }, "DocumentBase": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "sections": { "items": { "anyOf": [ { "$ref": "#/components/schemas/TextSection" }, { "$ref": "#/components/schemas/ImageSection" }, { "$ref": "#/components/schemas/TabularSection" } ] }, "type": "array", "title": "Sections" }, "source": { "anyOf": [ { "$ref": "#/components/schemas/DocumentSource" }, { "type": "null" } ] }, "semantic_identifier": { "type": "string", "title": "Semantic Identifier" }, "metadata": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "type": "object", "title": "Metadata" }, "doc_updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Doc Updated At" }, "doc_created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Doc Created At" }, "chunk_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Chunk Count" }, "primary_owners": { "anyOf": [ { "items": { "$ref": "#/components/schemas/BasicExpertInfo" }, "type": "array" }, { "type": "null" } ], "title": "Primary Owners" }, "secondary_owners": { "anyOf": [ { "items": { "$ref": "#/components/schemas/BasicExpertInfo" }, "type": "array" }, { "type": "null" } ], "title": "Secondary Owners" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "from_ingestion_api": { "type": "boolean", "title": "From Ingestion Api", "default": false }, "additional_info": { "title": "Additional Info" }, "external_access": { "anyOf": [ { "$ref": "#/components/schemas/ExternalAccess" }, { "type": "null" } ] }, "doc_metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Doc Metadata" }, "parent_hierarchy_raw_node_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Hierarchy Raw Node Id" }, "parent_hierarchy_node_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Parent Hierarchy Node Id" }, "file_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Id" } }, "type": "object", "required": ["sections", "semantic_identifier", "metadata"], "title": "DocumentBase", "description": "Used for Onyx ingestion api, the ID is inferred before use if not provided" }, "DocumentSet": { "properties": { "id": { "type": "integer", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "cc_pair_descriptors": { "items": { "$ref": "#/components/schemas/ConnectorCredentialPairDescriptor" }, "type": "array", "title": "Cc Pair Descriptors" }, "is_up_to_date": { "type": "boolean", "title": "Is Up To Date" }, "is_public": { "type": "boolean", "title": "Is Public" }, "users": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Users" }, "groups": { "items": { "type": "integer" }, "type": "array", "title": "Groups" }, "federated_connectors": { "items": { "$ref": "#/components/schemas/FederatedConnectorDescriptor" }, "type": "array", "title": "Federated Connectors" } }, "type": "object", "required": [ "id", "name", "description", "cc_pair_descriptors", "is_up_to_date", "is_public", "users", "groups" ], "title": "DocumentSet" }, "DocumentSetSummary": { "properties": { "id": { "type": "integer", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "cc_pair_summaries": { "items": { "$ref": "#/components/schemas/CCPairSummary" }, "type": "array", "title": "Cc Pair Summaries" }, "is_up_to_date": { "type": "boolean", "title": "Is Up To Date" }, "is_public": { "type": "boolean", "title": "Is Public" }, "users": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Users" }, "groups": { "items": { "type": "integer" }, "type": "array", "title": "Groups" }, "permissions": { "additionalProperties": { "type": "boolean" }, "type": "object", "title": "Permissions" }, "federated_connector_summaries": { "items": { "$ref": "#/components/schemas/FederatedConnectorSummary" }, "type": "array", "title": "Federated Connector Summaries" } }, "type": "object", "required": [ "id", "name", "description", "cc_pair_summaries", "is_up_to_date", "is_public", "users", "groups" ], "title": "DocumentSetSummary", "description": "Simplified document set model with minimal data for list views" }, "DocumentSource": { "type": "string", "enum": [ "ingestion_api", "slack", "web", "google_drive", "gmail", "github", "gitbook", "gitlab", "guru", "bookstack", "outline", "confluence", "jira", "slab", "productboard", "file", "coda", "canvas", "notion", "zulip", "linear", "hubspot", "document360", "gong", "google_sites", "zendesk", "loopio", "box", "dropbox", "sharepoint", "onedrive", "teams", "outlook", "salesforce", "discourse", "axero", "clickup", "mediawiki", "wikipedia", "asana", "s3", "r2", "google_cloud_storage", "oci_storage", "xenforo", "not_applicable", "discord", "freshdesk", "fireflies", "zoom", "egnyte", "airtable", "highspot", "drupal_wiki", "imap", "bitbucket", "testrail", "braintrust", "lumapps", "youtrack", "mock_connector", "user_file", "craft_file" ], "title": "DocumentSource" }, "EmailInviteStatus": { "type": "string", "enum": ["SENT", "NOT_CONFIGURED", "SEND_FAILED", "DISABLED"], "title": "EmailInviteStatus" }, "ExternalAccess": { "properties": { "external_user_emails": { "items": { "type": "string" }, "type": "array", "uniqueItems": true, "title": "External User Emails" }, "external_user_group_ids": { "items": { "type": "string" }, "type": "array", "uniqueItems": true, "title": "External User Group Ids" }, "is_public": { "type": "boolean", "title": "Is Public" } }, "type": "object", "required": [ "external_user_emails", "external_user_group_ids", "is_public" ], "title": "ExternalAccess" }, "FailedConnectorIndexingStatus": { "properties": { "cc_pair_id": { "type": "integer", "title": "Cc Pair Id" }, "name": { "type": "string", "title": "Name" }, "error_msg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Msg" }, "is_deletable": { "type": "boolean", "title": "Is Deletable" }, "connector_id": { "type": "integer", "title": "Connector Id" }, "credential_id": { "type": "integer", "title": "Credential Id" } }, "type": "object", "required": [ "cc_pair_id", "name", "error_msg", "is_deletable", "connector_id", "credential_id" ], "title": "FailedConnectorIndexingStatus", "description": "Simplified version of ConnectorIndexingStatus for failed indexing attempts" }, "FederatedConnectorDescriptor": { "properties": { "id": { "type": "integer", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "source": { "type": "string", "title": "Source" }, "entities": { "additionalProperties": true, "type": "object", "title": "Entities" } }, "type": "object", "required": ["id", "name", "source", "entities"], "title": "FederatedConnectorDescriptor", "description": "Descriptor for a federated connector in a document set" }, "FederatedConnectorSource": { "type": "string", "enum": ["federated_slack"], "title": "FederatedConnectorSource" }, "FederatedConnectorStatus": { "properties": { "id": { "type": "integer", "title": "Id" }, "source": { "$ref": "#/components/schemas/FederatedConnectorSource" }, "name": { "type": "string", "title": "Name" } }, "type": "object", "required": ["id", "source", "name"], "title": "FederatedConnectorStatus" }, "FederatedConnectorSummary": { "properties": { "id": { "type": "integer", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "source": { "$ref": "#/components/schemas/FederatedConnectorSource" }, "entities": { "additionalProperties": true, "type": "object", "title": "Entities" } }, "type": "object", "required": ["id", "name", "source", "entities"], "title": "FederatedConnectorSummary", "description": "Simplified federated connector information with just essential data" }, "FileDescriptor": { "properties": { "id": { "type": "string", "title": "Id" }, "type": { "$ref": "#/components/schemas/ChatFileType" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "user_file_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User File Id" } }, "type": "object", "required": ["id", "type"], "title": "FileDescriptor", "description": "NOTE: is a `TypedDict` so it can be used as a type hint for a JSONB column\nin Postgres" }, "FileReaderResult": { "properties": { "type": { "type": "string", "const": "file_reader_result", "title": "Type", "default": "file_reader_result" }, "file_name": { "type": "string", "title": "File Name" }, "file_id": { "type": "string", "title": "File Id" }, "start_char": { "type": "integer", "title": "Start Char" }, "end_char": { "type": "integer", "title": "End Char" }, "total_chars": { "type": "integer", "title": "Total Chars" }, "preview_start": { "type": "string", "title": "Preview Start", "default": "" }, "preview_end": { "type": "string", "title": "Preview End", "default": "" } }, "type": "object", "required": [ "file_name", "file_id", "start_char", "end_char", "total_chars" ], "title": "FileReaderResult" }, "FileReaderStart": { "properties": { "type": { "type": "string", "const": "file_reader_start", "title": "Type", "default": "file_reader_start" } }, "type": "object", "title": "FileReaderStart" }, "FileUploadResponse": { "properties": { "file_paths": { "items": { "type": "string" }, "type": "array", "title": "File Paths" }, "file_names": { "items": { "type": "string" }, "type": "array", "title": "File Names" }, "zip_metadata_file_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zip Metadata File Id" } }, "type": "object", "required": ["file_paths", "file_names", "zip_metadata_file_id"], "title": "FileUploadResponse" }, "FullPersonaSnapshot": { "properties": { "id": { "type": "integer", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "is_public": { "type": "boolean", "title": "Is Public" }, "is_listed": { "type": "boolean", "title": "Is Listed" }, "uploaded_image_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Uploaded Image Id" }, "icon_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Icon Name" }, "user_file_ids": { "items": { "type": "string" }, "type": "array", "title": "User File Ids" }, "display_priority": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Display Priority" }, "is_featured": { "type": "boolean", "title": "Is Featured" }, "builtin_persona": { "type": "boolean", "title": "Builtin Persona" }, "starter_messages": { "anyOf": [ { "items": { "$ref": "#/components/schemas/StarterMessage" }, "type": "array" }, { "type": "null" } ], "title": "Starter Messages" }, "tools": { "items": { "$ref": "#/components/schemas/ToolSnapshot" }, "type": "array", "title": "Tools" }, "labels": { "items": { "$ref": "#/components/schemas/PersonaLabelSnapshot" }, "type": "array", "title": "Labels" }, "owner": { "anyOf": [ { "$ref": "#/components/schemas/MinimalUserSnapshot" }, { "type": "null" } ] }, "owner_group": { "anyOf": [ { "$ref": "#/components/schemas/PersonaOwnerGroupSnapshot" }, { "type": "null" } ] }, "users": { "items": { "$ref": "#/components/schemas/MinimalUserSnapshot" }, "type": "array", "title": "Users" }, "groups": { "items": { "type": "integer" }, "type": "array", "title": "Groups" }, "user_shares": { "items": { "$ref": "#/components/schemas/PersonaUserShare" }, "type": "array", "title": "User Shares" }, "group_shares": { "items": { "$ref": "#/components/schemas/PersonaGroupShare" }, "type": "array", "title": "Group Shares" }, "public_permission": { "$ref": "#/components/schemas/PersonaSharePermission" }, "sharing_status": { "$ref": "#/components/schemas/PersonaSharingStatus" }, "document_sets": { "items": { "$ref": "#/components/schemas/DocumentSetSummary" }, "type": "array", "title": "Document Sets" }, "default_model_configuration_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Default Model Configuration Id" }, "hierarchy_nodes": { "items": { "$ref": "#/components/schemas/HierarchyNodeSnapshot" }, "type": "array", "title": "Hierarchy Nodes" }, "attached_documents": { "items": { "$ref": "#/components/schemas/AttachedDocumentSnapshot" }, "type": "array", "title": "Attached Documents" }, "permissions": { "additionalProperties": { "type": "boolean" }, "type": "object", "title": "Permissions" }, "system_prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "System Prompt" }, "replace_base_system_prompt": { "type": "boolean", "title": "Replace Base System Prompt", "default": false }, "task_prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Task Prompt" }, "datetime_aware": { "type": "boolean", "title": "Datetime Aware", "default": true }, "search_start_date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Search Start Date" }, "user_permission": { "anyOf": [ { "$ref": "#/components/schemas/PersonaAccessLevel" }, { "type": "null" } ] }, "admin_count": { "type": "integer", "title": "Admin Count", "default": 0 }, "ownership_vacant": { "type": "boolean", "title": "Ownership Vacant", "default": false } }, "type": "object", "required": [ "id", "name", "description", "is_public", "is_listed", "uploaded_image_id", "icon_name", "user_file_ids", "display_priority", "is_featured", "builtin_persona", "starter_messages", "tools", "labels", "owner", "owner_group", "users", "groups", "user_shares", "group_shares", "public_permission", "sharing_status", "document_sets" ], "title": "FullPersonaSnapshot" }, "FullUserSnapshot": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "email": { "type": "string", "title": "Email" }, "account_type": { "$ref": "#/components/schemas/AccountType" }, "is_admin": { "type": "boolean", "title": "Is Admin", "default": false }, "is_active": { "type": "boolean", "title": "Is Active" }, "password_configured": { "type": "boolean", "title": "Password Configured" }, "personal_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Personal Name" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "last_active": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Active" }, "groups": { "items": { "$ref": "#/components/schemas/UserGroupInfo" }, "type": "array", "title": "Groups" }, "is_scim_synced": { "type": "boolean", "title": "Is Scim Synced" }, "craft_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Craft Enabled" } }, "type": "object", "required": [ "id", "email", "account_type", "is_active", "password_configured", "personal_name", "created_at", "updated_at", "groups", "is_scim_synced", "craft_enabled" ], "title": "FullUserSnapshot" }, "GeneratedImage": { "properties": { "file_id": { "type": "string", "title": "File Id" }, "url": { "type": "string", "title": "Url" }, "revised_prompt": { "type": "string", "title": "Revised Prompt" }, "shape": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Shape" } }, "type": "object", "required": ["file_id", "url", "revised_prompt"], "title": "GeneratedImage", "description": "Represents an image generated by an image generation tool." }, "GroupManagedCCPairsUpdateRequest": { "properties": { "cc_pairs": { "items": { "$ref": "#/components/schemas/ManagedCCPairEntry" }, "type": "array", "title": "Cc Pairs" } }, "type": "object", "required": ["cc_pairs"], "title": "GroupManagedCCPairsUpdateRequest" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "Header": { "properties": { "key": { "type": "string", "title": "Key" }, "value": { "type": "string", "title": "Value" } }, "type": "object", "required": ["key", "value"], "title": "Header" }, "HeldCheck": { "properties": { "check_id": { "type": "string", "title": "Check Id" }, "capability": { "$ref": "#/components/schemas/CredentialCapability" }, "display_name": { "type": "string", "title": "Display Name" }, "message": { "type": "string", "title": "Message" }, "remediation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Remediation" }, "docs_link": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Docs Link" } }, "type": "object", "required": ["check_id", "capability", "display_name", "message"], "title": "HeldCheck", "description": "A required check that failed, as the connector page shows it." }, "HierarchyNodeSnapshot": { "properties": { "id": { "type": "integer", "title": "Id" }, "raw_node_id": { "type": "string", "title": "Raw Node Id" }, "display_name": { "type": "string", "title": "Display Name" }, "link": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Link" }, "source": { "$ref": "#/components/schemas/DocumentSource" }, "node_type": { "$ref": "#/components/schemas/HierarchyNodeType" } }, "type": "object", "required": [ "id", "raw_node_id", "display_name", "link", "source", "node_type" ], "title": "HierarchyNodeSnapshot", "description": "Minimal representation of a hierarchy node for persona responses." }, "HierarchyNodeType": { "type": "string", "enum": [ "folder", "source", "stub", "shared_drive", "my_drive", "space", "page", "project", "database", "workspace", "site", "drive", "channel", "mailbox" ], "title": "HierarchyNodeType", "description": "Types of hierarchy nodes across different sources" }, "ImageGenerationFinal": { "properties": { "type": { "type": "string", "const": "image_generation_final", "title": "Type", "default": "image_generation_final" }, "images": { "items": { "$ref": "#/components/schemas/GeneratedImage" }, "type": "array", "title": "Images" } }, "type": "object", "required": ["images"], "title": "ImageGenerationFinal" }, "ImageGenerationToolHeartbeat": { "properties": { "type": { "type": "string", "const": "image_generation_heartbeat", "title": "Type", "default": "image_generation_heartbeat" } }, "type": "object", "title": "ImageGenerationToolHeartbeat" }, "ImageGenerationToolStart": { "properties": { "type": { "type": "string", "const": "image_generation_start", "title": "Type", "default": "image_generation_start" } }, "type": "object", "title": "ImageGenerationToolStart" }, "ImageSection": { "properties": { "type": { "type": "string", "const": "image", "title": "Type", "default": "image" }, "link": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Link" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Text" }, "image_file_id": { "type": "string", "title": "Image File Id" }, "heading": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Heading" } }, "type": "object", "required": ["image_file_id"], "title": "ImageSection", "description": "Section containing an image reference" }, "IndexAttemptErrorPydantic": { "properties": { "id": { "type": "integer", "title": "Id" }, "connector_credential_pair_id": { "type": "integer", "title": "Connector Credential Pair Id" }, "document_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Document Id" }, "document_link": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Document Link" }, "document_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Document Name" }, "entity_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entity Id" }, "failed_time_range_start": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Failed Time Range Start" }, "failed_time_range_end": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Failed Time Range End" }, "failure_message": { "type": "string", "title": "Failure Message" }, "is_resolved": { "type": "boolean", "title": "Is Resolved", "default": false }, "time_created": { "type": "string", "format": "date-time", "title": "Time Created" }, "index_attempt_id": { "type": "integer", "title": "Index Attempt Id" }, "error_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Type" } }, "type": "object", "required": [ "id", "connector_credential_pair_id", "document_id", "document_link", "entity_id", "failed_time_range_start", "failed_time_range_end", "failure_message", "time_created", "index_attempt_id" ], "title": "IndexAttemptErrorPydantic" }, "IndexAttemptSnapshot": { "properties": { "id": { "type": "integer", "title": "Id" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/IndexingStatus" }, { "type": "null" } ] }, "from_beginning": { "type": "boolean", "title": "From Beginning" }, "new_docs_indexed": { "type": "integer", "title": "New Docs Indexed" }, "total_docs_indexed": { "type": "integer", "title": "Total Docs Indexed" }, "docs_removed_from_index": { "type": "integer", "title": "Docs Removed From Index" }, "error_msg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Msg" }, "error_count": { "type": "integer", "title": "Error Count" }, "open_error_count": { "type": "integer", "title": "Open Error Count" }, "open_doc_error_count": { "type": "integer", "title": "Open Doc Error Count" }, "full_exception_trace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Full Exception Trace" }, "time_started": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Time Started" }, "time_updated": { "type": "string", "title": "Time Updated" }, "time_finished": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Time Finished" }, "poll_range_start": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Poll Range Start" }, "poll_range_end": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Poll Range End" }, "is_backfill": { "type": "boolean", "title": "Is Backfill", "default": false }, "is_new_model": { "type": "boolean", "title": "Is New Model", "default": false } }, "type": "object", "required": [ "id", "status", "from_beginning", "new_docs_indexed", "total_docs_indexed", "docs_removed_from_index", "error_msg", "error_count", "open_error_count", "open_doc_error_count", "full_exception_trace", "time_started", "time_updated", "time_finished" ], "title": "IndexAttemptSnapshot" }, "IndexedSourcesResponse": { "properties": { "sources": { "items": { "$ref": "#/components/schemas/DocumentSource" }, "type": "array", "title": "Sources" } }, "type": "object", "required": ["sources"], "title": "IndexedSourcesResponse" }, "IndexingHold": { "properties": { "reason": { "$ref": "#/components/schemas/IndexingHoldReason" }, "failed_checks": { "items": { "$ref": "#/components/schemas/HeldCheck" }, "type": "array", "title": "Failed Checks", "default": [] }, "index_attempt_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Index Attempt Id" } }, "type": "object", "required": ["reason"], "title": "IndexingHold", "description": "Why the pair's first index attempt does not start yet." }, "IndexingHoldReason": { "type": "string", "enum": [ "checks_running", "checks_failed_to_run", "required_checks_failed" ], "title": "IndexingHoldReason" }, "IndexingStatus": { "type": "string", "enum": [ "not_started", "in_progress", "success", "canceled", "interrupted", "failed", "completed_with_errors" ], "title": "IndexingStatus" }, "IndexingStatusRequest": { "properties": { "secondary_index": { "type": "boolean", "title": "Secondary Index", "default": false }, "source": { "anyOf": [ { "$ref": "#/components/schemas/DocumentSource" }, { "type": "null" } ] }, "access_type_filters": { "items": { "$ref": "#/components/schemas/AccessType" }, "type": "array", "title": "Access Type Filters" }, "last_status_filters": { "items": { "$ref": "#/components/schemas/IndexingStatus" }, "type": "array", "title": "Last Status Filters" }, "docs_count_operator": { "anyOf": [ { "$ref": "#/components/schemas/DocsCountOperator" }, { "type": "null" } ] }, "docs_count_value": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Docs Count Value" }, "name_filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name Filter" }, "source_to_page": { "additionalProperties": { "type": "integer" }, "propertyNames": { "$ref": "#/components/schemas/DocumentSource" }, "type": "object", "title": "Source To Page" }, "get_all_connectors": { "type": "boolean", "title": "Get All Connectors", "default": false } }, "type": "object", "title": "IndexingStatusRequest" }, "IngestionDocument": { "properties": { "document": { "$ref": "#/components/schemas/DocumentBase" }, "cc_pair_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Cc Pair Id" } }, "type": "object", "required": ["document"], "title": "IngestionDocument" }, "IngestionResult": { "properties": { "document_id": { "type": "string", "title": "Document Id" }, "already_existed": { "type": "boolean", "title": "Already Existed" } }, "type": "object", "required": ["document_id", "already_existed"], "title": "IngestionResult" }, "InputType": { "type": "string", "enum": ["load_state", "poll", "event", "slim_retrieval"], "title": "InputType" }, "IntermediateReportCitedDocs": { "properties": { "type": { "type": "string", "const": "intermediate_report_cited_docs", "title": "Type", "default": "intermediate_report_cited_docs" }, "cited_docs": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SearchDoc" }, "type": "array" }, { "type": "null" } ], "title": "Cited Docs" } }, "type": "object", "title": "IntermediateReportCitedDocs" }, "IntermediateReportDelta": { "properties": { "type": { "type": "string", "const": "intermediate_report_delta", "title": "Type", "default": "intermediate_report_delta" }, "content": { "type": "string", "title": "Content" } }, "type": "object", "required": ["content"], "title": "IntermediateReportDelta" }, "IntermediateReportStart": { "properties": { "type": { "type": "string", "const": "intermediate_report_start", "title": "Type", "default": "intermediate_report_start" } }, "type": "object", "title": "IntermediateReportStart" }, "InvitedUserSnapshot": { "properties": { "email": { "type": "string", "title": "Email" } }, "type": "object", "required": ["email"], "title": "InvitedUserSnapshot" }, "LLMOverride": { "properties": { "model_configuration_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Model Configuration Id" }, "model_provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Provider" }, "model_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Version" }, "temperature": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Temperature" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" } }, "type": "object", "title": "LLMOverride", "description": "Per-request LLM settings that override persona defaults.\n\nAll fields are optional \u2014 only the fields that differ from the persona's\nconfigured LLM need to be supplied. Used both over the wire (API requests)\nand for multi-model comparison, where one override is supplied per model.\n\nAttributes:\n model_configuration_id: Exact model configuration to use. Preferred\n over the name-based fields \u2014 provider display names are not\n unique, so only the id routes unambiguously.\n model_provider: LLM provider display name. When ``None``, the\n persona's default provider is used.\n model_version: Specific model version string (e.g. ``\"gpt-6-sol\"``).\n When ``None``, the persona's default model is used.\n temperature: Sampling temperature in ``[0, 2]``. When ``None``, the\n persona's default temperature is used.\n display_name: Human-readable label shown in the UI for this model,\n e.g. ``\"GPT-4 Turbo\"``. Optional; falls back to ``model_version``\n when not set." }, "LlmOpenUrlResult": { "properties": { "document_citation_number": { "type": "integer", "title": "Document Citation Number" }, "unique_identifier_to_strip_away": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unique Identifier To Strip Away" }, "type": { "type": "string", "const": "open_url", "title": "Type", "default": "open_url" }, "content": { "type": "string", "title": "Content" } }, "type": "object", "required": ["document_citation_number", "content"], "title": "LlmOpenUrlResult", "description": "Result from opening/fetching a URL" }, "LlmWebSearchResult": { "properties": { "document_citation_number": { "type": "integer", "title": "Document Citation Number" }, "unique_identifier_to_strip_away": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unique Identifier To Strip Away" }, "type": { "type": "string", "const": "web_search", "title": "Type", "default": "web_search" }, "url": { "type": "string", "title": "Url" }, "title": { "type": "string", "title": "Title" }, "snippet": { "type": "string", "title": "Snippet" } }, "type": "object", "required": ["document_citation_number", "url", "title", "snippet"], "title": "LlmWebSearchResult", "description": "Result from a web search query" }, "ManagedCCPairEntry": { "properties": { "cc_pair_id": { "type": "integer", "title": "Cc Pair Id" }, "role": { "$ref": "#/components/schemas/ConnectorManageRole", "default": "editor" } }, "type": "object", "required": ["cc_pair_id"], "title": "ManagedCCPairEntry" }, "MemoryItem": { "properties": { "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "content": { "type": "string", "title": "Content" } }, "type": "object", "required": ["content"], "title": "MemoryItem" }, "MemoryToolDelta": { "properties": { "type": { "type": "string", "const": "memory_tool_delta", "title": "Type", "default": "memory_tool_delta" }, "memory_text": { "type": "string", "title": "Memory Text" }, "operation": { "type": "string", "enum": ["add", "update"], "title": "Operation" }, "memory_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Memory Id" }, "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Index" } }, "type": "object", "required": ["memory_text", "operation"], "title": "MemoryToolDelta" }, "MemoryToolNoAccess": { "properties": { "type": { "type": "string", "const": "memory_tool_no_access", "title": "Type", "default": "memory_tool_no_access" } }, "type": "object", "title": "MemoryToolNoAccess" }, "MemoryToolStart": { "properties": { "type": { "type": "string", "const": "memory_tool_start", "title": "Type", "default": "memory_tool_start" } }, "type": "object", "title": "MemoryToolStart" }, "MessageOrigin": { "type": "string", "enum": [ "webapp", "chrome_extension", "api", "slackbot", "widget", "discordbot", "mobile", "unknown", "unset" ], "title": "MessageOrigin", "description": "Origin of a chat message for telemetry tracking." }, "MessageType": { "type": "string", "enum": [ "system", "user", "assistant", "summary", "tool_call_response", "user_reminder" ], "title": "MessageType" }, "MethodSpec": { "properties": { "name": { "type": "string", "title": "Name" }, "raw_name": { "type": "string", "title": "Raw Name" }, "summary": { "type": "string", "title": "Summary" }, "path": { "type": "string", "title": "Path" }, "method": { "type": "string", "title": "Method" }, "spec": { "additionalProperties": true, "type": "object", "title": "Spec" } }, "type": "object", "required": ["name", "raw_name", "summary", "path", "method", "spec"], "title": "MethodSpec" }, "MinimalPersonaSnapshot": { "properties": { "id": { "type": "integer", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "tools": { "items": { "$ref": "#/components/schemas/ToolSnapshot" }, "type": "array", "title": "Tools" }, "starter_messages": { "anyOf": [ { "items": { "$ref": "#/components/schemas/StarterMessage" }, "type": "array" }, { "type": "null" } ], "title": "Starter Messages" }, "document_sets": { "items": { "$ref": "#/components/schemas/DocumentSetSummary" }, "type": "array", "title": "Document Sets" }, "hierarchy_node_count": { "type": "integer", "title": "Hierarchy Node Count" }, "attached_document_count": { "type": "integer", "title": "Attached Document Count" }, "knowledge_sources": { "items": { "$ref": "#/components/schemas/DocumentSource" }, "type": "array", "title": "Knowledge Sources" }, "default_model_configuration_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Default Model Configuration Id" }, "uploaded_image_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Uploaded Image Id" }, "icon_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Icon Name" }, "is_public": { "type": "boolean", "title": "Is Public" }, "is_listed": { "type": "boolean", "title": "Is Listed" }, "display_priority": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Display Priority" }, "is_featured": { "type": "boolean", "title": "Is Featured" }, "builtin_persona": { "type": "boolean", "title": "Builtin Persona" }, "labels": { "items": { "$ref": "#/components/schemas/PersonaLabelSnapshot" }, "type": "array", "title": "Labels" }, "owner": { "anyOf": [ { "$ref": "#/components/schemas/MinimalUserSnapshot" }, { "type": "null" } ] }, "owner_group": { "anyOf": [ { "$ref": "#/components/schemas/PersonaOwnerGroupSnapshot" }, { "type": "null" } ] }, "user_permission": { "anyOf": [ { "$ref": "#/components/schemas/PersonaAccessLevel" }, { "type": "null" } ] }, "permissions": { "additionalProperties": { "type": "boolean" }, "type": "object", "title": "Permissions" } }, "type": "object", "required": [ "id", "name", "description", "tools", "starter_messages", "document_sets", "hierarchy_node_count", "attached_document_count", "knowledge_sources", "default_model_configuration_id", "uploaded_image_id", "icon_name", "is_public", "is_listed", "display_priority", "is_featured", "builtin_persona", "labels", "owner", "owner_group" ], "title": "MinimalPersonaSnapshot", "description": "Minimal persona model optimized for ChatPage.tsx - only includes fields actually used" }, "MinimalUserGroupSnapshot": { "properties": { "id": { "type": "integer", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "is_default": { "type": "boolean", "title": "Is Default" } }, "type": "object", "required": ["id", "name", "is_default"], "title": "MinimalUserGroupSnapshot" }, "MinimalUserSnapshot": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "email": { "type": "string", "title": "Email" } }, "type": "object", "required": ["id", "email"], "title": "MinimalUserSnapshot" }, "ModelPrice": { "properties": { "model": { "type": "string", "title": "Model" }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" }, "model_configuration_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Model Configuration Id" }, "input_per_mtok": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Input Per Mtok" }, "output_per_mtok": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Output Per Mtok" }, "cache_per_mtok": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cache Per Mtok" }, "cache_write_per_mtok": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cache Write Per Mtok" } }, "type": "object", "required": [ "model", "provider", "input_per_mtok", "output_per_mtok", "cache_per_mtok" ], "title": "ModelPrice" }, "ObjectCreationIdResponse": { "properties": { "id": { "type": "integer", "title": "Id" }, "credential": { "anyOf": [ { "$ref": "#/components/schemas/CredentialSnapshot" }, { "type": "null" } ] } }, "type": "object", "required": ["id"], "title": "ObjectCreationIdResponse" }, "OnyxbotAnalyticsResponse": { "properties": { "total_queries": { "type": "integer", "title": "Total Queries" }, "auto_resolved": { "type": "integer", "title": "Auto Resolved" }, "date": { "type": "string", "format": "date", "title": "Date" } }, "type": "object", "required": ["total_queries", "auto_resolved", "date"], "title": "OnyxbotAnalyticsResponse" }, "OpenUrlDocuments": { "properties": { "type": { "type": "string", "const": "open_url_documents", "title": "Type", "default": "open_url_documents" }, "documents": { "items": { "$ref": "#/components/schemas/SearchDoc" }, "type": "array", "title": "Documents" } }, "type": "object", "required": ["documents"], "title": "OpenUrlDocuments", "description": "Final documents after crawling completes." }, "OpenUrlStart": { "properties": { "type": { "type": "string", "const": "open_url_start", "title": "Type", "default": "open_url_start" } }, "type": "object", "title": "OpenUrlStart", "description": "Signal that OpenURL tool has started." }, "OpenUrlUrls": { "properties": { "type": { "type": "string", "const": "open_url_urls", "title": "Type", "default": "open_url_urls" }, "urls": { "items": { "type": "string" }, "type": "array", "title": "Urls" } }, "type": "object", "required": ["urls"], "title": "OpenUrlUrls", "description": "URLs to be fetched (sent before crawling begins)." }, "OpenUrlsToolRequest": { "properties": { "urls": { "items": { "type": "string" }, "type": "array", "maxItems": 20, "minItems": 1, "title": "Urls", "description": "URLs to fetch using the configured content provider." } }, "type": "object", "required": ["urls"], "title": "OpenUrlsToolRequest" }, "OpenUrlsToolResponse": { "properties": { "results": { "items": { "$ref": "#/components/schemas/LlmOpenUrlResult" }, "type": "array", "title": "Results" }, "provider_type": { "anyOf": [ { "$ref": "#/components/schemas/WebContentProviderType" }, { "type": "null" } ] } }, "type": "object", "required": ["results"], "title": "OpenUrlsToolResponse" }, "OverallStop": { "properties": { "type": { "type": "string", "const": "stop", "title": "Type", "default": "stop" }, "stop_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stop Reason" } }, "type": "object", "title": "OverallStop" }, "Packet": { "properties": { "placement": { "$ref": "#/components/schemas/Placement" }, "obj": { "oneOf": [ { "$ref": "#/components/schemas/OverallStop" }, { "$ref": "#/components/schemas/SectionEnd" }, { "$ref": "#/components/schemas/PacketException" }, { "$ref": "#/components/schemas/ChatHeartbeat" }, { "$ref": "#/components/schemas/AgentResponseStart" }, { "$ref": "#/components/schemas/AgentResponseDelta" }, { "$ref": "#/components/schemas/SearchToolStart" }, { "$ref": "#/components/schemas/SearchToolQueriesDelta" }, { "$ref": "#/components/schemas/SearchToolFilterDelta" }, { "$ref": "#/components/schemas/SearchToolDocumentsDelta" }, { "$ref": "#/components/schemas/ImageGenerationToolStart" }, { "$ref": "#/components/schemas/ImageGenerationToolHeartbeat" }, { "$ref": "#/components/schemas/ImageGenerationFinal" }, { "$ref": "#/components/schemas/OpenUrlStart" }, { "$ref": "#/components/schemas/OpenUrlUrls" }, { "$ref": "#/components/schemas/OpenUrlDocuments" }, { "$ref": "#/components/schemas/PythonToolStart" }, { "$ref": "#/components/schemas/PythonToolDelta" }, { "$ref": "#/components/schemas/CustomToolStart" }, { "$ref": "#/components/schemas/CustomToolArgs" }, { "$ref": "#/components/schemas/CustomToolDelta" }, { "$ref": "#/components/schemas/FileReaderStart" }, { "$ref": "#/components/schemas/FileReaderResult" }, { "$ref": "#/components/schemas/MemoryToolStart" }, { "$ref": "#/components/schemas/MemoryToolDelta" }, { "$ref": "#/components/schemas/MemoryToolNoAccess" }, { "$ref": "#/components/schemas/ReasoningStart" }, { "$ref": "#/components/schemas/ReasoningDelta" }, { "$ref": "#/components/schemas/ReasoningDone" }, { "$ref": "#/components/schemas/CitationInfo" }, { "$ref": "#/components/schemas/ToolCallDebug" }, { "$ref": "#/components/schemas/ToolCallArgumentDelta" }, { "$ref": "#/components/schemas/DeepResearchPlanStart" }, { "$ref": "#/components/schemas/DeepResearchPlanDelta" }, { "$ref": "#/components/schemas/ResearchAgentStart" }, { "$ref": "#/components/schemas/IntermediateReportStart" }, { "$ref": "#/components/schemas/IntermediateReportDelta" }, { "$ref": "#/components/schemas/IntermediateReportCitedDocs" }, { "$ref": "#/components/schemas/CodingAgentStart" }, { "$ref": "#/components/schemas/CodingAgentThinkingDelta" }, { "$ref": "#/components/schemas/CodingAgentFinal" }, { "$ref": "#/components/schemas/BashToolStart" }, { "$ref": "#/components/schemas/BashToolDelta" } ], "title": "Obj", "discriminator": { "propertyName": "type", "mapping": { "bash_tool_delta": "#/components/schemas/BashToolDelta", "bash_tool_start": "#/components/schemas/BashToolStart", "chat_heartbeat": "#/components/schemas/ChatHeartbeat", "citation_info": "#/components/schemas/CitationInfo", "coding_agent_final": "#/components/schemas/CodingAgentFinal", "coding_agent_start": "#/components/schemas/CodingAgentStart", "coding_agent_thinking_delta": "#/components/schemas/CodingAgentThinkingDelta", "custom_tool_args": "#/components/schemas/CustomToolArgs", "custom_tool_delta": "#/components/schemas/CustomToolDelta", "custom_tool_start": "#/components/schemas/CustomToolStart", "deep_research_plan_delta": "#/components/schemas/DeepResearchPlanDelta", "deep_research_plan_start": "#/components/schemas/DeepResearchPlanStart", "error": "#/components/schemas/PacketException", "file_reader_result": "#/components/schemas/FileReaderResult", "file_reader_start": "#/components/schemas/FileReaderStart", "image_generation_final": "#/components/schemas/ImageGenerationFinal", "image_generation_heartbeat": "#/components/schemas/ImageGenerationToolHeartbeat", "image_generation_start": "#/components/schemas/ImageGenerationToolStart", "intermediate_report_cited_docs": "#/components/schemas/IntermediateReportCitedDocs", "intermediate_report_delta": "#/components/schemas/IntermediateReportDelta", "intermediate_report_start": "#/components/schemas/IntermediateReportStart", "memory_tool_delta": "#/components/schemas/MemoryToolDelta", "memory_tool_no_access": "#/components/schemas/MemoryToolNoAccess", "memory_tool_start": "#/components/schemas/MemoryToolStart", "message_delta": "#/components/schemas/AgentResponseDelta", "message_start": "#/components/schemas/AgentResponseStart", "open_url_documents": "#/components/schemas/OpenUrlDocuments", "open_url_start": "#/components/schemas/OpenUrlStart", "open_url_urls": "#/components/schemas/OpenUrlUrls", "python_tool_delta": "#/components/schemas/PythonToolDelta", "python_tool_start": "#/components/schemas/PythonToolStart", "reasoning_delta": "#/components/schemas/ReasoningDelta", "reasoning_done": "#/components/schemas/ReasoningDone", "reasoning_start": "#/components/schemas/ReasoningStart", "research_agent_start": "#/components/schemas/ResearchAgentStart", "search_tool_documents_delta": "#/components/schemas/SearchToolDocumentsDelta", "search_tool_filter_delta": "#/components/schemas/SearchToolFilterDelta", "search_tool_queries_delta": "#/components/schemas/SearchToolQueriesDelta", "search_tool_start": "#/components/schemas/SearchToolStart", "section_end": "#/components/schemas/SectionEnd", "stop": "#/components/schemas/OverallStop", "tool_call_argument_delta": "#/components/schemas/ToolCallArgumentDelta", "tool_call_debug": "#/components/schemas/ToolCallDebug" } } } }, "type": "object", "required": ["placement", "obj"], "title": "Packet" }, "PacketException": { "properties": { "type": { "type": "string", "const": "error", "title": "Type", "default": "error" } }, "type": "object", "title": "PacketException" }, "PaginatedReturn_FullUserSnapshot_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/FullUserSnapshot" }, "type": "array", "title": "Items" }, "total_items": { "type": "integer", "title": "Total Items" } }, "type": "object", "required": ["items", "total_items"], "title": "PaginatedReturn[FullUserSnapshot]" }, "PaginatedReturn_IndexAttemptErrorPydantic_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/IndexAttemptErrorPydantic" }, "type": "array", "title": "Items" }, "total_items": { "type": "integer", "title": "Total Items" } }, "type": "object", "required": ["items", "total_items"], "title": "PaginatedReturn[IndexAttemptErrorPydantic]" }, "PaginatedReturn_IndexAttemptSnapshot_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/IndexAttemptSnapshot" }, "type": "array", "title": "Items" }, "total_items": { "type": "integer", "title": "Total Items" } }, "type": "object", "required": ["items", "total_items"], "title": "PaginatedReturn[IndexAttemptSnapshot]" }, "PaginatedReturn_MinimalPersonaSnapshot_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/MinimalPersonaSnapshot" }, "type": "array", "title": "Items" }, "total_items": { "type": "integer", "title": "Total Items" } }, "type": "object", "required": ["items", "total_items"], "title": "PaginatedReturn[MinimalPersonaSnapshot]" }, "PaginatedReturn_PersonaSnapshot_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/PersonaSnapshot" }, "type": "array", "title": "Items" }, "total_items": { "type": "integer", "title": "Total Items" } }, "type": "object", "required": ["items", "total_items"], "title": "PaginatedReturn[PersonaSnapshot]" }, "PendingBackfillSnapshot": { "properties": { "window_start": { "type": "string", "format": "date-time", "title": "Window Start" }, "window_end": { "type": "string", "format": "date-time", "title": "Window End" }, "requested_at": { "type": "string", "format": "date-time", "title": "Requested At" }, "scoped": { "type": "boolean", "title": "Scoped" }, "attempt_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Attempt Id" }, "failure_count": { "type": "integer", "title": "Failure Count" }, "retry_after": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Retry After" } }, "type": "object", "required": [ "window_start", "window_end", "requested_at", "scoped", "attempt_id", "failure_count", "retry_after" ], "title": "PendingBackfillSnapshot", "description": "A backfill an applied edit requested, until an attempt of it succeeds.\nThe beat retries a failed one after ``retry_after``." }, "Permission": { "type": "string", "enum": [ "basic", "read:connectors", "read:document_sets", "read:agents", "read:users", "read:user_groups", "read:search", "read:chat", "write:chat", "read:admin", "generate:image", "use:llm_gateway", "add:agents", "manage:agents", "manage:document_sets", "manage:connectors", "manage:llms", "read:agent_analytics", "manage:actions", "manage:skills", "read:query_history", "manage:user_groups", "create:user_api_keys", "manage:service_account_api_keys", "manage:bots", "craft_sandbox", "admin" ], "title": "Permission", "description": "Permission tokens for group-based authorization and PAT scoping.\nfull_admin_panel_access is an override \u2014 if present, any permission\ncheck passes.\n\nThe read:*/write:* \"API-surface scopes\" are coarser than the capability\ntokens: they name request surfaces (search, chat, admin-read) rather than\nadmin capabilities. They are implied by basic / admin (so they're never\ngranted directly to a group) and exist primarily to scope Personal Access\nTokens." }, "PermissionRegistryEntry": { "properties": { "id": { "type": "string", "title": "Id" }, "display_name": { "type": "string", "title": "Display Name" }, "description": { "type": "string", "title": "Description" }, "permissions": { "items": { "$ref": "#/components/schemas/Permission" }, "type": "array", "title": "Permissions" }, "group": { "type": "integer", "title": "Group" }, "default_group_toggleable": { "type": "boolean", "title": "Default Group Toggleable", "description": "Whether the row is offered on the Basic group's page.", "readOnly": true } }, "type": "object", "required": [ "id", "display_name", "description", "permissions", "group", "default_group_toggleable" ], "title": "PermissionRegistryEntry", "description": "A UI-facing permission row served by GET /admin/permissions/registry.\n\nThe field_validator ensures non-toggleable permissions (BASIC_ACCESS,\nFULL_ADMIN_PANEL_ACCESS, READ_*) can never appear in the registry." }, "PermissionSyncStatus": { "type": "string", "enum": [ "not_started", "in_progress", "success", "canceled", "failed", "completed_with_errors" ], "title": "PermissionSyncStatus", "description": "Status enum for permission sync attempts" }, "PersonaAccessLevel": { "type": "string", "enum": ["OWNER", "EDITOR", "VIEWER"], "title": "PersonaAccessLevel", "description": "Computed access the requesting user holds on a persona.\n\nOWNER outranks share rows; admins are reported as EDITOR unless owner." }, "PersonaGroupShare": { "properties": { "group_id": { "type": "integer", "title": "Group Id" }, "group_name": { "type": "string", "title": "Group Name" }, "permission": { "$ref": "#/components/schemas/PersonaSharePermission" } }, "type": "object", "required": ["group_id", "group_name", "permission"], "title": "PersonaGroupShare" }, "PersonaLabelSnapshot": { "properties": { "id": { "type": "integer", "title": "Id" }, "name": { "type": "string", "title": "Name" } }, "type": "object", "required": ["id", "name"], "title": "PersonaLabelSnapshot" }, "PersonaMessageAnalyticsResponse": { "properties": { "total_messages": { "type": "integer", "title": "Total Messages" }, "date": { "type": "string", "format": "date", "title": "Date" }, "persona_id": { "type": "integer", "title": "Persona Id" } }, "type": "object", "required": ["total_messages", "date", "persona_id"], "title": "PersonaMessageAnalyticsResponse" }, "PersonaOwnerGroupSnapshot": { "properties": { "id": { "type": "integer", "title": "Id" }, "name": { "type": "string", "title": "Name" } }, "type": "object", "required": ["id", "name"], "title": "PersonaOwnerGroupSnapshot" }, "PersonaSharePermission": { "type": "string", "enum": ["EDITOR", "VIEWER"], "title": "PersonaSharePermission", "description": "Level granted by a persona share row (user or group), or to the whole\norg via `Persona.public_permission`." }, "PersonaSharingStatus": { "type": "string", "enum": ["PRIVATE", "SHARED", "PUBLIC"], "title": "PersonaSharingStatus", "description": "Derived share state computed from a persona's columns by the sharing\nhelpers (no DB column of its own): group-owned or row-shared counts as\nSHARED even with an empty share list; PUBLIC wins over both." }, "PersonaSnapshot": { "properties": { "id": { "type": "integer", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "is_public": { "type": "boolean", "title": "Is Public" }, "is_listed": { "type": "boolean", "title": "Is Listed" }, "uploaded_image_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Uploaded Image Id" }, "icon_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Icon Name" }, "user_file_ids": { "items": { "type": "string" }, "type": "array", "title": "User File Ids" }, "display_priority": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Display Priority" }, "is_featured": { "type": "boolean", "title": "Is Featured" }, "builtin_persona": { "type": "boolean", "title": "Builtin Persona" }, "starter_messages": { "anyOf": [ { "items": { "$ref": "#/components/schemas/StarterMessage" }, "type": "array" }, { "type": "null" } ], "title": "Starter Messages" }, "tools": { "items": { "$ref": "#/components/schemas/ToolSnapshot" }, "type": "array", "title": "Tools" }, "labels": { "items": { "$ref": "#/components/schemas/PersonaLabelSnapshot" }, "type": "array", "title": "Labels" }, "owner": { "anyOf": [ { "$ref": "#/components/schemas/MinimalUserSnapshot" }, { "type": "null" } ] }, "owner_group": { "anyOf": [ { "$ref": "#/components/schemas/PersonaOwnerGroupSnapshot" }, { "type": "null" } ] }, "users": { "items": { "$ref": "#/components/schemas/MinimalUserSnapshot" }, "type": "array", "title": "Users" }, "groups": { "items": { "type": "integer" }, "type": "array", "title": "Groups" }, "user_shares": { "items": { "$ref": "#/components/schemas/PersonaUserShare" }, "type": "array", "title": "User Shares" }, "group_shares": { "items": { "$ref": "#/components/schemas/PersonaGroupShare" }, "type": "array", "title": "Group Shares" }, "public_permission": { "$ref": "#/components/schemas/PersonaSharePermission" }, "sharing_status": { "$ref": "#/components/schemas/PersonaSharingStatus" }, "document_sets": { "items": { "$ref": "#/components/schemas/DocumentSetSummary" }, "type": "array", "title": "Document Sets" }, "default_model_configuration_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Default Model Configuration Id" }, "hierarchy_nodes": { "items": { "$ref": "#/components/schemas/HierarchyNodeSnapshot" }, "type": "array", "title": "Hierarchy Nodes" }, "attached_documents": { "items": { "$ref": "#/components/schemas/AttachedDocumentSnapshot" }, "type": "array", "title": "Attached Documents" }, "permissions": { "additionalProperties": { "type": "boolean" }, "type": "object", "title": "Permissions" }, "system_prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "System Prompt" }, "replace_base_system_prompt": { "type": "boolean", "title": "Replace Base System Prompt", "default": false }, "task_prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Task Prompt" }, "datetime_aware": { "type": "boolean", "title": "Datetime Aware", "default": true } }, "type": "object", "required": [ "id", "name", "description", "is_public", "is_listed", "uploaded_image_id", "icon_name", "user_file_ids", "display_priority", "is_featured", "builtin_persona", "starter_messages", "tools", "labels", "owner", "owner_group", "users", "groups", "user_shares", "group_shares", "public_permission", "sharing_status", "document_sets" ], "title": "PersonaSnapshot" }, "PersonaUniqueUsersResponse": { "properties": { "unique_users": { "type": "integer", "title": "Unique Users" }, "date": { "type": "string", "format": "date", "title": "Date" }, "persona_id": { "type": "integer", "title": "Persona Id" } }, "type": "object", "required": ["unique_users", "date", "persona_id"], "title": "PersonaUniqueUsersResponse" }, "PersonaUpsertRequest": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "document_set_ids": { "items": { "type": "integer" }, "type": "array", "title": "Document Set Ids" }, "is_public": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Public" }, "default_model_configuration_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Default Model Configuration Id" }, "starter_messages": { "anyOf": [ { "items": { "$ref": "#/components/schemas/StarterMessage" }, "type": "array" }, { "type": "null" } ], "title": "Starter Messages" }, "users": { "anyOf": [ { "items": { "type": "string", "format": "uuid" }, "type": "array" }, { "type": "null" } ], "title": "Users" }, "groups": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Groups" }, "tool_ids": { "items": { "type": "integer" }, "type": "array", "title": "Tool Ids" }, "remove_image": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Remove Image" }, "uploaded_image_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Uploaded Image Id" }, "icon_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Icon Name" }, "search_start_date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Search Start Date" }, "label_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Label Ids" }, "is_featured": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Featured" }, "display_priority": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Display Priority" }, "user_file_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "User File Ids" }, "hierarchy_node_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Hierarchy Node Ids" }, "document_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Document Ids" }, "system_prompt": { "type": "string", "title": "System Prompt" }, "replace_base_system_prompt": { "type": "boolean", "title": "Replace Base System Prompt", "default": false }, "task_prompt": { "type": "string", "title": "Task Prompt" }, "datetime_aware": { "type": "boolean", "title": "Datetime Aware" } }, "type": "object", "required": [ "name", "description", "document_set_ids", "tool_ids", "system_prompt", "task_prompt", "datetime_aware" ], "title": "PersonaUpsertRequest" }, "PersonaUserShare": { "properties": { "user": { "$ref": "#/components/schemas/MinimalUserSnapshot" }, "permission": { "$ref": "#/components/schemas/PersonaSharePermission" } }, "type": "object", "required": ["user", "permission"], "title": "PersonaUserShare" }, "Placement": { "properties": { "turn_index": { "type": "integer", "title": "Turn Index" }, "tab_index": { "type": "integer", "title": "Tab Index", "default": 0 }, "sub_turn_index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sub Turn Index" }, "model_index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Model Index" } }, "type": "object", "required": ["turn_index"], "title": "Placement", "description": "Coordinates that identify where a streaming packet belongs in the UI.\n\nThe frontend uses these fields to route each packet to the correct turn,\ntool tab, agent sub-turn, and (in multi-model mode) response column.\n\nAttributes:\n turn_index: Monotonically increasing index of the iterative reasoning block\n (e.g. tool call round) within this chat message. Lower values happened first.\n tab_index: Disambiguates parallel tool calls within the same turn so each\n tool's output can be displayed in its own tab.\n sub_turn_index: Nesting level for tools that invoke other tools. ``None`` for\n top-level packets; an integer for tool-within-tool output.\n model_index: Which model this packet belongs to. ``0`` for single-model\n responses; ``0``, ``1``, or ``2`` for multi-model comparison. ``None``\n for pre-LLM setup packets (e.g. message ID info) that are yielded\n before any Emitter runs." }, "ProcessingMode": { "type": "string", "enum": ["REGULAR", "FILE_SYSTEM", "RAW_BINARY"], "title": "ProcessingMode", "description": "Determines how documents are processed after fetching." }, "ProjectInstructionsResponse": { "properties": { "instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instructions" } }, "type": "object", "required": ["instructions"], "title": "ProjectInstructionsResponse" }, "ProjectPayload": { "properties": { "project": { "$ref": "#/components/schemas/UserProjectSnapshot" }, "files": { "anyOf": [ { "items": { "$ref": "#/components/schemas/UserFileSnapshot" }, "type": "array" }, { "type": "null" } ], "title": "Files" }, "persona_id_to_is_featured": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" } ], "title": "Persona Id To Is Featured" } }, "type": "object", "required": ["project"], "title": "ProjectPayload" }, "PythonToolDelta": { "properties": { "type": { "type": "string", "const": "python_tool_delta", "title": "Type", "default": "python_tool_delta" }, "stdout": { "type": "string", "title": "Stdout", "default": "" }, "stderr": { "type": "string", "title": "Stderr", "default": "" }, "file_ids": { "items": { "type": "string" }, "type": "array", "title": "File Ids", "default": [] } }, "type": "object", "title": "PythonToolDelta" }, "PythonToolStart": { "properties": { "type": { "type": "string", "const": "python_tool_start", "title": "Type", "default": "python_tool_start" }, "code": { "type": "string", "title": "Code" } }, "type": "object", "required": ["code"], "title": "PythonToolStart" }, "QueryAnalyticsResponse": { "properties": { "total_queries": { "type": "integer", "title": "Total Queries" }, "total_likes": { "type": "integer", "title": "Total Likes" }, "total_dislikes": { "type": "integer", "title": "Total Dislikes" }, "date": { "type": "string", "format": "date", "title": "Date" } }, "type": "object", "required": ["total_queries", "total_likes", "total_dislikes", "date"], "title": "QueryAnalyticsResponse" }, "ReasoningDelta": { "properties": { "type": { "type": "string", "const": "reasoning_delta", "title": "Type", "default": "reasoning_delta" }, "reasoning": { "type": "string", "title": "Reasoning" } }, "type": "object", "required": ["reasoning"], "title": "ReasoningDelta" }, "ReasoningDone": { "properties": { "type": { "type": "string", "const": "reasoning_done", "title": "Type", "default": "reasoning_done" } }, "type": "object", "title": "ReasoningDone" }, "ReasoningEffort": { "type": "string", "enum": ["auto", "off", "low", "medium", "high", "xhigh"], "title": "ReasoningEffort", "description": "Reasoning effort levels for models that support extended thinking.\n\nDifferent providers map these values differently:\n- OpenAI: Uses \"low\", \"medium\", \"high\" directly for reasoning_effort. Recently added \"none\" for 5 series\n which is like \"minimal\"\n- Claude: Uses budget_tokens with different values for each level\n- Gemini: Uses \"none\", \"low\", \"medium\", \"high\" for thinking_budget (via litellm mapping)" }, "ReasoningStart": { "properties": { "type": { "type": "string", "const": "reasoning_start", "title": "Type", "default": "reasoning_start" } }, "type": "object", "title": "ReasoningStart" }, "RejectedFile": { "properties": { "file_name": { "type": "string", "title": "File Name" }, "reason": { "type": "string", "title": "Reason" } }, "type": "object", "required": ["file_name", "reason"], "title": "RejectedFile" }, "ResearchAgentStart": { "properties": { "type": { "type": "string", "const": "research_agent_start", "title": "Type", "default": "research_agent_start" }, "research_task": { "type": "string", "title": "Research Task" } }, "type": "object", "required": ["research_task"], "title": "ResearchAgentStart" }, "ResetUsageRequest": { "properties": { "user_email": { "type": "string", "minLength": 1, "title": "User Email" } }, "type": "object", "required": ["user_email"], "title": "ResetUsageRequest" }, "ResetUsageResponse": { "properties": { "reset_rows": { "type": "integer", "minimum": 0.0, "title": "Reset Rows" } }, "type": "object", "required": ["reset_rows"], "title": "ResetUsageResponse" }, "RunConnectorRequest": { "properties": { "connector_id": { "type": "integer", "title": "Connector Id" }, "credential_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Credential Ids" }, "from_beginning": { "type": "boolean", "title": "From Beginning", "default": false } }, "type": "object", "required": ["connector_id"], "title": "RunConnectorRequest" }, "SSOProviderOption": { "properties": { "name": { "type": "string", "title": "Name" }, "display_name": { "type": "string", "title": "Display Name" }, "provider_type": { "$ref": "#/components/schemas/SSOProviderType" }, "authorize_url": { "type": "string", "title": "Authorize Url" } }, "type": "object", "required": ["name", "display_name", "provider_type", "authorize_url"], "title": "SSOProviderOption" }, "SSOProviderType": { "type": "string", "enum": ["GOOGLE_OAUTH", "OIDC", "SAML"], "title": "SSOProviderType" }, "SavedSearchDoc": { "properties": { "document_id": { "type": "string", "title": "Document Id" }, "chunk_ind": { "type": "integer", "title": "Chunk Ind" }, "semantic_identifier": { "type": "string", "title": "Semantic Identifier" }, "link": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Link" }, "blurb": { "type": "string", "title": "Blurb" }, "source_type": { "$ref": "#/components/schemas/DocumentSource" }, "boost": { "type": "integer", "title": "Boost" }, "hidden": { "type": "boolean", "title": "Hidden" }, "metadata": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "type": "object", "title": "Metadata" }, "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Score", "default": 0.0 }, "is_relevant": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Relevant" }, "relevance_explanation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Relevance Explanation" }, "match_highlights": { "items": { "type": "string" }, "type": "array", "title": "Match Highlights" }, "source_types": { "anyOf": [ { "items": { "$ref": "#/components/schemas/DocumentSource" }, "type": "array" }, { "type": "null" } ], "title": "Source Types" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "primary_owners": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Primary Owners" }, "secondary_owners": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Secondary Owners" }, "is_internet": { "type": "boolean", "title": "Is Internet", "default": false }, "file_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Id" }, "db_doc_id": { "type": "integer", "title": "Db Doc Id" } }, "type": "object", "required": [ "document_id", "chunk_ind", "semantic_identifier", "blurb", "source_type", "boost", "hidden", "metadata", "match_highlights", "db_doc_id" ], "title": "SavedSearchDoc" }, "SearchDoc": { "properties": { "document_id": { "type": "string", "title": "Document Id" }, "chunk_ind": { "type": "integer", "title": "Chunk Ind" }, "semantic_identifier": { "type": "string", "title": "Semantic Identifier" }, "link": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Link" }, "blurb": { "type": "string", "title": "Blurb" }, "source_type": { "$ref": "#/components/schemas/DocumentSource" }, "boost": { "type": "integer", "title": "Boost" }, "hidden": { "type": "boolean", "title": "Hidden" }, "metadata": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "type": "object", "title": "Metadata" }, "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Score" }, "is_relevant": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Relevant" }, "relevance_explanation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Relevance Explanation" }, "match_highlights": { "items": { "type": "string" }, "type": "array", "title": "Match Highlights" }, "source_types": { "anyOf": [ { "items": { "$ref": "#/components/schemas/DocumentSource" }, "type": "array" }, { "type": "null" } ], "title": "Source Types" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "primary_owners": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Primary Owners" }, "secondary_owners": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Secondary Owners" }, "is_internet": { "type": "boolean", "title": "Is Internet", "default": false }, "file_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Id" } }, "type": "object", "required": [ "document_id", "chunk_ind", "semantic_identifier", "blurb", "source_type", "boost", "hidden", "metadata", "match_highlights" ], "title": "SearchDoc" }, "SearchDocWithContent": { "properties": { "document_id": { "type": "string", "title": "Document Id" }, "chunk_ind": { "type": "integer", "title": "Chunk Ind" }, "semantic_identifier": { "type": "string", "title": "Semantic Identifier" }, "link": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Link" }, "blurb": { "type": "string", "title": "Blurb" }, "source_type": { "$ref": "#/components/schemas/DocumentSource" }, "boost": { "type": "integer", "title": "Boost" }, "hidden": { "type": "boolean", "title": "Hidden" }, "metadata": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "type": "object", "title": "Metadata" }, "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Score" }, "is_relevant": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Relevant" }, "relevance_explanation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Relevance Explanation" }, "match_highlights": { "items": { "type": "string" }, "type": "array", "title": "Match Highlights" }, "source_types": { "anyOf": [ { "items": { "$ref": "#/components/schemas/DocumentSource" }, "type": "array" }, { "type": "null" } ], "title": "Source Types" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "primary_owners": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Primary Owners" }, "secondary_owners": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Secondary Owners" }, "is_internet": { "type": "boolean", "title": "Is Internet", "default": false }, "file_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Id" }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content" } }, "type": "object", "required": [ "document_id", "chunk_ind", "semantic_identifier", "blurb", "source_type", "boost", "hidden", "metadata", "match_highlights", "content" ], "title": "SearchDocWithContent" }, "SearchFlowClassificationRequest": { "properties": { "user_query": { "type": "string", "title": "User Query" } }, "type": "object", "required": ["user_query"], "title": "SearchFlowClassificationRequest" }, "SearchFlowClassificationResponse": { "properties": { "is_search_flow": { "type": "boolean", "title": "Is Search Flow" } }, "type": "object", "required": ["is_search_flow"], "title": "SearchFlowClassificationResponse" }, "SearchFullResponse": { "properties": { "all_executed_queries": { "items": { "type": "string" }, "type": "array", "title": "All Executed Queries" }, "search_docs": { "items": { "$ref": "#/components/schemas/SearchDocWithContent" }, "type": "array", "title": "Search Docs" }, "doc_selection_reasoning": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Doc Selection Reasoning" }, "llm_selected_doc_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Llm Selected Doc Ids" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" } }, "type": "object", "required": ["all_executed_queries", "search_docs"], "title": "SearchFullResponse" }, "SearchHistoryResponse": { "properties": { "search_queries": { "items": { "$ref": "#/components/schemas/SearchQueryResponse" }, "type": "array", "title": "Search Queries" } }, "type": "object", "required": ["search_queries"], "title": "SearchHistoryResponse" }, "SearchQueryResponse": { "properties": { "query": { "type": "string", "title": "Query" }, "query_expansions": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Query Expansions" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": ["query", "query_expansions", "created_at"], "title": "SearchQueryResponse" }, "SearchRequest": { "properties": { "query": { "type": "string", "maxLength": 2048, "minLength": 1, "title": "Query" }, "sources": { "anyOf": [ { "items": { "$ref": "#/components/schemas/DocumentSource" }, "type": "array" }, { "type": "null" } ], "title": "Sources" }, "document_sets": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Document Sets" }, "tags": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Tag" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "time_cutoff": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Time Cutoff" }, "persona_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Persona Id" }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" }, "skip_query_expansion": { "type": "boolean", "title": "Skip Query Expansion", "default": false }, "message_history": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ChatMinimalTextMessage" }, "type": "array" }, { "type": "null" } ], "title": "Message History" } }, "type": "object", "required": ["query"], "title": "SearchRequest" }, "SearchResponse": { "properties": { "results": { "items": { "$ref": "#/components/schemas/SearchResult" }, "type": "array", "title": "Results" } }, "type": "object", "required": ["results"], "title": "SearchResponse" }, "SearchResult": { "properties": { "citation_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Citation Id" }, "title": { "type": "string", "title": "Title" }, "content": { "type": "string", "title": "Content" }, "link": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Link" }, "source_type": { "type": "string", "title": "Source Type" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "required": [ "citation_id", "title", "content", "link", "source_type", "updated_at" ], "title": "SearchResult" }, "SearchToolDocumentsDelta": { "properties": { "type": { "type": "string", "const": "search_tool_documents_delta", "title": "Type", "default": "search_tool_documents_delta" }, "documents": { "items": { "$ref": "#/components/schemas/SearchDoc" }, "type": "array", "title": "Documents" } }, "type": "object", "required": ["documents"], "title": "SearchToolDocumentsDelta" }, "SearchToolFilterDelta": { "properties": { "type": { "type": "string", "const": "search_tool_filter_delta", "title": "Type", "default": "search_tool_filter_delta" }, "sources": { "items": { "type": "string" }, "type": "array", "title": "Sources", "default": [] }, "time_filter_start": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Time Filter Start" }, "time_filter_end": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Time Filter End" } }, "type": "object", "title": "SearchToolFilterDelta" }, "SearchToolQueriesDelta": { "properties": { "type": { "type": "string", "const": "search_tool_queries_delta", "title": "Type", "default": "search_tool_queries_delta" }, "queries": { "items": { "type": "string" }, "type": "array", "title": "Queries" } }, "type": "object", "required": ["queries"], "title": "SearchToolQueriesDelta" }, "SearchToolStart": { "properties": { "type": { "type": "string", "const": "search_tool_start", "title": "Type", "default": "search_tool_start" }, "is_internet_search": { "type": "boolean", "title": "Is Internet Search", "default": false } }, "type": "object", "title": "SearchToolStart" }, "SectionEnd": { "properties": { "type": { "type": "string", "const": "section_end", "title": "Type", "default": "section_end" } }, "type": "object", "title": "SectionEnd" }, "SendMessageRequest": { "properties": { "message": { "type": "string", "title": "Message" }, "llm_override": { "anyOf": [ { "$ref": "#/components/schemas/LLMOverride" }, { "type": "null" } ] }, "llm_overrides": { "anyOf": [ { "items": { "$ref": "#/components/schemas/LLMOverride" }, "type": "array" }, { "type": "null" } ], "title": "Llm Overrides" }, "allowed_tool_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Allowed Tool Ids" }, "forced_tool_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Forced Tool Id" }, "file_descriptors": { "items": { "$ref": "#/components/schemas/FileDescriptor" }, "type": "array", "title": "File Descriptors", "default": [] }, "internal_search_filters": { "anyOf": [ { "$ref": "#/components/schemas/BaseFilters" }, { "type": "null" } ] }, "deep_research": { "type": "boolean", "title": "Deep Research", "default": false }, "mcp_headers": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Mcp Headers" }, "origin": { "$ref": "#/components/schemas/MessageOrigin", "default": "unset" }, "parent_message_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Parent Message Id", "default": -1 }, "chat_session_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Chat Session Id" }, "chat_session_info": { "anyOf": [ { "$ref": "#/components/schemas/ChatSessionCreationRequest" }, { "type": "null" } ] }, "stream": { "type": "boolean", "title": "Stream", "default": true }, "include_citations": { "type": "boolean", "title": "Include Citations", "default": true }, "additional_context": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Additional Context" } }, "type": "object", "required": ["message"], "title": "SendMessageRequest" }, "SendSearchQueryRequest": { "properties": { "search_query": { "type": "string", "title": "Search Query" }, "filters": { "anyOf": [ { "$ref": "#/components/schemas/BaseFilters" }, { "type": "null" } ] }, "num_docs_fed_to_llm_selection": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Num Docs Fed To Llm Selection" }, "run_query_expansion": { "type": "boolean", "title": "Run Query Expansion", "default": false }, "num_hits": { "type": "integer", "title": "Num Hits", "default": 30 }, "hybrid_alpha": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Hybrid Alpha" }, "include_content": { "type": "boolean", "title": "Include Content", "default": false }, "stream": { "type": "boolean", "title": "Stream", "default": false } }, "type": "object", "required": ["search_query"], "title": "SendSearchQueryRequest" }, "SetGroupManagerRequest": { "properties": { "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, "is_manager": { "type": "boolean", "title": "Is Manager" } }, "type": "object", "required": ["user_id", "is_manager"], "title": "SetGroupManagerRequest" }, "SimilarCredentialSnapshot": { "properties": { "credential_json": { "additionalProperties": true, "type": "object", "title": "Credential Json" }, "admin_public": { "type": "boolean", "title": "Admin Public" }, "source": { "$ref": "#/components/schemas/DocumentSource" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "curator_public": { "type": "boolean", "title": "Curator Public", "default": false }, "groups": { "items": { "type": "integer" }, "type": "array", "title": "Groups" }, "id": { "type": "integer", "title": "Id" }, "user_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "User Id" }, "user_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Email" }, "user_personal_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Personal Name" }, "time_created": { "type": "string", "format": "date-time", "title": "Time Created" }, "time_updated": { "type": "string", "format": "date-time", "title": "Time Updated" }, "is_owner": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Owner" }, "usages": { "items": { "$ref": "#/components/schemas/CredentialUsage" }, "type": "array", "title": "Usages" }, "usable": { "type": "boolean", "title": "Usable" }, "refusal_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Refusal Reason" } }, "type": "object", "required": [ "credential_json", "admin_public", "source", "id", "user_id", "time_created", "time_updated", "usable" ], "title": "SimilarCredentialSnapshot" }, "SourceSummary": { "properties": { "total_connectors": { "type": "integer", "title": "Total Connectors" }, "active_connectors": { "type": "integer", "title": "Active Connectors" }, "public_connectors": { "type": "integer", "title": "Public Connectors" }, "total_docs_indexed": { "type": "integer", "title": "Total Docs Indexed" } }, "type": "object", "required": [ "total_connectors", "active_connectors", "public_connectors", "total_docs_indexed" ], "title": "SourceSummary" }, "StarterMessage": { "properties": { "name": { "type": "string", "title": "Name" }, "message": { "type": "string", "title": "Message" } }, "type": "object", "required": ["name", "message"], "title": "StarterMessage", "description": "Starter message for a persona." }, "StatusResponse": { "properties": { "success": { "type": "boolean", "title": "Success" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "data": { "anyOf": [ {}, { "type": "null" } ], "title": "Data" } }, "type": "object", "required": ["success"], "title": "StatusResponse" }, "StatusResponse_int_": { "properties": { "success": { "type": "boolean", "title": "Success" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "data": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Data" } }, "type": "object", "required": ["success"], "title": "StatusResponse[int]" }, "StatusResponse_list_int__": { "properties": { "success": { "type": "boolean", "title": "Success" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "data": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Data" } }, "type": "object", "required": ["success"], "title": "StatusResponse[list[int]]" }, "StopChatResponse": { "properties": { "message": { "type": "string", "title": "Message" } }, "type": "object", "required": ["message"], "title": "StopChatResponse" }, "SupportedLanguage": { "type": "string", "enum": ["en", "es", "pt", "fr", "de", "ja", "zh", "ko", "ar"], "title": "SupportedLanguage" }, "SystemUsageAttribution": { "type": "string", "enum": ["ATTRIBUTED", "UNATTRIBUTED"], "title": "SystemUsageAttribution" }, "SystemUsageCategory": { "properties": { "category": { "type": "string", "title": "Category" }, "totals": { "$ref": "#/components/schemas/UsageExportTotals" }, "records": { "items": { "$ref": "#/components/schemas/SystemUsageRecord" }, "type": "array", "title": "Records" } }, "type": "object", "required": ["category", "totals", "records"], "title": "SystemUsageCategory" }, "SystemUsageRecord": { "properties": { "attribution": { "$ref": "#/components/schemas/SystemUsageAttribution" }, "model": { "type": "string", "title": "Model" }, "flow": { "type": "string", "title": "Flow" }, "provider": { "type": "string", "title": "Provider" }, "day": { "type": "string", "title": "Day" }, "input_tokens": { "type": "integer", "title": "Input Tokens" }, "output_tokens": { "type": "integer", "title": "Output Tokens" }, "cache_read_tokens": { "type": "integer", "title": "Cache Read Tokens" }, "cache_creation_tokens": { "type": "integer", "title": "Cache Creation Tokens" }, "cost_cents": { "type": "number", "title": "Cost Cents" } }, "type": "object", "required": [ "attribution", "model", "flow", "provider", "day", "input_tokens", "output_tokens", "cache_read_tokens", "cache_creation_tokens", "cost_cents" ], "title": "SystemUsageRecord" }, "SystemUsageResponse": { "properties": { "start": { "type": "string", "title": "Start" }, "end": { "type": "string", "title": "End" }, "categories": { "items": { "$ref": "#/components/schemas/SystemUsageCategory" }, "type": "array", "title": "Categories" } }, "type": "object", "required": ["start", "end", "categories"], "title": "SystemUsageResponse" }, "TabularSection": { "properties": { "type": { "type": "string", "const": "tabular", "title": "Type", "default": "tabular" }, "link": { "type": "string", "title": "Link" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Text" }, "image_file_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image File Id" }, "heading": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Heading" }, "csv_file_id": { "type": "string", "title": "Csv File Id" } }, "type": "object", "required": ["link", "csv_file_id"], "title": "TabularSection", "description": "Tabular data \u2014 a csv/tsv file or one xlsx sheet rendered as CSV. The CSV is\nalways staged in the file store (`csv_file_id`) and streamed a row at a time\nat chunk time, so a large sheet never sits on the worker heap." }, "Tag": { "properties": { "tag_key": { "type": "string", "title": "Tag Key" }, "tag_value": { "type": "string", "title": "Tag Value" } }, "type": "object", "required": ["tag_key", "tag_value"], "title": "Tag" }, "TaskStatus": { "type": "string", "enum": ["PENDING", "STARTED", "SUCCESS", "FAILURE"], "title": "TaskStatus" }, "TenantInfo": { "properties": { "invitation": { "anyOf": [ { "$ref": "#/components/schemas/TenantSnapshot" }, { "type": "null" } ] }, "new_tenant": { "anyOf": [ { "$ref": "#/components/schemas/TenantSnapshot" }, { "type": "null" } ] } }, "type": "object", "title": "TenantInfo" }, "TenantSnapshot": { "properties": { "number_of_users": { "type": "integer", "title": "Number Of Users" } }, "type": "object", "required": ["number_of_users"], "title": "TenantSnapshot" }, "TextSection": { "properties": { "type": { "type": "string", "const": "text", "title": "Type", "default": "text" }, "link": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Link" }, "text": { "type": "string", "title": "Text" }, "image_file_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image File Id" }, "heading": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Heading" } }, "type": "object", "required": ["text"], "title": "TextSection", "description": "Section containing text content" }, "ThemePreference": { "type": "string", "enum": ["light", "dark", "system"], "title": "ThemePreference" }, "TimeRange": { "properties": { "start": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Start" }, "end": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End" } }, "type": "object", "title": "TimeRange", "description": "An inclusive [start, end] window; either bound may be None (open).\nNaive (timezone-less) bounds are treated as UTC." }, "TokenRateLimitArgs": { "properties": { "enabled": { "type": "boolean", "title": "Enabled" }, "token_budget": { "anyOf": [ { "type": "integer", "maximum": 1000000000.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Token Budget" }, "period_hours": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Period Hours" }, "cost_budget_cents": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "Cost Budget Cents" } }, "type": "object", "required": ["enabled", "period_hours"], "title": "TokenRateLimitArgs" }, "TokenRateLimitDisplay": { "properties": { "token_id": { "type": "integer", "title": "Token Id" }, "enabled": { "type": "boolean", "title": "Enabled" }, "token_budget": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Token Budget" }, "period_hours": { "type": "integer", "title": "Period Hours" }, "cost_budget_cents": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cost Budget Cents" } }, "type": "object", "required": [ "token_id", "enabled", "token_budget", "period_hours", "cost_budget_cents" ], "title": "TokenRateLimitDisplay" }, "TokenRateLimitUpdateArgs": { "properties": { "enabled": { "type": "boolean", "title": "Enabled" }, "token_budget": { "anyOf": [ { "type": "integer", "minimum": 1.0 }, { "type": "null" } ], "title": "Token Budget" }, "period_hours": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Period Hours" }, "cost_budget_cents": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "Cost Budget Cents" } }, "type": "object", "required": ["enabled", "period_hours"], "title": "TokenRateLimitUpdateArgs" }, "ToolCallArgumentDelta": { "properties": { "type": { "type": "string", "const": "tool_call_argument_delta", "title": "Type", "default": "tool_call_argument_delta" }, "tool_type": { "type": "string", "title": "Tool Type" }, "argument_deltas": { "additionalProperties": true, "type": "object", "title": "Argument Deltas" } }, "type": "object", "required": ["tool_type", "argument_deltas"], "title": "ToolCallArgumentDelta" }, "ToolCallDebug": { "properties": { "type": { "type": "string", "const": "tool_call_debug", "title": "Type", "default": "tool_call_debug" }, "tool_call_id": { "type": "string", "title": "Tool Call Id" }, "tool_name": { "type": "string", "title": "Tool Name" }, "tool_args": { "additionalProperties": true, "type": "object", "title": "Tool Args" } }, "type": "object", "required": ["tool_call_id", "tool_name", "tool_args"], "title": "ToolCallDebug" }, "ToolCallResponse": { "properties": { "tool_name": { "type": "string", "title": "Tool Name" }, "tool_arguments": { "additionalProperties": true, "type": "object", "title": "Tool Arguments" }, "tool_result": { "type": "string", "title": "Tool Result" }, "search_docs": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SearchDoc" }, "type": "array" }, { "type": "null" } ], "title": "Search Docs" }, "generated_images": { "anyOf": [ { "items": { "$ref": "#/components/schemas/GeneratedImage" }, "type": "array" }, { "type": "null" } ], "title": "Generated Images" }, "pre_reasoning": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pre Reasoning" } }, "type": "object", "required": ["tool_name", "tool_arguments", "tool_result"], "title": "ToolCallResponse", "description": "Tool call with full details for non-streaming response." }, "ToolSnapshot": { "properties": { "id": { "type": "integer", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "definition": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Definition" }, "display_name": { "type": "string", "title": "Display Name" }, "in_code_tool_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "In Code Tool Id" }, "custom_headers": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Custom Headers" }, "passthrough_auth": { "type": "boolean", "title": "Passthrough Auth" }, "mcp_server_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Mcp Server Id" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id" }, "oauth_config_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Oauth Config Id" }, "oauth_config_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Oauth Config Name" }, "enabled": { "type": "boolean", "title": "Enabled", "default": true }, "user_enabled_in_chat": { "type": "boolean", "title": "User Enabled In Chat", "default": true }, "default_chat_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Default Chat Enabled", "description": "Whether this tool is selected for the default assistant." }, "permissions": { "additionalProperties": { "type": "boolean" }, "type": "object", "title": "Permissions" }, "chat_selectable": { "type": "boolean", "title": "Chat Selectable", "default": true }, "agent_creation_selectable": { "type": "boolean", "title": "Agent Creation Selectable", "default": true }, "default_enabled": { "type": "boolean", "title": "Default Enabled", "default": false } }, "type": "object", "required": [ "id", "name", "description", "definition", "display_name", "in_code_tool_id", "custom_headers", "passthrough_auth" ], "title": "ToolSnapshot" }, "ToolUserPreferences": { "properties": { "enabled_in_chat": { "type": "boolean", "title": "Enabled In Chat" } }, "type": "object", "required": ["enabled_in_chat"], "title": "ToolUserPreferences" }, "UpdateGroupAgentsRequest": { "properties": { "added_agent_ids": { "items": { "type": "integer" }, "type": "array", "title": "Added Agent Ids" }, "removed_agent_ids": { "items": { "type": "integer" }, "type": "array", "title": "Removed Agent Ids" } }, "type": "object", "required": ["added_agent_ids", "removed_agent_ids"], "title": "UpdateGroupAgentsRequest" }, "UpdateGroupDocumentSetsRequest": { "properties": { "added_document_set_ids": { "items": { "type": "integer" }, "type": "array", "title": "Added Document Set Ids" }, "removed_document_set_ids": { "items": { "type": "integer" }, "type": "array", "title": "Removed Document Set Ids" } }, "type": "object", "required": ["added_document_set_ids", "removed_document_set_ids"], "title": "UpdateGroupDocumentSetsRequest" }, "UpdateProjectRequest": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" } }, "type": "object", "title": "UpdateProjectRequest" }, "UpsertProjectInstructionsRequest": { "properties": { "instructions": { "type": "string", "title": "Instructions" } }, "type": "object", "required": ["instructions"], "title": "UpsertProjectInstructionsRequest" }, "UsageExportRecord": { "properties": { "model": { "type": "string", "title": "Model" }, "flow": { "type": "string", "title": "Flow" }, "provider": { "type": "string", "title": "Provider" }, "incognito": { "type": "boolean", "title": "Incognito" }, "day": { "type": "string", "title": "Day" }, "input_tokens": { "type": "integer", "title": "Input Tokens" }, "output_tokens": { "type": "integer", "title": "Output Tokens" }, "cache_read_tokens": { "type": "integer", "title": "Cache Read Tokens" }, "cache_creation_tokens": { "type": "integer", "title": "Cache Creation Tokens" }, "cost_cents": { "type": "number", "title": "Cost Cents" } }, "type": "object", "required": [ "model", "flow", "provider", "incognito", "day", "input_tokens", "output_tokens", "cache_read_tokens", "cache_creation_tokens", "cost_cents" ], "title": "UsageExportRecord" }, "UsageExportResponse": { "properties": { "start": { "type": "string", "title": "Start" }, "end": { "type": "string", "title": "End" }, "users": { "items": { "$ref": "#/components/schemas/UsageExportUser" }, "type": "array", "title": "Users" } }, "type": "object", "required": ["start", "end", "users"], "title": "UsageExportResponse", "description": "Nested per-user daily usage export." }, "UsageExportTotals": { "properties": { "input_tokens": { "type": "integer", "title": "Input Tokens" }, "output_tokens": { "type": "integer", "title": "Output Tokens" }, "cache_read_tokens": { "type": "integer", "title": "Cache Read Tokens" }, "cache_creation_tokens": { "type": "integer", "title": "Cache Creation Tokens" }, "cost_cents": { "type": "number", "title": "Cost Cents" } }, "type": "object", "required": [ "input_tokens", "output_tokens", "cache_read_tokens", "cache_creation_tokens", "cost_cents" ], "title": "UsageExportTotals" }, "UsageExportUser": { "properties": { "email": { "type": "string", "title": "Email" }, "totals": { "$ref": "#/components/schemas/UsageExportTotals" }, "records": { "items": { "$ref": "#/components/schemas/UsageExportRecord" }, "type": "array", "title": "Records" } }, "type": "object", "required": ["email", "totals", "records"], "title": "UsageExportUser" }, "UserAdminAccessUpdateRequest": { "properties": { "user_email": { "type": "string", "title": "User Email" }, "is_admin": { "type": "boolean", "title": "Is Admin" } }, "type": "object", "required": ["user_email", "is_admin"], "title": "UserAdminAccessUpdateRequest" }, "UserAnalyticsResponse": { "properties": { "total_active_users": { "type": "integer", "title": "Total Active Users" }, "date": { "type": "string", "format": "date", "title": "Date" } }, "type": "object", "required": ["total_active_users", "date"], "title": "UserAnalyticsResponse" }, "UserByEmail": { "properties": { "user_email": { "type": "string", "title": "User Email" } }, "type": "object", "required": ["user_email"], "title": "UserByEmail" }, "UserFileDeleteResult": { "properties": { "has_associations": { "type": "boolean", "title": "Has Associations" }, "project_names": { "items": { "type": "string" }, "type": "array", "title": "Project Names", "default": [] }, "assistant_names": { "items": { "type": "string" }, "type": "array", "title": "Assistant Names", "default": [] } }, "type": "object", "required": ["has_associations"], "title": "UserFileDeleteResult" }, "UserFileIdsRequest": { "properties": { "file_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "File Ids" } }, "type": "object", "required": ["file_ids"], "title": "UserFileIdsRequest" }, "UserFileSnapshot": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "temp_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Temp Id" }, "name": { "type": "string", "title": "Name" }, "project_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Project Id" }, "user_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "User Id" }, "file_id": { "type": "string", "title": "File Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "status": { "$ref": "#/components/schemas/UserFileStatus" }, "last_accessed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Accessed At" }, "file_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Type" }, "chat_file_type": { "$ref": "#/components/schemas/ChatFileType" }, "token_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Token Count" }, "chunk_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Chunk Count" } }, "type": "object", "required": [ "id", "name", "user_id", "file_id", "created_at", "status", "last_accessed_at", "file_type", "chat_file_type", "token_count", "chunk_count" ], "title": "UserFileSnapshot" }, "UserFileStatus": { "type": "string", "enum": [ "PROCESSING", "INDEXING", "COMPLETED", "SKIPPED", "FAILED", "CANCELED", "DELETING" ], "title": "UserFileStatus" }, "UserGroup": { "properties": { "id": { "type": "integer", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "users": { "items": { "$ref": "#/components/schemas/UserInfo" }, "type": "array", "title": "Users" }, "manager_ids": { "items": { "type": "string" }, "type": "array", "title": "Manager Ids" }, "cc_pairs": { "items": { "$ref": "#/components/schemas/ConnectorCredentialPairDescriptor" }, "type": "array", "title": "Cc Pairs" }, "managed_cc_pairs": { "items": { "$ref": "#/components/schemas/ManagedCCPairEntry" }, "type": "array", "title": "Managed Cc Pairs" }, "document_sets": { "items": { "$ref": "#/components/schemas/DocumentSet" }, "type": "array", "title": "Document Sets" }, "personas": { "items": { "$ref": "#/components/schemas/PersonaSnapshot" }, "type": "array", "title": "Personas" }, "is_up_to_date": { "type": "boolean", "title": "Is Up To Date" }, "is_up_for_deletion": { "type": "boolean", "title": "Is Up For Deletion" }, "is_default": { "type": "boolean", "title": "Is Default" }, "incognito_enabled": { "type": "boolean", "title": "Incognito Enabled" }, "permissions": { "additionalProperties": { "type": "boolean" }, "type": "object", "title": "Permissions" } }, "type": "object", "required": [ "id", "name", "users", "manager_ids", "cc_pairs", "managed_cc_pairs", "document_sets", "personas", "is_up_to_date", "is_up_for_deletion", "is_default", "incognito_enabled" ], "title": "UserGroup" }, "UserGroupCreate": { "properties": { "name": { "type": "string", "title": "Name" }, "user_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "User Ids" }, "cc_pair_ids": { "items": { "type": "integer" }, "type": "array", "title": "Cc Pair Ids" } }, "type": "object", "required": ["name", "user_ids", "cc_pair_ids"], "title": "UserGroupCreate" }, "UserGroupDataAccessCCPairs": { "properties": { "cc_pair_ids": { "items": { "type": "integer" }, "type": "array", "title": "Cc Pair Ids" } }, "type": "object", "required": ["cc_pair_ids"], "title": "UserGroupDataAccessCCPairs" }, "UserGroupIncognitoUpdate": { "properties": { "enabled": { "type": "boolean", "title": "Enabled" } }, "type": "object", "required": ["enabled"], "title": "UserGroupIncognitoUpdate" }, "UserGroupInfo": { "properties": { "id": { "type": "integer", "title": "Id" }, "name": { "type": "string", "title": "Name" } }, "type": "object", "required": ["id", "name"], "title": "UserGroupInfo" }, "UserGroupRename": { "properties": { "id": { "type": "integer", "title": "Id" }, "name": { "type": "string", "title": "Name" } }, "type": "object", "required": ["id", "name"], "title": "UserGroupRename" }, "UserGroupUpdate": { "properties": { "user_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "User Ids" }, "cc_pair_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Cc Pair Ids" } }, "type": "object", "required": ["user_ids"], "title": "UserGroupUpdate" }, "UserInfo": { "properties": { "id": { "type": "string", "title": "Id" }, "email": { "type": "string", "title": "Email" }, "is_active": { "type": "boolean", "title": "Is Active" }, "is_superuser": { "type": "boolean", "title": "Is Superuser" }, "is_verified": { "type": "boolean", "title": "Is Verified" }, "account_type": { "$ref": "#/components/schemas/AccountType", "default": "STANDARD" }, "preferences": { "$ref": "#/components/schemas/UserPreferences" }, "personalization": { "$ref": "#/components/schemas/UserPersonalization" }, "token_expires_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Token Expires At" }, "is_cloud_superuser": { "type": "boolean", "title": "Is Cloud Superuser", "default": false }, "team_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Team Name" }, "is_anonymous_user": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Anonymous User" }, "password_configured": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Password Configured" }, "tenant_info": { "anyOf": [ { "$ref": "#/components/schemas/TenantInfo" }, { "type": "null" } ] }, "effective_permissions": { "items": { "type": "string" }, "type": "array", "title": "Effective Permissions" }, "is_group_manager": { "type": "boolean", "title": "Is Group Manager", "default": false }, "admin_capabilities": { "items": { "type": "string" }, "type": "array", "title": "Admin Capabilities" } }, "type": "object", "required": [ "id", "email", "is_active", "is_superuser", "is_verified", "preferences" ], "title": "UserInfo" }, "UserPermissionsResponse": { "properties": { "permissions": { "items": { "type": "string" }, "type": "array", "title": "Permissions" }, "is_manager": { "type": "boolean", "title": "Is Manager" }, "managed_group_ids": { "items": { "type": "integer" }, "type": "array", "title": "Managed Group Ids" } }, "type": "object", "required": ["permissions", "is_manager", "managed_group_ids"], "title": "UserPermissionsResponse" }, "UserPersonalization": { "properties": { "name": { "type": "string", "title": "Name", "default": "" }, "role": { "type": "string", "title": "Role", "default": "" }, "use_memories": { "type": "boolean", "title": "Use Memories", "default": true }, "enable_memory_tool": { "type": "boolean", "title": "Enable Memory Tool", "default": true }, "memories": { "items": { "$ref": "#/components/schemas/MemoryItem" }, "type": "array", "title": "Memories" }, "user_preferences": { "type": "string", "title": "User Preferences", "default": "" } }, "type": "object", "title": "UserPersonalization" }, "UserPreferences": { "properties": { "chosen_assistants": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Chosen Assistants" }, "hidden_assistants": { "items": { "type": "integer" }, "type": "array", "title": "Hidden Assistants", "default": [] }, "visible_assistants": { "items": { "type": "integer" }, "type": "array", "title": "Visible Assistants", "default": [] }, "default_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Default Model" }, "pinned_assistants": { "items": { "type": "integer" }, "type": "array", "title": "Pinned Assistants", "default": [] }, "shortcut_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Shortcut Enabled" }, "auto_scroll": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Auto Scroll" }, "temperature_override_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Temperature Override Enabled" }, "temperature_default": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Temperature Default" }, "reasoning_effort_default": { "anyOf": [ { "$ref": "#/components/schemas/ReasoningEffort" }, { "type": "null" } ] }, "theme_preference": { "anyOf": [ { "$ref": "#/components/schemas/ThemePreference" }, { "type": "null" } ] }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" }, "chat_background": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Chat Background" }, "default_app_mode": { "$ref": "#/components/schemas/DefaultAppMode", "default": "CHAT" }, "paste_as_tile": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Paste As Tile" }, "voice_auto_send": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Voice Auto Send" }, "voice_auto_playback": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Voice Auto Playback" }, "voice_playback_speed": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Voice Playback Speed" }, "assistant_specific_configs": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/UserSpecificAssistantPreference" }, "type": "object" }, { "type": "null" } ], "title": "Assistant Specific Configs" } }, "type": "object", "title": "UserPreferences" }, "UserProjectSnapshot": { "properties": { "id": { "type": "integer", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "user_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "User Id" }, "instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instructions" }, "chat_sessions": { "items": { "$ref": "#/components/schemas/ChatSessionDetails" }, "type": "array", "title": "Chat Sessions" } }, "type": "object", "required": [ "id", "name", "description", "created_at", "user_id", "chat_sessions" ], "title": "UserProjectSnapshot" }, "UserSpecificAssistantPreference": { "properties": { "disabled_tool_ids": { "items": { "type": "integer" }, "type": "array", "title": "Disabled Tool Ids" } }, "type": "object", "required": ["disabled_tool_ids"], "title": "UserSpecificAssistantPreference" }, "UserUsageByDay": { "properties": { "day": { "type": "string", "title": "Day" }, "model": { "type": "string", "title": "Model" }, "input_tokens": { "type": "integer", "title": "Input Tokens" }, "output_tokens": { "type": "integer", "title": "Output Tokens" }, "cache_read_tokens": { "type": "integer", "title": "Cache Read Tokens" }, "cache_creation_tokens": { "type": "integer", "title": "Cache Creation Tokens" }, "cost_cents": { "type": "number", "title": "Cost Cents" } }, "type": "object", "required": [ "day", "model", "input_tokens", "output_tokens", "cache_read_tokens", "cache_creation_tokens", "cost_cents" ], "title": "UserUsageByDay", "description": "Per-user usage aggregated by UTC calendar day and model." }, "UserUsageResponse": { "properties": { "per_day_by_model": { "items": { "$ref": "#/components/schemas/UserUsageByDay" }, "type": "array", "title": "Per Day By Model" }, "window_cost_cents": { "type": "number", "title": "Window Cost Cents" }, "budget_cents": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Budget Cents" }, "budget_remaining_cents": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Budget Remaining Cents" }, "budget_period_hours": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Budget Period Hours" }, "budget_reset_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Budget Reset At" }, "selected_model_price": { "anyOf": [ { "$ref": "#/components/schemas/ModelPrice" }, { "type": "null" } ] }, "available_model_prices": { "items": { "$ref": "#/components/schemas/ModelPrice" }, "type": "array", "title": "Available Model Prices" } }, "type": "object", "required": [ "per_day_by_model", "window_cost_cents", "budget_cents", "budget_remaining_cents", "selected_model_price" ], "title": "UserUsageResponse" }, "ValidateToolRequest": { "properties": { "definition": { "additionalProperties": true, "type": "object", "title": "Definition" } }, "type": "object", "required": ["definition"], "title": "ValidateToolRequest" }, "ValidateToolResponse": { "properties": { "methods": { "items": { "$ref": "#/components/schemas/MethodSpec" }, "type": "array", "title": "Methods" } }, "type": "object", "required": ["methods"], "title": "ValidateToolResponse" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": ["loc", "msg", "type"], "title": "ValidationError" }, "VersionResponse": { "properties": { "backend_version": { "type": "string", "title": "Backend Version" } }, "type": "object", "required": ["backend_version"], "title": "VersionResponse" }, "WebContentProviderType": { "type": "string", "enum": ["onyx_web_crawler", "firecrawl", "exa", "tavily"], "title": "WebContentProviderType" }, "WebSearchProviderType": { "type": "string", "enum": [ "google_pse", "serper", "exa", "searxng", "brave", "tavily", "firecrawl" ], "title": "WebSearchProviderType" }, "WebSearchToolRequest": { "properties": { "queries": { "items": { "type": "string" }, "type": "array", "minItems": 1, "title": "Queries", "description": "List of search queries to send to the configured provider." }, "max_results": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Results", "description": "Optional cap on number of results to return per query. Defaults to 10.", "default": 10 } }, "type": "object", "required": ["queries"], "title": "WebSearchToolRequest" }, "WebSearchToolResponse": { "properties": { "results": { "items": { "$ref": "#/components/schemas/LlmWebSearchResult" }, "type": "array", "title": "Results" }, "provider_type": { "$ref": "#/components/schemas/WebSearchProviderType" } }, "type": "object", "required": ["results", "provider_type"], "title": "WebSearchToolResponse" }, "WebSearchWithContentResponse": { "properties": { "search_provider_type": { "$ref": "#/components/schemas/WebSearchProviderType" }, "content_provider_type": { "anyOf": [ { "$ref": "#/components/schemas/WebContentProviderType" }, { "type": "null" } ] }, "search_results": { "items": { "$ref": "#/components/schemas/LlmWebSearchResult" }, "type": "array", "title": "Search Results" }, "full_content_results": { "items": { "$ref": "#/components/schemas/LlmOpenUrlResult" }, "type": "array", "title": "Full Content Results" } }, "type": "object", "required": [ "search_provider_type", "search_results", "full_content_results" ], "title": "WebSearchWithContentResponse" } }, "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "description": "Authorization header with Bearer token" } } } }