{ "openapi": "3.1.0", "info": { "title": "NCP API", "version": "0.0.1" }, "paths": { "/api/v1/deployment/features": { "get": { "tags": [ "Deployment", "Deployment" ], "summary": "Get Deployment Features", "description": "Return the resolved feature spec for this deployment.\n\nShape::\n\n {\n \"profile\": \"ai-noc\",\n \"connectors\": {\"enabled\": [...], \"disabled\": [...]},\n \"use_cases\": {\"enabled\": [...], \"disabled\": [...]},\n \"agents\": {\"enabled\": [...], \"disabled\": [...]} # reserved in v1\n }\n\nEmpty lists mean \"no restriction\" — the caller shows everything. Reflects the\nfile as of the current request: the spec is re-read when its mtime changes,\nso an edit is picked up without a restart.", "operationId": "get_deployment_features_api_v1_deployment_features_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BearerToken": [] } ] } }, "/api/v1/conversations/user/can-view-agent-trace": { "get": { "tags": [ "Conversation" ], "summary": "Can View Agent Trace Endpoint", "description": "Whether the caller's role can see the agent-trajectory trace tab.\n\nUsed by the FE to gate the power-user \"Trace\" tab/trigger in the source\ninformation drawer. Returns ``true`` for admins, \"Power user\", and any\ncustom role with ``can_view_agent_trace=true``.", "operationId": "can_view_agent_trace_endpoint_api_v1_conversations_user_can_view_agent_trace_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentTracePermissionResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/conversations/all/export": { "get": { "tags": [ "Conversation" ], "summary": "Export Chats", "operationId": "export_chats_api_v1_conversations_all_export_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "file_format", "in": "query", "required": false, "schema": { "type": "string", "default": "txt", "title": "File Format" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/conversations/{qa_id}/user_feedback": { "post": { "tags": [ "Conversation" ], "summary": "User Feedback By Qa Id", "operationId": "user_feedback_by_qa_id_api_v1_conversations__qa_id__user_feedback_post", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "qa_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Qa Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/conversations/{conversation_id}/archive": { "post": { "tags": [ "Conversation" ], "summary": "Archive Conversation", "description": "Archive a conversation by its ID.", "operationId": "archive_conversation_api_v1_conversations__conversation_id__archive_post", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Conversation Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/conversations/archived_conversations": { "get": { "tags": [ "Conversation" ], "summary": "Get Archived Conversations", "description": "Retrieve archived conversations for the authenticated user.", "operationId": "get_archived_conversations_api_v1_conversations_archived_conversations_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BearerToken": [] } ] } }, "/api/v1/conversations/{conversation_id}/unarchive": { "post": { "tags": [ "Conversation" ], "summary": "Unarchive Conversation", "description": "Unarchive a conversation by its ID.", "operationId": "unarchive_conversation_api_v1_conversations__conversation_id__unarchive_post", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Conversation Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/conversations/{conversation_id}": { "delete": { "tags": [ "Conversation" ], "summary": "Delete Conversation", "description": "Permanently delete a conversation by its ID, regardless of archive state.", "operationId": "delete_conversation_api_v1_conversations__conversation_id__delete", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Conversation Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/conversations/{conversation_id}/export": { "get": { "tags": [ "Conversation" ], "summary": "Export Conversation By Id", "operationId": "export_conversation_by_id_api_v1_conversations__conversation_id__export_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Conversation Id" } }, { "name": "file_format", "in": "query", "required": false, "schema": { "type": "string", "default": "txt", "title": "File Format" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/conversations/{conversation_id}/memory/{reference_id}/export": { "get": { "tags": [ "Conversation" ], "summary": "Export Memory Data", "description": "Download a previously agent-memory-stored dataset as a raw CSV/JSON/Excel file.\n\nBypasses the LLM entirely - serves exactly what a custom agent's tool\nfunction passed to Memory().store(..., exportable=True), with no\nreshaping. Only entries explicitly marked exportable at store time can be\ndownloaded here, regardless of what any UI happens to show.", "operationId": "export_memory_data_api_v1_conversations__conversation_id__memory__reference_id__export_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Conversation Id" } }, { "name": "reference_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Reference Id" } }, { "name": "format", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^(csv|json|xlsx)$", "default": "csv", "title": "Format" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/conversations/all/{project_id}": { "get": { "tags": [ "Conversation" ], "summary": "Get All Conversations By Project Id", "operationId": "get_all_conversations_by_project_id_api_v1_conversations_all__project_id__get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/search": { "get": { "tags": [ "Search" ], "summary": "Search Conversations", "description": "Search the caller's own conversations by title and message content.", "operationId": "search_conversations_api_v1_search_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "description": "Search keyword", "default": "", "title": "Q" }, "description": "Search keyword" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/knowledge_base/upload": { "post": { "tags": [ "KnowledgeBase" ], "summary": "Upload File", "operationId": "upload_file_api_v1_knowledge_base_upload_post", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "schema": { "title": "Username" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_file_api_v1_knowledge_base_upload_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/knowledge_base/files/{username}": { "get": { "tags": [ "KnowledgeBase" ], "summary": "Get Files", "operationId": "get_files_api_v1_knowledge_base_files__username__get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "username", "in": "path", "required": true, "schema": { "type": "string", "title": "Username" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/knowledge_base/files/{username}/{id}": { "delete": { "tags": [ "KnowledgeBase" ], "summary": "Delete File", "operationId": "delete_file_api_v1_knowledge_base_files__username___id__delete", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "username", "in": "path", "required": true, "schema": { "type": "string", "title": "Username" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "KnowledgeBase" ], "summary": "Update File Description", "operationId": "update_file_description_api_v1_knowledge_base_files__username___id__put", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "username", "in": "path", "required": true, "schema": { "type": "string", "title": "Username" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/slack_configuration/create": { "post": { "tags": [ "SlackConfiguration" ], "summary": "Create Slack Configuration", "operationId": "create_slack_configuration_api_v1_slack_configuration_create_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BearerToken": [] } ] } }, "/api/v1/slack_configuration/get_all": { "get": { "tags": [ "SlackConfiguration" ], "summary": "Get Slack Configuration", "operationId": "get_slack_configuration_api_v1_slack_configuration_get_all_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BearerToken": [] } ] } }, "/api/v1/slack_configuration/channels": { "get": { "tags": [ "SlackConfiguration" ], "summary": "List Slack Channels", "description": "Slim list of configured Slack channels for FE pickers.\n\nReturns only ``channel`` and ``channel_id`` — NEVER the bot token\n(``webhook_url``). Use this anywhere the FE needs to populate a\n\"send to which Slack channel\" dropdown (background-job wizard, etc.)\nwithout exposing credentials to the browser. Empty list means Slack\nis not configured yet — the FE should hide the \"Send to Slack\"\noption in that case.", "operationId": "list_slack_channels_api_v1_slack_configuration_channels_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BearerToken": [] } ] } }, "/api/v1/slack_configuration/update/{id}": { "put": { "tags": [ "SlackConfiguration" ], "summary": "Update Slack Configuration", "operationId": "update_slack_configuration_api_v1_slack_configuration_update__id__put", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/slack_configuration/delete/{id}": { "delete": { "tags": [ "SlackConfiguration" ], "summary": "Delete Slack Configuration", "operationId": "delete_slack_configuration_api_v1_slack_configuration_delete__id__delete", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/slack-events/questions": { "post": { "summary": "Slack Events", "operationId": "slack_events_api_v1_slack_events_questions_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/v1/projects": { "get": { "tags": [ "Projects" ], "summary": "Get Projects", "description": "Get active (non-archived) projects for the caller.\nNon-admins see only projects they are a member of; admins see all.\nIdentity comes from the verified token, not a client-supplied username.", "operationId": "get_projects_api_v1_projects_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ProjectResponse" }, "type": "array", "title": "Response Get Projects Api V1 Projects Get" } } } } }, "security": [ { "BearerToken": [] } ] }, "post": { "tags": [ "Projects" ], "summary": "Create Project", "operationId": "create_project_api_v1_projects_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerToken": [] } ] } }, "/api/v1/projects/archived": { "get": { "tags": [ "Projects" ], "summary": "Get Archived Projects", "description": "Get archived projects for the caller (mirrors get_projects, but for the\narchived set). Non-admins see only projects they are a member of; admins\nsee all. Identity comes from the verified token, not a client username.", "operationId": "get_archived_projects_api_v1_projects_archived_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ProjectResponse" }, "type": "array", "title": "Response Get Archived Projects Api V1 Projects Archived Get" } } } } }, "security": [ { "BearerToken": [] } ] } }, "/api/v1/projects/{project_id}": { "get": { "tags": [ "Projects" ], "summary": "Get Project", "operationId": "get_project_api_v1_projects__project_id__get", "security": [ { "BearerToken": [] } ], "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/ProjectResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Projects" ], "summary": "Update Project", "operationId": "update_project_api_v1_projects__project_id__put", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Projects" ], "summary": "Delete Project", "operationId": "delete_project_api_v1_projects__project_id__delete", "security": [ { "BearerToken": [] } ], "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" } } } } } } }, "/api/v1/projects/{project_id}/archive": { "post": { "tags": [ "Projects" ], "summary": "Archive Project", "description": "Archive a project by its ID.", "operationId": "archive_project_api_v1_projects__project_id__archive_post", "security": [ { "BearerToken": [] } ], "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" } } } } } } }, "/api/v1/projects/{project_id}/unarchive": { "post": { "tags": [ "Projects" ], "summary": "Unarchive Project", "description": "Unarchive a project by its ID.", "operationId": "unarchive_project_api_v1_projects__project_id__unarchive_post", "security": [ { "BearerToken": [] } ], "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" } } } } } } }, "/api/v1/projects/{project_id}/download": { "get": { "tags": [ "Projects" ], "summary": "Download Project Export", "operationId": "download_project_export_api_v1_projects__project_id__download_get", "security": [ { "BearerToken": [] } ], "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" } } } } } } }, "/api/v1/project_members/projects/{project_id}/members": { "get": { "tags": [ "Project Members" ], "summary": "List Project Members", "operationId": "list_project_members_api_v1_project_members_projects__project_id__members_get", "security": [ { "BearerToken": [] } ], "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/MemberResponse" }, "title": "Response List Project Members Api V1 Project Members Projects Project Id Members Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Project Members" ], "summary": "Add Project Member", "operationId": "add_project_member_api_v1_project_members_projects__project_id__members_post", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/project_members/projects/{project_id}/members/{username}": { "get": { "tags": [ "Project Members" ], "summary": "Get Project Member", "operationId": "get_project_member_api_v1_project_members_projects__project_id__members__username__get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string", "title": "Username" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Project Members" ], "summary": "Delete Project Member", "operationId": "delete_project_member_api_v1_project_members_projects__project_id__members__username__delete", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string", "title": "Username" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/project_members/projects/{project_id}/members/{username}/admin": { "post": { "tags": [ "Project Members" ], "summary": "Add Project Member As Admin", "operationId": "add_project_member_as_admin_api_v1_project_members_projects__project_id__members__username__admin_post", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string", "title": "Username" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/projects/{project_id}/files": { "post": { "tags": [ "Files" ], "summary": "Upload Files", "operationId": "upload_files_api_v1_projects__project_id__files_post", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_files_api_v1_projects__project_id__files_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FileInfoResponse" }, "title": "Response Upload Files Api V1 Projects Project Id Files Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Files" ], "summary": "List Files", "operationId": "list_files_api_v1_projects__project_id__files_get", "security": [ { "BearerToken": [] } ], "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/FileInfoResponse" }, "title": "Response List Files Api V1 Projects Project Id Files Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/projects/{project_id}/files/{file_id}": { "get": { "tags": [ "Files" ], "summary": "Get File Metadata", "operationId": "get_file_metadata_api_v1_projects__project_id__files__file_id__get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "file_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "File Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileInfoResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Files" ], "summary": "Update File Metadata", "operationId": "update_file_metadata_api_v1_projects__project_id__files__file_id__put", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "file_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "File Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileCreateResponse" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileInfoResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Files" ], "summary": "Delete File", "operationId": "delete_file_api_v1_projects__project_id__files__file_id__delete", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "file_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "File Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/projects/{project_id}/files/{file_id}/retry": { "post": { "tags": [ "Files" ], "summary": "Retry File Processing", "description": "Re-run ingestion for a file stuck in 'failed' status (NCP-3810).\n\n``force=true`` also accepts 'completed' files, re-running profiling and\nre-indexing onto the current ingestion scheme (old chunks are replaced).", "operationId": "retry_file_processing_api_v1_projects__project_id__files__file_id__retry_post", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "file_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "File Id" } }, { "name": "force", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Force" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileInfoResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/projects/{project_id}/files/{file_id}/download": { "get": { "tags": [ "Files" ], "summary": "Download File", "operationId": "download_file_api_v1_projects__project_id__files__file_id__download_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "file_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "File Id" } } ], "responses": { "200": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/user/pinned/projects": { "get": { "tags": [ "Pinned Projects" ], "summary": "Get Pinned Projects", "operationId": "get_pinned_projects_api_v1_user_pinned_projects_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "schema": { "type": "string", "title": "Username" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PinnedProjectResponse" }, "title": "Response Get Pinned Projects Api V1 User Pinned Projects Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/user/pinned/projects/{project_id}": { "put": { "tags": [ "Pinned Projects" ], "summary": "Pin Project", "operationId": "pin_project_api_v1_user_pinned_projects__project_id__put", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "username", "in": "query", "required": true, "schema": { "type": "string", "title": "Username" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Pinned Projects" ], "summary": "Unpin Project", "operationId": "unpin_project_api_v1_user_pinned_projects__project_id__delete", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "username", "in": "query", "required": true, "schema": { "type": "string", "title": "Username" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/user/pinned/chats/{username}": { "get": { "tags": [ "Pinned Chats" ], "summary": "Get Pinned Chats", "operationId": "get_pinned_chats_api_v1_user_pinned_chats__username__get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "username", "in": "path", "required": true, "schema": { "type": "string", "title": "Username" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/user/pinned/chats/{chat_id}": { "put": { "tags": [ "Pinned Chats" ], "summary": "Pin Chat", "operationId": "pin_chat_api_v1_user_pinned_chats__chat_id__put", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "chat_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Chat Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Pinned Chats" ], "summary": "Unpin Chat", "operationId": "unpin_chat_api_v1_user_pinned_chats__chat_id__delete", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "chat_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Chat Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/projects/{project_id}/data_connectors": { "get": { "tags": [ "Project Data Connectors" ], "summary": "List data connectors linked to a project", "operationId": "list_project_data_connectors_api_v1_projects__project_id__data_connectors_get", "security": [ { "BearerToken": [] } ], "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/ProjectDataConnectorResponse" }, "title": "Response List Project Data Connectors Api V1 Projects Project Id Data Connectors Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/projects/{project_id}/data_connectors/{data_connector_id}": { "put": { "tags": [ "Project Data Connectors" ], "summary": "Link a data connector or update its enabled status", "operationId": "link_or_update_project_data_connector_api_v1_projects__project_id__data_connectors__data_connector_id__put", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "data_connector_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Data Connector Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectDataConnectorUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectDataConnectorResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Project Data Connectors" ], "summary": "Unlink a data connector from a project", "operationId": "unlink_project_data_connector_api_v1_projects__project_id__data_connectors__data_connector_id__delete", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "data_connector_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Data Connector Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/projects/{project_id}/data_connector_tags": { "get": { "tags": [ "Project Data Connectors" ], "summary": "Tags grouped by connector type (enabled only)", "operationId": "list_project_connector_tags_api_v1_projects__project_id__data_connector_tags_get", "security": [ { "BearerToken": [] } ], "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/TagGroup" }, "title": "Response List Project Connector Tags Api V1 Projects Project Id Data Connector Tags Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/data_connectors/{data_connector_id}/projects": { "get": { "tags": [ "Project Data Connectors" ], "summary": "List projects linked to a data connector", "operationId": "list_data_connector_projects_api_v1_data_connectors__data_connector_id__projects_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "data_connector_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Data Connector Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DataConnectorProjectResponse" }, "title": "Response List Data Connector Projects Api V1 Data Connectors Data Connector Id Projects Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/data_connectors": { "get": { "tags": [ "DataConnectors" ], "summary": "Get Data Connectors", "description": "If no role_id is provided, return all Data Connectors visible to the caller.\nIf role_id is provided, additionally filter by role-based permissions.\nOrg scoping: non-admin users see only connectors with matching org_id or org_id=NULL (shared).", "operationId": "get_data_connectors_api_v1_data_connectors_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "role_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Role Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "DataConnectors" ], "summary": "Create Data Connector", "operationId": "create_data_connector_api_v1_data_connectors_post", "security": [ { "BearerToken": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataConnectorCreate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/data_connectors/{connector_id}": { "get": { "tags": [ "DataConnectors" ], "summary": "Get Data Connector", "operationId": "get_data_connector_api_v1_data_connectors__connector_id__get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Connector Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "DataConnectors" ], "summary": "Update Data Connector", "description": "Persist the edits and update in running containers", "operationId": "update_data_connector_api_v1_data_connectors__connector_id__patch", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Connector Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataConnectorUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "DataConnectors" ], "summary": "Update Data Connector", "description": "Persist the edits and update in running containers", "operationId": "update_data_connector_api_v1_data_connectors__connector_id__put", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Connector Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataConnectorUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "DataConnectors" ], "summary": "Delete Data Connector", "operationId": "delete_data_connector_api_v1_data_connectors__connector_id__delete", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Connector Id" } }, { "name": "allow_force_delete", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Allow Force Delete" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/data_connectors/{connector_id}/deactivate": { "post": { "tags": [ "DataConnectors" ], "summary": "Deactivate Data Connector", "description": "Stop the Docker container and mark status='exited'.\nIf already not running, this is a no-op.", "operationId": "deactivate_data_connector_api_v1_data_connectors__connector_id__deactivate_post", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Connector Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/data_connectors/{connector_id}/activate": { "post": { "tags": [ "DataConnectors" ], "summary": "Activate Data Connector", "description": "Start (or restart) the collector container and mark status='running'.", "operationId": "activate_data_connector_api_v1_data_connectors__connector_id__activate_post", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Connector Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/notifications": { "post": { "tags": [ "Notifications" ], "summary": "Create Notification", "operationId": "create_notification_api_v1_notifications_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerToken": [] } ] } }, "/api/v1/admin_preferences": { "get": { "tags": [ "Admin Preferences", "Admin Preferences" ], "summary": "Get Preferences", "operationId": "get_preferences_api_v1_admin_preferences_get", "security": [ { "BearerToken": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminPreferencesOut" } } } } } }, "post": { "tags": [ "Admin Preferences", "Admin Preferences" ], "summary": "Create Preferences", "operationId": "create_preferences_api_v1_admin_preferences_post", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "authorization", "in": "header", "required": true, "schema": { "type": "string", "description": "Access token", "title": "Authorization" }, "description": "Access token" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminPreferencesCreate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminPreferencesCreate" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin_preferences/{id}": { "put": { "tags": [ "Admin Preferences", "Admin Preferences" ], "summary": "Update Preferences", "operationId": "update_preferences_api_v1_admin_preferences__id__put", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Id" } }, { "name": "authorization", "in": "header", "required": true, "schema": { "type": "string", "description": "Access token", "title": "Authorization" }, "description": "Access token" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminPreferencesUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminPreferencesBase" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin_preferences/dashboard_info": { "get": { "tags": [ "Admin Preferences", "Admin Preferences" ], "summary": "Get Dashboard Info", "operationId": "get_dashboard_info_api_v1_admin_preferences_dashboard_info_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string", "title": "Start Date" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string", "title": "End Date" } }, { "name": "authorization", "in": "header", "required": true, "schema": { "type": "string", "description": "Access token", "title": "Authorization" }, "description": "Access token" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin_preferences/settings/{name}": { "get": { "tags": [ "Admin Preferences" ], "summary": "Get Setting", "description": "Read a single named setting's JSON value (symmetric with PATCH below).\n\nLets the UI read back toggles it writes via PATCH (e.g. the `headroom`\nContext Compression switch) without depending on any other settings-list\nsource.", "operationId": "get_setting_api_v1_admin_preferences_settings__name__get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "Admin Preferences" ], "summary": "Patch Setting", "operationId": "patch_setting_api_v1_admin_preferences_settings__name__patch", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Patch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin_preferences/users_no_password": { "get": { "tags": [ "Admin Preferences", "Admin Preferences" ], "summary": "Get Users With No Password", "operationId": "get_users_with_no_password_api_v1_admin_preferences_users_no_password_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/files/upload": { "post": { "tags": [ "Admin Files", "Admin Files" ], "summary": "Upload Files", "operationId": "upload_files_api_v1_admin_files_upload_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_files_api_v1_admin_files_upload_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/AdminFileCreateResponse" }, "type": "array", "title": "Response Upload Files Api V1 Admin Files Upload Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerToken": [] } ] } }, "/api/v1/admin/files": { "get": { "tags": [ "Admin Files", "Admin Files" ], "summary": "List Admin Files", "operationId": "list_admin_files_api_v1_admin_files_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "role_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Role Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdminFileResponse" }, "title": "Response List Admin Files Api V1 Admin Files Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/files/{file_id}": { "get": { "tags": [ "Admin Files", "Admin Files" ], "summary": "Get Admin File", "operationId": "get_admin_file_api_v1_admin_files__file_id__get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "file_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "File Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminFileResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "Admin Files", "Admin Files" ], "summary": "Update Admin File", "operationId": "update_admin_file_api_v1_admin_files__file_id__patch", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "file_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "File Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminFileUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminFileResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Admin Files", "Admin Files" ], "summary": "Delete Admin File", "operationId": "delete_admin_file_api_v1_admin_files__file_id__delete", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "file_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "File Id" } }, { "name": "allow_force_delete", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Allow Force Delete" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/files/{file_id}/retry": { "post": { "tags": [ "Admin Files", "Admin Files" ], "summary": "Retry Admin File Processing", "description": "Re-run ingestion for an admin file stuck in 'failed' status (NCP-3810).\n\n``force=true`` also accepts 'completed' files (re-profile + re-index).", "operationId": "retry_admin_file_processing_api_v1_admin_files__file_id__retry_post", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "file_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "File Id" } }, { "name": "force", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Force" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminFileResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/files/{file_id}/download": { "get": { "tags": [ "Admin Files", "Admin Files" ], "summary": "Download Admin File", "operationId": "download_admin_file_api_v1_admin_files__file_id__download_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "file_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "File Id" } } ], "responses": { "200": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/files/sync_files": { "post": { "tags": [ "Admin Files", "Admin Files" ], "summary": "Sync Admin Files", "operationId": "sync_admin_files_api_v1_admin_files_sync_files_post", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Body_sync_admin_files_api_v1_admin_files_sync_files_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerToken": [] } ] } }, "/api/v1/projects/{project_id}/exports": { "get": { "tags": [ "Exports" ], "summary": "List Exports", "description": "List all exports for a project with optional filters.", "operationId": "list_exports_api_v1_projects__project_id__exports_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "username", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Username" } }, { "name": "export_format", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Export Format" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "conversation_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Conversation Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExportedFileResponse" }, "title": "Response List Exports Api V1 Projects Project Id Exports Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/projects/{project_id}/exports/{export_id}": { "get": { "tags": [ "Exports" ], "summary": "Get Export Metadata", "description": "Get metadata for a specific export.", "operationId": "get_export_metadata_api_v1_projects__project_id__exports__export_id__get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "export_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Export Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportedFileResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Exports" ], "summary": "Delete Export", "description": "Delete an exported file (file + DB record).", "operationId": "delete_export_api_v1_projects__project_id__exports__export_id__delete", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "export_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Export Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/projects/{project_id}/exports/{export_id}/download": { "get": { "tags": [ "Exports" ], "summary": "Download Export", "description": "Download an exported file.", "operationId": "download_export_api_v1_projects__project_id__exports__export_id__download_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "export_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Export Id" } } ], "responses": { "200": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/projects/{project_id}/exports/{export_id}/preview": { "get": { "tags": [ "Exports" ], "summary": "Preview Export", "description": "Get a preview of the first few rows of an exported file.", "operationId": "preview_export_api_v1_projects__project_id__exports__export_id__preview_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "export_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Export Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportPreviewResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/conversations/{conversation_id}/exports": { "get": { "tags": [ "Exports" ], "summary": "List Conversation Exports", "description": "List all exports generated within a specific conversation.", "operationId": "list_conversation_exports_api_v1_conversations__conversation_id__exports_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "conversation_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Conversation Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExportedFileResponse" }, "title": "Response List Conversation Exports Api V1 Conversations Conversation Id Exports Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/exports/{export_id}": { "get": { "tags": [ "Exports" ], "summary": "Get User Export Metadata", "description": "Get metadata for a specific export (no project scope).", "operationId": "get_user_export_metadata_api_v1_exports__export_id__get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "export_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Export Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportedFileResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/exports/{export_id}/download": { "get": { "tags": [ "Exports" ], "summary": "Download User Export", "description": "Download an exported file by export_id (for exports without a project scope).", "operationId": "download_user_export_api_v1_exports__export_id__download_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "export_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Export Id" } } ], "responses": { "200": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/exports/{export_id}/preview": { "get": { "tags": [ "Exports" ], "summary": "Preview User Export", "description": "Get a preview of the first few rows of an exported file (no project scope).", "operationId": "preview_user_export_api_v1_exports__export_id__preview_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "export_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Export Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportPreviewResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audit_report/{message_id}": { "get": { "tags": [ "Audit Report" ], "summary": "Get Audit Report", "description": "Get audit report by message ID.", "operationId": "get_audit_report_api_v1_audit_report__message_id__get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "message_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Message Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/user_authentication/login_with_cert": { "post": { "tags": [ "LDAP User Authentication" ], "summary": "Login With Cert", "description": "Upload certificate (PEM/DER/PFX/P12) and authenticate.\nPlease Note password is only required for .pfx/.p12 files, for .pem/.der just upload the cert without password.", "operationId": "login_with_cert_api_v1_user_authentication_login_with_cert_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_login_with_cert_api_v1_user_authentication_login_with_cert_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/user_authentication/login": { "post": { "tags": [ "LDAP User Authentication" ], "summary": "Login", "operationId": "login_api_v1_user_authentication_login_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginModel" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/user_authentication/logout": { "post": { "tags": [ "LDAP User Authentication" ], "summary": "Logout", "operationId": "logout_api_v1_user_authentication_logout_post", "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string", "title": "Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/user_authentication/verify": { "get": { "tags": [ "LDAP User Authentication" ], "summary": "Verify Token", "operationId": "verify_token_api_v1_user_authentication_verify_get", "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string", "title": "Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/user_authentication/add_user": { "post": { "tags": [ "LDAP User Authentication" ], "summary": "Add User Api", "operationId": "add_user_api_api_v1_user_authentication_add_user_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserModel" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerToken": [] } ] } }, "/api/v1/user_authentication/search_users": { "get": { "tags": [ "LDAP User Authentication" ], "summary": "Search Users Api", "operationId": "search_users_api_api_v1_user_authentication_search_users_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "ou", "in": "query", "required": true, "schema": { "type": "string", "title": "Ou" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/user_authentication/modify_user_email": { "put": { "tags": [ "LDAP User Authentication" ], "summary": "Modify User Email Api", "operationId": "modify_user_email_api_api_v1_user_authentication_modify_user_email_put", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "cn", "in": "query", "required": true, "schema": { "type": "string", "title": "Cn" } }, { "name": "new_email", "in": "query", "required": true, "schema": { "type": "string", "title": "New Email" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/user_authentication/delete_user": { "delete": { "tags": [ "LDAP User Authentication" ], "summary": "Delete User Api", "operationId": "delete_user_api_api_v1_user_authentication_delete_user_delete", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "cn", "in": "query", "required": true, "schema": { "type": "string", "title": "Cn" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/user_authentication/check_user_exists": { "get": { "tags": [ "LDAP User Authentication" ], "summary": "Check User Exists Api", "operationId": "check_user_exists_api_api_v1_user_authentication_check_user_exists_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "cn", "in": "query", "required": true, "schema": { "type": "string", "title": "Cn" } }, { "name": "ou", "in": "query", "required": false, "schema": { "type": "string", "title": "Ou" } }, { "name": "check_for_admin", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Check For Admin" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/ldap-configs": { "get": { "tags": [ "LDAP Configurations" ], "summary": "Get All Configs", "operationId": "get_all_configs_api_v1_ldap_configs_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "items": { "$ref": "#/components/schemas/LDAPConfigResponse" }, "type": "array" }, { "additionalProperties": true, "type": "object" } ], "title": "Response Get All Configs Api V1 Ldap Configs Get" } } } } }, "security": [ { "BearerToken": [] } ] }, "post": { "tags": [ "LDAP Configurations" ], "summary": "Create Ldap Config", "operationId": "create_ldap_config_api_v1_ldap_configs_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LDAPConfigCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/LDAPConfigResponse" }, { "additionalProperties": true, "type": "object" } ], "title": "Response Create Ldap Config Api V1 Ldap Configs Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerToken": [] } ] } }, "/api/v1/ldap-configs/{config_id}": { "get": { "tags": [ "LDAP Configurations" ], "summary": "Get Config", "operationId": "get_config_api_v1_ldap_configs__config_id__get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "config_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Config Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/LDAPConfigResponse" }, { "type": "object", "additionalProperties": true } ], "title": "Response Get Config Api V1 Ldap Configs Config Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "LDAP Configurations" ], "summary": "Update Config", "operationId": "update_config_api_v1_ldap_configs__config_id__put", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "config_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Config Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LDAPConfigUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/LDAPConfigResponse" }, { "type": "object", "additionalProperties": true } ], "title": "Response Update Config Api V1 Ldap Configs Config Id Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "LDAP Configurations" ], "summary": "Delete Config", "operationId": "delete_config_api_v1_ldap_configs__config_id__delete", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "config_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Config Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Config Api V1 Ldap Configs Config Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/user_preferences": { "get": { "tags": [ "User Preferences", "User Preferences" ], "summary": "Get User Preferences", "operationId": "get_user_preferences_api_v1_user_preferences_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPreferencesBase" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "User Preferences", "User Preferences" ], "summary": "Create User Preferences", "operationId": "create_user_preferences_api_v1_user_preferences_post", "security": [ { "BearerToken": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPreferencesCreate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPreferencesCreate" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/user_preferences/{user_id}": { "put": { "tags": [ "User Preferences", "User Preferences" ], "summary": "Update User Preferences", "operationId": "update_user_preferences_api_v1_user_preferences__user_id__put", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPreferencesUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPreferencesBase" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/llm-configs": { "post": { "tags": [ "LLM Configurations" ], "summary": "Create Config", "operationId": "create_config_api_v1_llm_configs_post", "security": [ { "BearerToken": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LLMConfigCreate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LLMConfigResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "LLM Configurations" ], "summary": "List Configs", "description": "Return LLM configs visible to the caller.\nOrg scoping: non-admin users see only configs with matching org_id or org_id=NULL (shared pool).\nIf role_id is provided, additionally filter by role-based permissions.", "operationId": "list_configs_api_v1_llm_configs_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "role_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Role Id" } }, { "name": "active_only", "in": "query", "required": false, "schema": { "type": "boolean", "title": "Active Only" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LLMConfigResponse" }, "title": "Response List Configs Api V1 Llm Configs Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/llm-configs/{config_id}": { "get": { "tags": [ "LLM Configurations" ], "summary": "Read Config", "operationId": "read_config_api_v1_llm_configs__config_id__get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "config_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Config Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LLMConfigResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "LLM Configurations" ], "summary": "Update Config", "operationId": "update_config_api_v1_llm_configs__config_id__put", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "config_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Config Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LLMConfigUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LLMConfigResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "LLM Configurations" ], "summary": "Delete Config", "operationId": "delete_config_api_v1_llm_configs__config_id__delete", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "config_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Config Id" } }, { "name": "allow_force_delete", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Allow Force Delete" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LLMConfigResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/llm-configs/{config_id}/default": { "patch": { "tags": [ "LLM Configurations" ], "summary": "Set Default Config", "description": "Make the given LLM config the platform default, used for any request\n(chat outside a project, etc.) that doesn't explicitly specify a model.\nAdmin-only. Any configured model may be chosen regardless of its current\nstatus — the caller is responsible for picking one that's actually\nreachable.", "operationId": "set_default_config_api_v1_llm_configs__config_id__default_patch", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "config_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Config Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LLMConfigResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/rocketchat-configuration": { "get": { "tags": [ "rocketchat-configuration" ], "summary": "Get All Rocketchat Configs", "description": "Get all RocketChat configurations.", "operationId": "get_all_rocketchat_configs_api_v1_rocketchat_configuration_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/RocketChatGet" }, "type": "array", "title": "Response Get All Rocketchat Configs Api V1 Rocketchat Configuration Get" } } } } }, "security": [ { "BearerToken": [] } ] }, "post": { "tags": [ "rocketchat-configuration" ], "summary": "Create Rocketchat Config", "description": "Create a new RocketChat configuration.\n\nValidates credentials, resolves the room, stores the config, and picks it\nup in the realtime subscriber. Messages are received over the outbound\nrealtime websocket — no webhook registration is needed.", "operationId": "create_rocketchat_config_api_v1_rocketchat_configuration_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RocketChatCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RocketChatGet" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerToken": [] } ] } }, "/api/v1/rocketchat-configuration/{config_id}": { "get": { "tags": [ "rocketchat-configuration" ], "summary": "Get Rocketchat Config", "description": "Get a specific RocketChat configuration.", "operationId": "get_rocketchat_config_api_v1_rocketchat_configuration__config_id__get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "config_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Config Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RocketChatGet" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "rocketchat-configuration" ], "summary": "Delete Rocketchat Config", "description": "Delete a RocketChat configuration.", "operationId": "delete_rocketchat_config_api_v1_rocketchat_configuration__config_id__delete", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "config_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Config Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/rocketchat-configuration/{config_id}/test-webhook": { "post": { "tags": [ "rocketchat-configuration" ], "summary": "Test Webhook", "description": "Manually trigger a webhook test by sending a test message.", "operationId": "test_webhook_api_v1_rocketchat_configuration__config_id__test_webhook_post", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "config_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Config Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/sdk_agents/auth/login": { "post": { "tags": [ "SDK Agents" ], "summary": "Authenticate Sdk User", "description": "Authenticate SDK user and return API key.\n\nThis endpoint is called by `ncp authenticate` command.\n\nArgs:\n payload: Username and password\n db: Database session\n\nReturns:\n API key and user information", "operationId": "authenticate_sdk_user_api_v1_sdk_agents_auth_login_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SDKAuthRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SDKAuthResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/sdk_agents/deploy": { "post": { "tags": [ "SDK Agents" ], "summary": "Deploy Sdk Agent", "description": "Deploy an SDK agent from .ncp package.\n\nThis endpoint is called by `ncp deploy` command.\n\nArgs:\n file: .ncp package file (tar.gz)\n update: Optional agent name to update\n username: Authenticated username from API key\n db: Database session\n\nReturns:\n Deployment status and agent information", "operationId": "deploy_sdk_agent_api_v1_sdk_agents_deploy_post", "parameters": [ { "name": "update", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Update" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_deploy_sdk_agent_api_v1_sdk_agents_deploy_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SDKAgentDeployResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/sdk_agents/list": { "get": { "tags": [ "SDK Agents" ], "summary": "List Sdk Agents", "description": "List SDK agents deployed by the authenticated user.\n\nArgs:\n username: Authenticated username\n db: Database session\n\nReturns:\n List of user's SDK agents", "operationId": "list_sdk_agents_api_v1_sdk_agents_list_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SDKAgentListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/sdk_agents/remove/{agent_name}": { "delete": { "tags": [ "SDK Agents" ], "summary": "Remove Sdk Agent", "description": "Remove an SDK agent.\n\nThis endpoint is called by `ncp remove` command.\n\nArgs:\n agent_name: Name of the agent\n username: Authenticated username\n db: Database session\n\nReturns:\n Removal confirmation", "operationId": "remove_sdk_agent_api_v1_sdk_agents_remove__agent_name__delete", "parameters": [ { "name": "agent_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Name" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SDKAgentRemoveResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/sdk_agents/available": { "get": { "tags": [ "SDK Agents" ], "summary": "Get Available Agents", "description": "Get list of available SDK agents for UI dropdown.\n\nReturns only deployed agents owned by the authenticated user.\n\nArgs:\n username: Authenticated username\n db: Database session\n\nReturns:\n List of available agents with basic information", "operationId": "get_available_agents_api_v1_sdk_agents_available_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/platform-agents": { "get": { "tags": [ "Platform Agents" ], "summary": "List Platform Agents", "description": "List all platform agents with their tool schemas.\n\nReturns the catalog of all registered platform agents including their\ndescriptions, connector requirements, input schemas, and internal tools.\n\nThis endpoint is called by `ncp agents list` CLI command.\n\nReturns:\n Catalog of platform agents.", "operationId": "list_platform_agents_api_v1_platform_agents_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformAgentCatalogResponse" } } } } }, "security": [ { "BearerToken": [] } ] } }, "/api/v1/platform-agents/{agent_name}/execute": { "post": { "tags": [ "Platform Agents" ], "summary": "Execute Platform Agent", "description": "Execute a platform agent with a query and return the result.\n\nRuns the specified platform agent to completion using AgentExecutor,\nwith proper project context and connector filtering.\n\nThis endpoint is called by the SDK's platform.agent().execute() proxy.\n\nArgs:\n agent_name: Name of the platform agent to execute.\n payload: Query and optional project_id.\n username: Authenticated username from API key.\n db: Database session.\n\nReturns:\n Execution result with the agent's response.\n\nRaises:\n HTTPException: If agent not found or connector not available.", "operationId": "execute_platform_agent_api_v1_platform_agents__agent_name__execute_post", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "agent_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Name" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformAgentExecuteRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformAgentExecuteResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/custom_agents/admin/list": { "get": { "tags": [ "Custom Agents" ], "summary": "Get Custom Agents", "description": "List all custom agents for Admin (status = 'ACTIVE', 'PENDING', 'REJECTED').\n\nArgs:\n username: Authenticated username\n db: Database session\n\nReturns:\n List of all custom agents for admin", "operationId": "get_custom_agents_api_v1_custom_agents_admin_list_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomAgentListAdminResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/custom_agents/user/my-agent": { "get": { "tags": [ "Custom Agents" ], "summary": "Get Custom Agents By User", "description": "Get custom agents submitted by the authenticated user.\n\nArgs:\n username: Authenticated username\n db: Database session\n\nReturns:\n List of all custom agents for users", "operationId": "get_custom_agents_by_user_api_v1_custom_agents_user_my_agent_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomAgentListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/custom_agents/user/submit": { "post": { "tags": [ "Custom Agents" ], "summary": "Submit Custom Agent", "description": "Upload a new custom agent.\n- Admin: auto-active, extracted, dependencies installed\n- User: pending approval", "operationId": "submit_custom_agent_api_v1_custom_agents_user_submit_post", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_submit_custom_agent_api_v1_custom_agents_user_submit_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomAgentOnboardResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/custom_agents/{agent_id}/version": { "post": { "tags": [ "Custom Agents" ], "summary": "Update Custom Agent", "description": "Upload a new version of a custom agent.\n\nArgs:\n agent_id: ID of the agent\n username: Authenticated username\n db: Database session\n\nReturns:\n Response message and status", "operationId": "update_custom_agent_api_v1_custom_agents__agent_id__version_post", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_update_custom_agent_api_v1_custom_agents__agent_id__version_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomAgentUpdateResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/custom_agents/{agent_id}/approve": { "post": { "tags": [ "Custom Agents" ], "summary": "Approve Custom Agent", "description": "Approve a custom agent (admin-only).\n extract to runtime directory\n\nArgs:\n agent_id: ID of the agent\n username: Authenticated username\n db: Database session\n\nReturns:\n Approval confirmation", "operationId": "approve_custom_agent_api_v1_custom_agents__agent_id__approve_post", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomAgentToggleResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/custom_agents/{agent_id}/decline": { "post": { "tags": [ "Custom Agents" ], "summary": "Decline Custom Agent", "description": "Decline a custom agent (admin-only).\n\nArgs:\n agent_id: ID of the agent\n username: Authenticated username\n db: Database session\n\nReturns:\n Decline confirmation", "operationId": "decline_custom_agent_api_v1_custom_agents__agent_id__decline_post", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentDeclineRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomAgentToggleResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/custom_agents/{agent_id}": { "delete": { "tags": [ "Custom Agents" ], "summary": "Remove Custom Agent By Id", "description": "Remove a custom agent by its stable id.\n\nThis is the route the admin agent management UI uses to delete an\nagent — id-keyed like its sibling admin actions (version/approve/decline/\ndownload), so it isn't exposed to free-text agent-name encoding/whitespace\nmismatches the way the legacy name-keyed route below is.\n\nArgs:\n agent_id: ID of the agent\n username: Authenticated username\n db: Database session\n\nReturns:\n Removal confirmation", "operationId": "remove_custom_agent_by_id_api_v1_custom_agents__agent_id__delete", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Agent Id" } }, { "name": "allow_force_delete", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Allow Force Delete" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomAgentRemoveResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/custom_agents/user/{agent_name}": { "delete": { "tags": [ "Custom Agents" ], "summary": "Remove Custom Agent", "description": "Remove a custom agent by name (self-service route).\n\nArgs:\n agent_name: Name of the agent\n username: Authenticated username\n db: Database session\n\nReturns:\n Removal confirmation", "operationId": "remove_custom_agent_api_v1_custom_agents_user__agent_name__delete", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "agent_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Name" } }, { "name": "allow_force_delete", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Allow Force Delete" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomAgentRemoveResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/custom_agents/{agent_id}/feedback": { "post": { "tags": [ "Custom Agents" ], "summary": "Feedback Custom Agent", "description": "Submit feedback for a custom agent (admin-only).\n\nArgs:\n agent_id (str): _description_\n feedback_request (AgentFeedbackRequest): _description_\n username (str, optional): _description_. Defaults to Depends(verify_api_token).\n db (Session, optional): _description_. Defaults to Depends(get_db).\n\nReturns:\n feedback submit confirm", "operationId": "feedback_custom_agent_api_v1_custom_agents__agent_id__feedback_post", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentFeedbackRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomAgentFeedbackResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/custom_agents/{agent_id}/download": { "get": { "tags": [ "Custom Agents" ], "summary": "Download Custom Agent", "description": "Download custom agent package (admin and owner).\n\nArgs:\n agent_id (str): ID of the agent\n username (str, optional): Authenticated username. Defaults to Depends(verify_api_token).\n db (Session, optional): Database session. Defaults to Depends(get_db).\n\nReturns:\n FileResponse: The .ncp package file for download", "operationId": "download_custom_agent_api_v1_custom_agents__agent_id__download_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomAgentDownloadResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/custom_agents/user/can-submit-agent": { "get": { "tags": [ "Custom Agents" ], "summary": "Can Submit Custom Agent", "description": "Check if the user can submit a new agent.\n\nArgs:\n username (str, optional): The username of the authenticated user. Defaults to Depends(verify_api_token).\n db (Session, optional): The database session. Defaults to Depends(get_db).\n\nReturns:\n CustomAgentSubmitResponse: The response indicating if the user have the permission to submit a new agent.", "operationId": "can_submit_custom_agent_api_v1_custom_agents_user_can_submit_agent_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomAgentSubmitResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/custom_agents/onboard": { "post": { "tags": [ "Custom Agents" ], "summary": "Onboard Custom Agent", "description": "Onboard a custom agent from .ncp package (admin-only).\n\nThis endpoint is called by `ncp onboard` command.\nUnlike SDK deploy, custom agents:\n- Run integrated within platform (no container)\n- Are available to users based on role permissions\n- Go directly to ACTIVE status (admin upload = immediate activation)\n\nArgs:\n file: .ncp package file (tar.gz)\n update: Optional agent name to update\n username: Authenticated username from API key\n db: Database session\n\nReturns:\n Onboard status and agent information", "operationId": "onboard_custom_agent_api_v1_custom_agents_onboard_post", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "update", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Update" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_onboard_custom_agent_api_v1_custom_agents_onboard_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomAgentOnboardResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/custom_agents/list": { "get": { "tags": [ "Custom Agents" ], "summary": "List Custom Agents", "description": "List all custom agents (admin-only).\n\nArgs:\n username: Authenticated username\n db: Database session\n\nReturns:\n List of all custom agents", "operationId": "list_custom_agents_api_v1_custom_agents_list_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomAgentListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/custom_agents/background-eligible": { "get": { "tags": [ "Custom Agents" ], "summary": "List Background Eligible Agents", "description": "List custom agents eligible for background scheduling.\n\nReturns all active custom agents — every active agent can be used in a\nbackground job; no additional flag required.", "operationId": "list_background_eligible_agents_api_v1_custom_agents_background_eligible_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomAgentListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/custom_agents/{agent_name}": { "get": { "tags": [ "Custom Agents" ], "summary": "Get Custom Agent", "description": "Get details of a custom agent (admin-only).\n\nArgs:\n agent_name: Name of the agent\n username: Authenticated username\n db: Database session\n\nReturns:\n Agent details", "operationId": "get_custom_agent_api_v1_custom_agents__agent_name__get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "agent_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Name" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomAgentStatusResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Custom Agents" ], "summary": "Remove Custom Agent", "description": "Remove a custom agent (admin-only).\n\nArgs:\n agent_name: Name of the agent\n username: Authenticated username\n db: Database session\n\nReturns:\n Removal confirmation", "operationId": "remove_custom_agent_api_v1_custom_agents__agent_name__delete", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "agent_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Name" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomAgentRemoveResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/custom_agents/{agent_name}/disable": { "post": { "tags": [ "Custom Agents" ], "summary": "Disable Custom Agent", "description": "Disable a custom agent (admin-only).\n\nDisabled agents are not loaded into the orchestrator.\n\nArgs:\n agent_name: Name of the agent\n username: Authenticated username\n db: Database session\n\nReturns:\n Updated agent status", "operationId": "disable_custom_agent_api_v1_custom_agents__agent_name__disable_post", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "agent_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Name" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomAgentToggleResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/custom_agents/{agent_name}/enable": { "post": { "tags": [ "Custom Agents" ], "summary": "Enable Custom Agent", "description": "Enable a disabled custom agent (admin-only).\n\nArgs:\n agent_name: Name of the agent\n username: Authenticated username\n db: Database session\n\nReturns:\n Updated agent status", "operationId": "enable_custom_agent_api_v1_custom_agents__agent_name__enable_post", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "agent_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Name" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomAgentToggleResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/custom_agents/{agent_name}/enable-background": { "post": { "tags": [ "Custom Agents" ], "summary": "Enable Custom Agent Background", "description": "Allow a custom agent to be scheduled as a background job (admin-only).\n\nBackground jobs run unattended, without a user in the loop. Not every\nagent is safe for that mode — long-running agents, agents that ask\nclarifying questions, and agents with destructive actions warrant\nexplicit admin approval before being offered in the scheduler picker.", "operationId": "enable_custom_agent_background_api_v1_custom_agents__agent_name__enable_background_post", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "agent_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Name" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/custom_agents/{agent_name}/disable-background": { "post": { "tags": [ "Custom Agents" ], "summary": "Disable Custom Agent Background", "description": "Revoke a custom agent's background-scheduling eligibility (admin-only).\n\nDoes NOT touch existing scheduled jobs — those will fail at their next\nfire with a clear 'agent_unavailable' reason, which surfaces a failure\nnotification to the job creator.", "operationId": "disable_custom_agent_background_api_v1_custom_agents__agent_name__disable_background_post", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "agent_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Name" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/background_jobs/cron/preview": { "post": { "tags": [ "Background Jobs" ], "summary": "Preview Cron", "description": "Validate a CRON expression and return the next 5 fire times.\n\nUsed by the Job Creation wizard's \"Schedule\" step so the user can sanity\ncheck the schedule before submitting.", "operationId": "preview_cron_api_v1_background_jobs_cron_preview_post", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CronPreviewRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CronPreviewResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/background_jobs/user/can-create": { "get": { "tags": [ "Background Jobs" ], "summary": "Can Create Background Job Endpoint", "description": "Whether the caller's role can create / trigger background jobs.\n\nUsed by the FE to gate the \"Schedule a job\" entry points (wizard\nstarter button, Run-now / Edit actions, etc.). Returns ``true`` for\nadmins, \"Power user\", and any custom role with\n``can_create_background_job=true``.", "operationId": "can_create_background_job_endpoint_api_v1_background_jobs_user_can_create_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundJobPermissionResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/background_jobs": { "post": { "tags": [ "Background Jobs" ], "summary": "Create Background Job", "description": "Create a recurring background job.\n\nValidates the agent + CRON + project membership, persists the row, then\nregisters the schedule in redbeat. Same code path the LLM tool uses.", "operationId": "create_background_job_api_v1_background_jobs_post", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundJobCreateRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundJobResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Background Jobs" ], "summary": "List Background Jobs Endpoint", "description": "List jobs in a project.\n\nBy default returns only the caller's jobs (matches the LLM tool's\nbehaviour). Pass ``mine_only=false`` to see all jobs in the project\n(useful for project-admin views and the Admin Console).", "operationId": "list_background_jobs_endpoint_api_v1_background_jobs_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "type": "integer", "description": "Project whose jobs to list.", "title": "Project Id" }, "description": "Project whose jobs to list." }, { "name": "mine_only", "in": "query", "required": false, "schema": { "type": "boolean", "description": "If true, return only the caller's jobs.", "default": true, "title": "Mine Only" }, "description": "If true, return only the caller's jobs." }, { "name": "include_removed", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Include removed jobs.", "default": false, "title": "Include Removed" }, "description": "Include removed jobs." }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundJobListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/background_jobs/admin/all": { "get": { "tags": [ "Background Jobs" ], "summary": "Admin List All Background Jobs", "description": "List every background job across all projects with project names.\n\nRole-aware (matches the Data Connectors pattern):\n - Admins see every job in the system.\n - Non-admins see only the jobs they created — across every project\n they're a member of.\n\nThe endpoint path stays ``/admin/all`` for backwards compatibility with\nthe existing FE hook; the gating moved from \"is admin?\" to \"filter by\ncreator for non-admins\".", "operationId": "admin_list_all_background_jobs_api_v1_background_jobs_admin_all_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "include_removed", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Include removed jobs.", "default": false, "title": "Include Removed" }, "description": "Include removed jobs." }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundJobListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/background_jobs/{job_id}": { "patch": { "tags": [ "Background Jobs" ], "summary": "Update Background Job", "description": "Edit an existing background job.\n\nOnly fields included in the request body are modified. If trigger_type or\ncron_expression changes, the redbeat entry is updated automatically.\nSwitching to 'manual' unregisters the schedule; switching to 'scheduled'\nre-registers it with the new (or existing) cron expression.", "operationId": "update_background_job_api_v1_background_jobs__job_id__patch", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Job Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundJobUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundJobResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Background Jobs" ], "summary": "Get Background Job", "description": "Fetch a single job. Accessible to any member of the job's project.", "operationId": "get_background_job_api_v1_background_jobs__job_id__get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Job Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundJobResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Background Jobs" ], "summary": "Remove Background Job Endpoint", "description": "Permanently remove a job. Unregisters the schedule, marks the job row\nremoved (soft delete for audit), and hard-deletes the result conversation\nso it disappears from the sidebar and the conversations table.", "operationId": "remove_background_job_endpoint_api_v1_background_jobs__job_id__delete", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Job Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundJobResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/background_jobs/{job_id}/run-now": { "post": { "tags": [ "Background Jobs" ], "summary": "Run Background Job Now", "description": "Trigger an immediate one-off run of an existing job.\n\nBacks the \"Run now\" button on the success card and the Admin Console.\nEnqueues the same Celery task that the CRON schedule fires; the task\nholds its own Redis lock per job_id so concurrent triggers are\nnaturally serialized.\n\nValid for both ``scheduled`` and ``manual`` jobs. A removed job is\nnot runnable.", "operationId": "run_background_job_now_api_v1_background_jobs__job_id__run_now_post", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Job Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/background_jobs/{job_id}/pause": { "post": { "tags": [ "Background Jobs" ], "summary": "Pause Background Job Endpoint", "description": "Pause an active job — unregisters the redbeat entry; the DB row is\npreserved so the job can be resumed later. No-op if already paused.", "operationId": "pause_background_job_endpoint_api_v1_background_jobs__job_id__pause_post", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Job Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundJobResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/background_jobs/{job_id}/resume": { "post": { "tags": [ "Background Jobs" ], "summary": "Resume Background Job Endpoint", "description": "Resume a paused job — re-registers it in redbeat using its stored\ncron_expression. No-op if already active.", "operationId": "resume_background_job_endpoint_api_v1_background_jobs__job_id__resume_post", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Job Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundJobResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/background_jobs/{job_id}/runs": { "get": { "tags": [ "Background Jobs" ], "summary": "List Background Job Runs", "description": "List a job's runs and basic aggregates.\n\nBacks the Job Detail screen: the \"Execution history\" table plus the\nTotal runs / Success rate / Average duration stat cards. Each run row\nis derived from a single assistant message in the job's result\nconversation that carries a ``background_job_run`` card.", "operationId": "list_background_job_runs_api_v1_background_jobs__job_id__runs_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Job Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundJobRunsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/background_jobs/{job_id}/runs/{message_id}": { "get": { "tags": [ "Background Jobs" ], "summary": "Get Background Job Run", "description": "Fetch a single run's metadata and output.\n\nBacks the Run Detail screen (Run #N). ``message_id`` is the id of the\nassistant message that holds the run's card and output — the same\nhandle returned by ``list_background_job_runs``.", "operationId": "get_background_job_run_api_v1_background_jobs__job_id__runs__message_id__get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Job Id" } }, { "name": "message_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Message Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundJobRunDetail" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/data_connectors/validate": { "post": { "tags": [ "DataConnectors" ], "summary": "Validate Connector", "operationId": "validate_connector_api_v1_data_connectors_validate_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerToken": [] } ] } }, "/api/v1/roles_and_permissions": { "get": { "tags": [ "Roles" ], "summary": "Get All Roles", "operationId": "get_all_roles_api_v1_roles_and_permissions_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BearerToken": [] } ] }, "post": { "tags": [ "Roles" ], "summary": "Create Role", "operationId": "create_role_api_v1_roles_and_permissions_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerToken": [] } ] } }, "/api/v1/roles_and_permissions/{role_id}": { "put": { "tags": [ "Roles" ], "summary": "Update Role", "operationId": "update_role_api_v1_roles_and_permissions__role_id__put", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "role_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Role Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Roles" ], "summary": "Delete Role", "operationId": "delete_role_api_v1_roles_and_permissions__role_id__delete", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "role_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Role Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Roles" ], "summary": "Get Role", "operationId": "get_role_api_v1_roles_and_permissions__role_id__get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "role_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Role Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/roles_and_permissions/custom_agents": { "get": { "tags": [ "Roles" ], "summary": "Get All Custom Agents", "description": "Get all active custom agents for UI dropdowns.\n\nUsed when creating/editing roles to show available CustomAgents options.\n\nReturns:\n List of active custom agents with basic info", "operationId": "get_all_custom_agents_api_v1_roles_and_permissions_custom_agents_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BearerToken": [] } ] } }, "/api/v1/roles_and_permissions/reassign_users": { "post": { "tags": [ "Roles" ], "summary": "Reassign Users", "operationId": "reassign_users_api_v1_roles_and_permissions_reassign_users_post", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "to_role_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "To Role Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleOption" }, "title": "Userlists" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/roles_and_permissions/get_role_by_username/{username}": { "get": { "tags": [ "Roles" ], "summary": "Get Role By Username", "operationId": "get_role_by_username_api_v1_roles_and_permissions_get_role_by_username__username__get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "username", "in": "path", "required": true, "schema": { "type": "string", "title": "Username" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/roles_and_permissions/get_users_by_role/{role_id}": { "get": { "tags": [ "Roles" ], "summary": "Get Users By Role", "operationId": "get_users_by_role_api_v1_roles_and_permissions_get_users_by_role__role_id__get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "role_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Role Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/roles_and_permissions/custom_agents/{role_id}": { "get": { "tags": [ "Roles" ], "summary": "Get Custom Agents By Role", "description": "Get custom agents assigned to a specific role.\n\nArgs:\n role_id: Role ID to get assigned agents for\n\nReturns:\n List of custom agents assigned to the role", "operationId": "get_custom_agents_by_role_api_v1_roles_and_permissions_custom_agents__role_id__get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "role_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Role Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/dashboard/metrics": { "get": { "tags": [ "Dashboard" ], "summary": "Get Dashboard Metrics", "operationId": "get_dashboard_metrics_api_v1_dashboard_metrics_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "range_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^(1d|2d|7d|30d|60d|90d|365d)$" }, { "type": "null" } ], "title": "Range Type" } }, { "name": "from_ts", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "From Ts" } }, { "name": "to_ts", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "To Ts" } }, { "name": "granularity", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^(hour|day|week|month)$", "default": "day", "title": "Granularity" } }, { "name": "authorization", "in": "header", "required": true, "schema": { "type": "string", "description": "Access token", "title": "Authorization" }, "description": "Access token" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/dashboard/token-savings": { "get": { "tags": [ "Dashboard" ], "summary": "Get Token Savings", "description": "Headroom context-compression token savings for the Monitor page.\n\nReturns summary totals (stat card) plus a [[ts_ms, tokens_saved], ...]\ntimeseries (chart), aggregated from messages.token_savings. Pass llm_name\n(same as /metrics/gpu) to report only the selected model's savings.", "operationId": "get_token_savings_api_v1_dashboard_token_savings_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "days", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 365, "minimum": 1, "default": 30, "title": "Days" } }, { "name": "project_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Project Id" } }, { "name": "llm_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Scope savings to one LLM (the Monitor page's selected model)", "title": "Llm Name" }, "description": "Scope savings to one LLM (the Monitor page's selected model)" }, { "name": "authorization", "in": "header", "required": true, "schema": { "type": "string", "description": "Access token", "title": "Authorization" }, "description": "Access token" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/dashboard/metrics/system": { "get": { "tags": [ "Dashboard" ], "summary": "Get System Metrics", "operationId": "get_system_metrics_api_v1_dashboard_metrics_system_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "start_time", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Start Time" } }, { "name": "end_time", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End Time" } }, { "name": "authorization", "in": "header", "required": true, "schema": { "type": "string", "description": "Access token", "title": "Authorization" }, "description": "Access token" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/dashboard/metrics/gpu": { "get": { "tags": [ "Dashboard" ], "summary": "Get Gpu Metrics", "operationId": "get_gpu_metrics_api_v1_dashboard_metrics_gpu_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "llm_name", "in": "query", "required": true, "schema": { "type": "string", "description": "LLM model name to filter GPU stats", "title": "Llm Name" }, "description": "LLM model name to filter GPU stats" }, { "name": "start_time", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Start Time" } }, { "name": "end_time", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End Time" } }, { "name": "authorization", "in": "header", "required": true, "schema": { "type": "string", "description": "Access token", "title": "Authorization" }, "description": "Access token" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/dashboard/metrics/docker": { "get": { "tags": [ "Dashboard" ], "summary": "Get Docker Stats", "description": "Returns the latest docker stats for tabular display.", "operationId": "get_docker_stats_api_v1_dashboard_metrics_docker_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": true, "schema": { "type": "string", "description": "Access token", "title": "Authorization" }, "description": "Access token" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/dashboard/logs/generate": { "post": { "tags": [ "Dashboard" ], "summary": "Generate Logs", "description": "Trigger log generation asynchronously. Reads logs from the local\ndocker daemon, so no host/credentials are required from the caller.", "operationId": "generate_logs_api_v1_dashboard_logs_generate_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BearerToken": [] } ] } }, "/api/v1/dashboard/logs/download/{log_id}": { "get": { "tags": [ "Dashboard" ], "summary": "Download Logs", "description": "API to download the zipped logs from the DB by ID.", "operationId": "download_logs_api_v1_dashboard_logs_download__log_id__get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "log_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Log Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/dashboard/logs/list": { "get": { "tags": [ "Dashboard" ], "summary": "List Logs", "description": "API to list all log archives.", "operationId": "list_logs_api_v1_dashboard_logs_list_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BearerToken": [] } ] } }, "/api/v1/organizations": { "get": { "tags": [ "Organizations" ], "summary": "List Organizations", "operationId": "list_organizations_api_v1_organizations_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "authorization", "in": "header", "required": true, "schema": { "type": "string", "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationResponse" }, "title": "Response List Organizations Api V1 Organizations Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Organizations" ], "summary": "Create Organization", "operationId": "create_organization_api_v1_organizations_post", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "authorization", "in": "header", "required": true, "schema": { "type": "string", "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/organizations/{org_id}": { "put": { "tags": [ "Organizations" ], "summary": "Update Organization", "operationId": "update_organization_api_v1_organizations__org_id__put", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Org Id" } }, { "name": "authorization", "in": "header", "required": true, "schema": { "type": "string", "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Organizations" ], "summary": "Delete Organization", "description": "Hard delete - permanently delete an organization. Fails if users are associated.", "operationId": "delete_organization_api_v1_organizations__org_id__delete", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Org Id" } }, { "name": "authorization", "in": "header", "required": true, "schema": { "type": "string", "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/organizations/{org_id}/users": { "patch": { "tags": [ "Organizations" ], "summary": "Assign Users To Organization", "description": "Assign one or more users to an organization. Replaces their current org assignment.", "operationId": "assign_users_to_organization_api_v1_organizations__org_id__users_patch", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Org Id" } }, { "name": "authorization", "in": "header", "required": true, "schema": { "type": "string", "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignUsersRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignUsersResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Organizations" ], "summary": "User Organization", "description": "List all users assigned to an organization.", "operationId": "user_organization_api_v1_organizations__org_id__users_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Org Id" } }, { "name": "authorization", "in": "header", "required": true, "schema": { "type": "string", "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/organizations/{org_id}/deactivate": { "patch": { "tags": [ "Organizations" ], "summary": "Deactivate Organization", "description": "Soft delete - deactivate an organization.", "operationId": "deactivate_organization_api_v1_organizations__org_id__deactivate_patch", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Org Id" } }, { "name": "authorization", "in": "header", "required": true, "schema": { "type": "string", "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audit/events": { "get": { "tags": [ "Audit" ], "summary": "Search Events", "description": "Search audit events (proxied to ones-audit-service).\n\n``start``/``end`` are epoch milliseconds → ONES ``from``/``to``. When omitted\nthe window defaults to all-time (so older and runtime events aren't hidden by\nthe ONES 24h default). ``limit`` → ONES ``size``.\n\nOrg filtering is **optional** (``?org=``). Audit read is a privileged\nsuper-admin capability that may span organizations by design (per PRD), so\nresults are not auto-scoped to the caller's org; passing ``org`` narrows them\nto that organization. The id is validated to exist — a non-existent org is a\n404, not a silent empty 200 (NCP-3912). Platform/runtime events (agent/llm/\ntool) that carry no ``org_id`` remain visible regardless of the filter.\n\n``execution_id`` has no server-side filter on ones-audit-service today (its\n``/events`` search has no ``correlationId`` predicate), so it's applied as a\nbest-effort post-filter over the fetched page here — it narrows the current\npage's results rather than the underlying query, so a small ``limit`` may\nundercount matches. Proper support requires adding a ``correlationId``\nfilter to ones-audit-service itself.", "operationId": "search_events_api_v1_audit_events_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "event_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Event Type" } }, { "name": "event_class", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Event Class" } }, { "name": "user_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id" } }, { "name": "execution_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Execution Id" } }, { "name": "result", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Result" } }, { "name": "start", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Start" } }, { "name": "end", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "End" } }, { "name": "org", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "default": 50, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audit/events/{event_id}": { "get": { "tags": [ "Audit" ], "summary": "Get Event", "description": "Retrieve a single audit event by id (proxied), org-scoped.", "operationId": "get_event_api_v1_audit_events__event_id__get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "event_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Event Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audit/export": { "get": { "tags": [ "Audit" ], "summary": "Export Events", "description": "Export the filtered audit set (proxied). Emits an export.audit_log event.\n\n``start``/``end`` are epoch milliseconds and map to the ONES ``from``/``to``\nparams, which are **required** on the export endpoint — if omitted we default\nto the last 7 days.\n\nOrg scoping (NCP-3911): pass ``?org=`` to export only that organization's\nevents (forwarded to ones-audit-service as ``orgId``). The current admin role\nis a global super-admin, so an unscoped export returns all organizations; the\norg filter lets it be narrowed to (and downloaded per) a single org. A\nnon-existent org id is rejected (404) rather than silently exporting nothing\n(NCP-3912). The org used is recorded on the ``export.audit_log`` audit-of-audit\nevent below, so a cross-org (all-org) export is itself traceable.", "operationId": "export_events_api_v1_audit_export_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "fmt", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^(csv|json|ndjson)$", "default": "csv", "title": "Fmt" } }, { "name": "event_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Event Type" } }, { "name": "start", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Start" } }, { "name": "end", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "End" } }, { "name": "org", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audit/prompt/{execution_id}": { "get": { "tags": [ "Audit" ], "summary": "Recall Prompt", "description": "Recall raw prompt/response text for an execution from the LOCAL store.\n\nServed entirely by ncp-api (raw text never lives in ONES). Every recall is\nitself audited as ``export.prompt.recalled`` (Must-11).", "operationId": "recall_prompt_api_v1_audit_prompt__execution_id__get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "execution_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Execution Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audit/export/jobs": { "get": { "tags": [ "Audit" ], "summary": "List Export Jobs", "description": "Download History — the caller's own export jobs, newest first.", "operationId": "list_export_jobs_api_v1_audit_export_jobs_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BearerToken": [] } ] }, "post": { "tags": [ "Audit" ], "summary": "Create Export Job", "description": "Queue an async audit export. Returns the pending job; poll it via\n``GET /audit/export/jobs/{id}`` and download when ``status == completed``.\n\nEmits an ``export.audit_log`` event (audit-of-audit) recording the request.", "operationId": "create_export_job_api_v1_audit_export_jobs_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportJobRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerToken": [] } ] } }, "/api/v1/audit/export/jobs/{job_id}": { "get": { "tags": [ "Audit" ], "summary": "Get Export Job", "description": "Poll a single export job's status/metadata.", "operationId": "get_export_job_api_v1_audit_export_jobs__job_id__get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/audit/export/jobs/{job_id}/download": { "get": { "tags": [ "Audit" ], "summary": "Download Export Job", "description": "Download a completed export artifact. 409 while it's still building,\n404 if the artifact is missing/expired.", "operationId": "download_export_job_api_v1_audit_export_jobs__job_id__download_get", "security": [ { "BearerToken": [] } ], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "components": { "schemas": { "AdminFileCreateResponse": { "properties": { "filename": { "type": "string", "maxLength": 255, "title": "Filename" }, "source": { "type": "string", "maxLength": 255, "title": "Source" }, "description": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "title": "Description" }, "storage_path": { "type": "string", "maxLength": 512, "title": "Storage Path" }, "uploader_username": { "type": "string", "maxLength": 255, "title": "Uploader Username" }, "access_level": { "anyOf": [ { "type": "string", "maxLength": 50 }, { "type": "null" } ], "title": "Access Level", "default": "public" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "organization_id": { "type": "integer", "title": "Organization Id" }, "active_status": { "anyOf": [ { "type": "string", "maxLength": 50 }, { "type": "null" } ], "title": "Active Status", "default": "active" }, "processing_status": { "anyOf": [ { "type": "string", "maxLength": 50 }, { "type": "null" } ], "title": "Processing Status", "default": "uploaded" }, "stage": { "anyOf": [ { "type": "string", "maxLength": 50 }, { "type": "null" } ], "title": "Stage" }, "failure_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Failure Reason" } }, "type": "object", "required": [ "filename", "source", "storage_path", "uploader_username", "organization_id" ], "title": "AdminFileCreateResponse" }, "AdminFileResponse": { "properties": { "filename": { "type": "string", "maxLength": 255, "title": "Filename" }, "source": { "type": "string", "maxLength": 255, "title": "Source" }, "description": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "title": "Description" }, "storage_path": { "type": "string", "maxLength": 512, "title": "Storage Path" }, "uploader_username": { "type": "string", "maxLength": 255, "title": "Uploader Username" }, "access_level": { "anyOf": [ { "type": "string", "maxLength": 50 }, { "type": "null" } ], "title": "Access Level", "default": "public" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "organization_id": { "type": "integer", "title": "Organization Id" }, "active_status": { "anyOf": [ { "type": "string", "maxLength": 50 }, { "type": "null" } ], "title": "Active Status", "default": "active" }, "processing_status": { "anyOf": [ { "type": "string", "maxLength": 50 }, { "type": "null" } ], "title": "Processing Status", "default": "uploaded" }, "stage": { "anyOf": [ { "type": "string", "maxLength": 50 }, { "type": "null" } ], "title": "Stage" }, "failure_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Failure Reason" }, "file_id": { "type": "integer", "title": "File Id" }, "uploaded_at": { "type": "string", "format": "date-time", "title": "Uploaded At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "profile": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Profile" } }, "type": "object", "required": [ "filename", "source", "storage_path", "uploader_username", "organization_id", "file_id", "uploaded_at" ], "title": "AdminFileResponse" }, "AdminFileUpdate": { "properties": { "filename": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filename" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "uploaded_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Uploaded At" }, "storage_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Storage Path" }, "uploader_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Uploader Username" }, "access_level": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Access Level" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "organization_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Organization Id" } }, "type": "object", "title": "AdminFileUpdate" }, "AdminPreferencesBase": { "properties": { "company_name": { "type": "string", "title": "Company Name" }, "company_logo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Company Logo" }, "user_session_timeout": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "User Session Timeout" }, "admin_session_timeout": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Admin Session Timeout" }, "archive_after_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Archive After Days" }, "notification_included": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Notification Included", "default": [] } }, "type": "object", "required": [ "company_name" ], "title": "AdminPreferencesBase" }, "AdminPreferencesCreate": { "properties": { "company_name": { "type": "string", "title": "Company Name" }, "company_logo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Company Logo" }, "user_session_timeout": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "User Session Timeout" }, "admin_session_timeout": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Admin Session Timeout" }, "archive_after_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Archive After Days" }, "notification_included": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Notification Included", "default": [] } }, "type": "object", "required": [ "company_name" ], "title": "AdminPreferencesCreate" }, "AdminPreferencesOut": { "properties": { "company_name": { "type": "string", "title": "Company Name" }, "company_logo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Company Logo" }, "user_session_timeout": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "User Session Timeout" }, "admin_session_timeout": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Admin Session Timeout" }, "archive_after_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Archive After Days" }, "notification_included": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Notification Included", "default": [] }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id" } }, "type": "object", "required": [ "company_name" ], "title": "AdminPreferencesOut" }, "AdminPreferencesUpdate": { "properties": { "company_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Company Name" }, "company_logo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Company Logo" }, "user_session_timeout": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "User Session Timeout" }, "admin_session_timeout": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Admin Session Timeout" }, "archive_after_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Archive After Days" }, "notification_included": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Notification Included" } }, "type": "object", "title": "AdminPreferencesUpdate" }, "AgentDeclineRequest": { "properties": { "feedback": { "type": "string", "title": "Feedback" } }, "type": "object", "required": [ "feedback" ], "title": "AgentDeclineRequest" }, "AgentFeedbackRequest": { "properties": { "message": { "type": "string", "title": "Message" }, "feedback_type": { "type": "string", "title": "Feedback Type" } }, "type": "object", "required": [ "message", "feedback_type" ], "title": "AgentFeedbackRequest" }, "AgentTracePermissionResponse": { "properties": { "canViewAgentTrace": { "type": "boolean", "title": "Canviewagenttrace" } }, "type": "object", "required": [ "canViewAgentTrace" ], "title": "AgentTracePermissionResponse" }, "AssignUsersRequest": { "properties": { "usernames": { "items": { "type": "string" }, "type": "array", "title": "Usernames" } }, "type": "object", "required": [ "usernames" ], "title": "AssignUsersRequest" }, "AssignUsersResponse": { "properties": { "assigned": { "items": { "type": "string" }, "type": "array", "title": "Assigned" }, "not_found": { "items": { "type": "string" }, "type": "array", "title": "Not Found" } }, "type": "object", "required": [ "assigned", "not_found" ], "title": "AssignUsersResponse" }, "BackgroundJobCreateRequest": { "properties": { "project_id": { "type": "integer", "title": "Project Id" }, "agent_name": { "type": "string", "title": "Agent Name" }, "prompt": { "type": "string", "maxLength": 4000, "minLength": 1, "title": "Prompt" }, "cron_expression": { "type": "string", "title": "Cron Expression" }, "timezone": { "type": "string", "title": "Timezone", "default": "UTC" }, "name": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ], "title": "Name" }, "notification_channels": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Notification Channels" }, "slack_channel_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Slack Channel Ids" } }, "type": "object", "required": [ "project_id", "agent_name", "prompt", "cron_expression" ], "title": "BackgroundJobCreateRequest" }, "BackgroundJobListResponse": { "properties": { "jobs": { "items": { "$ref": "#/components/schemas/BackgroundJobResponse" }, "type": "array", "title": "Jobs" }, "total": { "type": "integer", "title": "Total" } }, "type": "object", "required": [ "jobs", "total" ], "title": "BackgroundJobListResponse" }, "BackgroundJobPermissionResponse": { "properties": { "canCreateBackgroundJob": { "type": "boolean", "title": "Cancreatebackgroundjob" } }, "type": "object", "required": [ "canCreateBackgroundJob" ], "title": "BackgroundJobPermissionResponse", "description": "Whether the caller is allowed to create / trigger background jobs.\n\nField name mirrors ``CustomAgentSubmitResponse.submitAgent`` so the FE\nhas a consistent \"permission probe\" shape across features." }, "BackgroundJobResponse": { "properties": { "job_id": { "type": "string", "title": "Job Id" }, "project_id": { "type": "integer", "title": "Project Id" }, "project_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Name" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "agent_name": { "type": "string", "title": "Agent Name" }, "prompt": { "type": "string", "title": "Prompt" }, "trigger_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Trigger Type" }, "cron_expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cron Expression" }, "timezone": { "type": "string", "title": "Timezone" }, "status": { "type": "string", "title": "Status" }, "creator_username": { "type": "string", "title": "Creator Username" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "last_run_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Run At" }, "last_run_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Run Status" }, "last_conversation_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Last Conversation Id" }, "next_run_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Next Run At" }, "unread_count": { "type": "integer", "title": "Unread Count", "default": 0 }, "notification_channels": { "items": { "type": "string" }, "type": "array", "title": "Notification Channels" }, "slack_channel_ids": { "items": { "type": "string" }, "type": "array", "title": "Slack Channel Ids" } }, "type": "object", "required": [ "job_id", "project_id", "name", "agent_name", "prompt", "timezone", "status", "creator_username", "created_at", "last_run_at", "last_run_status", "last_conversation_id" ], "title": "BackgroundJobResponse" }, "BackgroundJobRunDetail": { "properties": { "job_id": { "type": "string", "title": "Job Id" }, "message_id": { "type": "integer", "title": "Message Id" }, "run_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Run At" }, "status": { "type": "string", "title": "Status" }, "duration_seconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Duration Seconds" }, "output": { "type": "string", "title": "Output", "default": "" }, "ui_resources": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Ui Resources" }, "timeline": { "items": { "$ref": "#/components/schemas/BackgroundJobRunTimelineEntry" }, "type": "array", "title": "Timeline" }, "usage": { "anyOf": [ { "$ref": "#/components/schemas/BackgroundJobRunUsage" }, { "type": "null" } ] }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" } }, "type": "object", "required": [ "job_id", "message_id", "status" ], "title": "BackgroundJobRunDetail", "description": "Single-run payload — backs the Run Detail screen." }, "BackgroundJobRunSummary": { "properties": { "message_id": { "type": "integer", "title": "Message Id" }, "run_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Run At" }, "status": { "type": "string", "title": "Status" }, "duration_seconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Duration Seconds" }, "total_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Tokens" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" } }, "type": "object", "required": [ "message_id", "status" ], "title": "BackgroundJobRunSummary", "description": "One row in the execution-history table." }, "BackgroundJobRunTimelineEntry": { "properties": { "phase": { "type": "string", "title": "Phase" }, "at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "At" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" } }, "type": "object", "required": [ "phase" ], "title": "BackgroundJobRunTimelineEntry", "description": "One high-level event in the run's execution timeline.\n\n``phase`` is one of:\n - ``started`` — agent boot\n - ``tool`` — tool invocation finished (success or error). Carries\n ``name``, ``status`` (\"ok\" | \"error\"), and ``error``\n when status is \"error\".\n - ``completed`` — agent finished successfully\n - ``failed`` — agent raised an exception (carries ``error``)\n\nTool arguments and tool results are NOT captured here — by design. The\ntimeline is the \"what happened, in order\" — not a reasoning log." }, "BackgroundJobRunUsage": { "properties": { "total_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Tokens" }, "prompt_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Prompt Tokens" }, "completion_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Completion Tokens" }, "iterations": { "type": "integer", "title": "Iterations", "default": 0 }, "mcp_connectors_used": { "items": { "type": "string" }, "type": "array", "title": "Mcp Connectors Used" }, "kb_files_used": { "items": { "type": "string" }, "type": "array", "title": "Kb Files Used" } }, "type": "object", "title": "BackgroundJobRunUsage", "description": "Aggregate LLM usage and resource touch-points for a single run." }, "BackgroundJobRunsResponse": { "properties": { "job_id": { "type": "string", "title": "Job Id" }, "runs": { "items": { "$ref": "#/components/schemas/BackgroundJobRunSummary" }, "type": "array", "title": "Runs" }, "total_runs": { "type": "integer", "title": "Total Runs" }, "succeeded_runs": { "type": "integer", "title": "Succeeded Runs" }, "failed_runs": { "type": "integer", "title": "Failed Runs" }, "skipped_runs": { "type": "integer", "title": "Skipped Runs" }, "success_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Success Rate", "description": "Ratio of succeeded runs to runs with a definite outcome (succeeded + failed). None if there have been no such runs yet." }, "avg_duration_seconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Avg Duration Seconds", "description": "Mean wall-clock duration over runs that reported one." } }, "type": "object", "required": [ "job_id", "runs", "total_runs", "succeeded_runs", "failed_runs", "skipped_runs" ], "title": "BackgroundJobRunsResponse" }, "BackgroundJobUpdateRequest": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ], "title": "Name" }, "prompt": { "anyOf": [ { "type": "string", "maxLength": 4000, "minLength": 1 }, { "type": "null" } ], "title": "Prompt" }, "agent_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agent Name" }, "trigger_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Trigger Type" }, "cron_expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cron Expression" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Timezone" }, "notification_channels": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Notification Channels" }, "slack_channel_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Slack Channel Ids" } }, "type": "object", "title": "BackgroundJobUpdateRequest" }, "Body_deploy_sdk_agent_api_v1_sdk_agents_deploy_post": { "properties": { "file": { "type": "string", "title": "File", "format": "binary" } }, "type": "object", "required": [ "file" ], "title": "Body_deploy_sdk_agent_api_v1_sdk_agents_deploy_post" }, "Body_login_with_cert_api_v1_user_authentication_login_with_cert_post": { "properties": { "file": { "type": "string", "title": "File", "format": "binary" }, "password": { "type": "string", "title": "Password" } }, "type": "object", "required": [ "file" ], "title": "Body_login_with_cert_api_v1_user_authentication_login_with_cert_post" }, "Body_onboard_custom_agent_api_v1_custom_agents_onboard_post": { "properties": { "file": { "type": "string", "title": "File", "format": "binary" } }, "type": "object", "required": [ "file" ], "title": "Body_onboard_custom_agent_api_v1_custom_agents_onboard_post" }, "Body_submit_custom_agent_api_v1_custom_agents_user_submit_post": { "properties": { "file": { "type": "string", "title": "File", "format": "binary" } }, "type": "object", "required": [ "file" ], "title": "Body_submit_custom_agent_api_v1_custom_agents_user_submit_post" }, "Body_sync_admin_files_api_v1_admin_files_sync_files_post": { "properties": { "directory_path": { "type": "string", "title": "Directory Path" }, "uploader_username": { "type": "string", "title": "Uploader Username" }, "organization_id": { "type": "integer", "title": "Organization Id", "default": 1 } }, "type": "object", "required": [ "directory_path", "uploader_username" ], "title": "Body_sync_admin_files_api_v1_admin_files_sync_files_post" }, "Body_update_custom_agent_api_v1_custom_agents__agent_id__version_post": { "properties": { "file": { "type": "string", "title": "File", "format": "binary" } }, "type": "object", "required": [ "file" ], "title": "Body_update_custom_agent_api_v1_custom_agents__agent_id__version_post" }, "Body_upload_file_api_v1_knowledge_base_upload_post": { "properties": { "file": { "type": "string", "title": "File", "format": "binary" }, "description": { "type": "string", "title": "Description" } }, "type": "object", "required": [ "file" ], "title": "Body_upload_file_api_v1_knowledge_base_upload_post" }, "Body_upload_files_api_v1_admin_files_upload_post": { "properties": { "uploader_username": { "type": "string", "title": "Uploader Username" }, "metadata": { "type": "string", "title": "Metadata" }, "files": { "items": { "type": "string", "format": "binary" }, "type": "array", "title": "Files" } }, "type": "object", "required": [ "uploader_username", "metadata", "files" ], "title": "Body_upload_files_api_v1_admin_files_upload_post" }, "Body_upload_files_api_v1_projects__project_id__files_post": { "properties": { "files": { "items": { "type": "string", "format": "binary" }, "type": "array", "title": "Files" } }, "type": "object", "required": [ "files" ], "title": "Body_upload_files_api_v1_projects__project_id__files_post" }, "CronPreviewRequest": { "properties": { "cron_expression": { "type": "string", "title": "Cron Expression", "description": "5-field CRON: 'minute hour dom month dow'." }, "timezone": { "type": "string", "title": "Timezone", "description": "IANA tz name used to render the next-run timestamps.", "default": "UTC" } }, "type": "object", "required": [ "cron_expression" ], "title": "CronPreviewRequest" }, "CronPreviewResponse": { "properties": { "valid": { "type": "boolean", "title": "Valid" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "human_readable": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Human Readable" }, "next_runs": { "items": { "type": "string" }, "type": "array", "title": "Next Runs", "description": "ISO-8601 timestamps in the requested timezone." }, "min_interval_minutes": { "type": "integer", "title": "Min Interval Minutes", "default": 5 }, "suggestion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Suggestion" } }, "type": "object", "required": [ "valid" ], "title": "CronPreviewResponse" }, "CustomAgentAdminResponse": { "properties": { "agent_id": { "type": "integer", "title": "Agent Id" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "status": { "$ref": "#/components/schemas/CustomAgentStatus" }, "version": { "type": "string", "title": "Version" }, "submitted_by": { "type": "string", "title": "Submitted By" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message" }, "reviewed_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reviewed By" }, "reviewed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Reviewed At" }, "rejection_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rejection Reason" }, "status_changed_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status Changed By" }, "status_changed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Status Changed At" }, "submitted_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Submitted At" }, "assigned_roles": { "items": { "type": "string" }, "type": "array", "title": "Assigned Roles", "default": [] }, "feedback_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Feedback Message" } }, "type": "object", "required": [ "agent_id", "name", "status", "version", "submitted_by" ], "title": "CustomAgentAdminResponse", "description": "Response for agent status/details." }, "CustomAgentDownloadResponse": { "properties": { "message": { "type": "string", "title": "Message" }, "agent_name": { "type": "string", "title": "Agent Name" } }, "type": "object", "required": [ "message", "agent_name" ], "title": "CustomAgentDownloadResponse", "description": "Response for agent package download." }, "CustomAgentFeedbackResponse": { "properties": { "message": { "type": "string", "title": "Message" }, "agent_name": { "type": "string", "title": "Agent Name" } }, "type": "object", "required": [ "message", "agent_name" ], "title": "CustomAgentFeedbackResponse", "description": "Response for agent feedback submission." }, "CustomAgentListAdminResponse": { "properties": { "agents": { "items": { "$ref": "#/components/schemas/CustomAgentAdminResponse" }, "type": "array", "title": "Agents" }, "total": { "type": "integer", "title": "Total" } }, "type": "object", "required": [ "agents", "total" ], "title": "CustomAgentListAdminResponse", "description": "Response for listing custom agents for Admin." }, "CustomAgentListResponse": { "properties": { "agents": { "items": { "$ref": "#/components/schemas/CustomAgentStatusResponse" }, "type": "array", "title": "Agents" }, "total": { "type": "integer", "title": "Total" } }, "type": "object", "required": [ "agents", "total" ], "title": "CustomAgentListResponse", "description": "Response for listing custom agents." }, "CustomAgentOnboardResponse": { "properties": { "message": { "type": "string", "title": "Message" }, "agent_id": { "type": "integer", "title": "Agent Id" }, "agent_name": { "type": "string", "title": "Agent Name" }, "status": { "$ref": "#/components/schemas/CustomAgentStatus" } }, "type": "object", "required": [ "message", "agent_id", "agent_name", "status" ], "title": "CustomAgentOnboardResponse", "description": "Response for agent onboarding." }, "CustomAgentRemoveResponse": { "properties": { "message": { "type": "string", "title": "Message" }, "agent_name": { "type": "string", "title": "Agent Name" } }, "type": "object", "required": [ "message", "agent_name" ], "title": "CustomAgentRemoveResponse", "description": "Response for agent removal." }, "CustomAgentStatus": { "type": "string", "enum": [ "PENDING", "ACTIVE", "REJECTED", "DISABLED", "NEEDS_REVISION" ], "title": "CustomAgentStatus", "description": "Status of a custom agent.\n\nCurrent release uses: ACTIVE, DISABLED\nFuture release adds: PENDING, REJECTED (for UI approval workflow)" }, "CustomAgentStatusResponse": { "properties": { "agent_id": { "type": "integer", "title": "Agent Id" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "status": { "$ref": "#/components/schemas/CustomAgentStatus" }, "version": { "type": "string", "title": "Version" }, "submitted_by": { "type": "string", "title": "Submitted By" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message" }, "supports_background": { "type": "boolean", "title": "Supports Background", "default": true }, "reviewed_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reviewed By" }, "reviewed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Reviewed At" }, "rejection_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rejection Reason" }, "feedback_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Feedback Message" } }, "type": "object", "required": [ "agent_id", "name", "status", "version", "submitted_by" ], "title": "CustomAgentStatusResponse", "description": "Response for agent status/details." }, "CustomAgentSubmitResponse": { "properties": { "submitAgent": { "type": "boolean", "title": "Submitagent" } }, "type": "object", "required": [ "submitAgent" ], "title": "CustomAgentSubmitResponse", "description": "Response for agent submission." }, "CustomAgentToggleResponse": { "properties": { "message": { "type": "string", "title": "Message" }, "agent_name": { "type": "string", "title": "Agent Name" }, "status": { "$ref": "#/components/schemas/CustomAgentStatus" } }, "type": "object", "required": [ "message", "agent_name", "status" ], "title": "CustomAgentToggleResponse", "description": "Response for enabling/disabling agent." }, "CustomAgentUpdateResponse": { "properties": { "message": { "type": "string", "title": "Message" }, "agent_id": { "type": "integer", "title": "Agent Id" }, "agent_name": { "type": "string", "title": "Agent Name" }, "version": { "type": "string", "title": "Version" }, "status": { "$ref": "#/components/schemas/CustomAgentStatus" } }, "type": "object", "required": [ "message", "agent_id", "agent_name", "version", "status" ], "title": "CustomAgentUpdateResponse", "description": "Response for agent onboarding." }, "DataConnectorCreate": { "properties": { "data_connector_type": { "type": "string", "title": "Data Connector Type" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "connector_mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connector Mode" }, "config_details": { "additionalProperties": true, "type": "object", "title": "Config Details" }, "annotations": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Annotations" }, "collector_interval_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Collector Interval Seconds" }, "dataconnector_tags": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dataconnector Tags" }, "dataconnector_tags_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Dataconnector Tags Meta" }, "org_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Org Id" } }, "type": "object", "required": [ "data_connector_type", "config_details" ], "title": "DataConnectorCreate" }, "DataConnectorProjectResponse": { "properties": { "project_data_connector_id": { "type": "integer", "title": "Project Data Connector Id" }, "project_id": { "type": "integer", "title": "Project Id" }, "data_connector_id": { "type": "integer", "title": "Data Connector Id" }, "is_enabled": { "type": "boolean", "title": "Is Enabled" }, "last_status_change_at": { "type": "string", "format": "date-time", "title": "Last Status Change At" } }, "type": "object", "required": [ "project_data_connector_id", "project_id", "data_connector_id", "is_enabled", "last_status_change_at" ], "title": "DataConnectorProjectResponse" }, "DataConnectorUpdate": { "properties": { "data_connector_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Data Connector Type" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "connector_mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connector Mode" }, "config_details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Config Details" }, "annotations": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Annotations" }, "collector_interval_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Collector Interval Seconds" }, "dataconnector_tags": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dataconnector Tags" }, "dataconnector_tags_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Dataconnector Tags Meta" } }, "type": "object", "title": "DataConnectorUpdate" }, "EntityType": { "type": "string", "enum": [ "LLMs", "DataConnectors", "Users", "Files", "CustomAgents", "Devices", "DeviceCredentialType" ], "title": "EntityType" }, "ExportJobRequest": { "properties": { "fmt": { "type": "string", "title": "Fmt", "default": "csv" }, "event_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Event Type" }, "start": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Start" }, "end": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "End" } }, "type": "object", "title": "ExportJobRequest" }, "ExportPreviewResponse": { "properties": { "filename": { "type": "string", "title": "Filename" }, "export_format": { "type": "string", "title": "Export Format" }, "thumbnail_base64": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Thumbnail Base64" }, "columns": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Columns" }, "rows": { "anyOf": [ { "items": { "items": {}, "type": "array" }, "type": "array" }, { "type": "null" } ], "title": "Rows" }, "total_rows": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Rows" }, "total_columns": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Columns" }, "truncated_columns": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Truncated Columns" } }, "type": "object", "required": [ "filename", "export_format" ], "title": "ExportPreviewResponse" }, "ExportedFileResponse": { "properties": { "export_id": { "type": "integer", "title": "Export Id" }, "project_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Project Id" }, "conversation_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Conversation Id" }, "message_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Message Id" }, "requested_by": { "type": "string", "title": "Requested By" }, "filename": { "type": "string", "title": "Filename" }, "storage_path": { "type": "string", "title": "Storage Path" }, "file_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Type" }, "file_size_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "File Size Bytes" }, "export_format": { "type": "string", "title": "Export Format" }, "source_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Description" }, "status": { "type": "string", "title": "Status" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At" }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Expires At" }, "download_count": { "type": "integer", "title": "Download Count" } }, "type": "object", "required": [ "export_id", "requested_by", "filename", "storage_path", "export_format", "status", "created_at", "download_count" ], "title": "ExportedFileResponse" }, "FileCreateResponse": { "properties": { "project_id": { "type": "integer", "title": "Project Id" }, "uploader_username": { "type": "string", "maxLength": 255, "title": "Uploader Username" }, "filename": { "type": "string", "maxLength": 255, "title": "Filename" }, "storage_path": { "type": "string", "maxLength": 512, "title": "Storage Path" }, "file_type": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ], "title": "File Type" }, "file_size_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "File Size Bytes" }, "processing_status": { "anyOf": [ { "type": "string", "maxLength": 50 }, { "type": "null" } ], "title": "Processing Status", "default": "uploaded" }, "stage": { "anyOf": [ { "type": "string", "maxLength": 50 }, { "type": "null" } ], "title": "Stage" }, "failure_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Failure Reason" } }, "type": "object", "required": [ "project_id", "uploader_username", "filename", "storage_path" ], "title": "FileCreateResponse" }, "FileInfoResponse": { "properties": { "project_id": { "type": "integer", "title": "Project Id" }, "uploader_username": { "type": "string", "maxLength": 255, "title": "Uploader Username" }, "filename": { "type": "string", "maxLength": 255, "title": "Filename" }, "storage_path": { "type": "string", "maxLength": 512, "title": "Storage Path" }, "file_type": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ], "title": "File Type" }, "file_size_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "File Size Bytes" }, "processing_status": { "anyOf": [ { "type": "string", "maxLength": 50 }, { "type": "null" } ], "title": "Processing Status", "default": "uploaded" }, "stage": { "anyOf": [ { "type": "string", "maxLength": 50 }, { "type": "null" } ], "title": "Stage" }, "failure_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Failure Reason" }, "file_id": { "type": "integer", "title": "File Id" }, "uploaded_at": { "type": "string", "format": "date-time", "title": "Uploaded At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "profile": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Profile" } }, "type": "object", "required": [ "project_id", "uploader_username", "filename", "storage_path", "file_id", "uploaded_at" ], "title": "FileInfoResponse" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "LDAPConfigCreate": { "properties": { "host": { "type": "string", "title": "Host" }, "port": { "type": "integer", "title": "Port", "default": 389 }, "base_dn": { "type": "string", "title": "Base Dn" }, "admin_cn": { "type": "string", "title": "Admin Cn" }, "admin_password": { "type": "string", "title": "Admin Password" }, "ou": { "type": "string", "title": "Ou" }, "auth_type": { "type": "string", "title": "Auth Type" } }, "type": "object", "required": [ "host", "base_dn", "admin_cn", "admin_password", "ou", "auth_type" ], "title": "LDAPConfigCreate" }, "LDAPConfigResponse": { "properties": { "id": { "type": "integer", "title": "Id" }, "host": { "type": "string", "title": "Host" }, "port": { "type": "integer", "title": "Port" }, "base_dn": { "type": "string", "title": "Base Dn" }, "admin_cn": { "type": "string", "title": "Admin Cn" }, "ou": { "type": "string", "title": "Ou" }, "auth_type": { "type": "string", "title": "Auth Type" } }, "type": "object", "required": [ "id", "host", "port", "base_dn", "admin_cn", "ou", "auth_type" ], "title": "LDAPConfigResponse" }, "LDAPConfigUpdate": { "properties": { "host": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Host" }, "port": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Port" }, "base_dn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Base Dn" }, "admin_cn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Admin Cn" }, "admin_password": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Admin Password" }, "ou": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ou" }, "auth_type": { "type": "string", "title": "Auth Type" } }, "type": "object", "required": [ "auth_type" ], "title": "LDAPConfigUpdate" }, "LLMConfigCreate": { "properties": { "model_name": { "type": "string", "title": "Model Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Username" }, "password": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Password" }, "api_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" }, "auth_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth Method", "default": "api_key" }, "is_default": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Default", "default": false }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status", "default": "Inactive" }, "reasoning_effort": { "anyOf": [ { "type": "string", "enum": [ "none", "minimal", "low", "medium", "high" ] }, { "type": "null" } ], "title": "Reasoning Effort" }, "org_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Org Id" } }, "type": "object", "required": [ "model_name" ], "title": "LLMConfigCreate" }, "LLMConfigResponse": { "properties": { "id": { "type": "integer", "title": "Id" }, "model_name": { "type": "string", "title": "Model Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Username" }, "auth_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth Method", "default": "api_key" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status", "default": "Inactive" }, "is_default": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Default", "default": false }, "connected_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Connected At" }, "last_sync": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Sync" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" }, "project": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ProjectBase" }, "type": "array" }, { "type": "null" } ], "title": "Project" }, "is_compliance": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Compliance", "default": true }, "max_token": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Token" }, "reasoning_effort": { "anyOf": [ { "type": "string", "enum": [ "none", "minimal", "low", "medium", "high" ] }, { "type": "null" } ], "title": "Reasoning Effort" } }, "type": "object", "required": [ "id", "model_name" ], "title": "LLMConfigResponse" }, "LLMConfigUpdate": { "properties": { "model_name": { "type": "string", "title": "Model Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Username" }, "password": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Password" }, "api_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" }, "auth_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth Method", "default": "api_key" }, "is_default": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Default", "default": false }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status", "default": "Inactive" }, "reasoning_effort": { "anyOf": [ { "type": "string", "enum": [ "none", "minimal", "low", "medium", "high" ] }, { "type": "null" } ], "title": "Reasoning Effort" } }, "type": "object", "required": [ "model_name" ], "title": "LLMConfigUpdate" }, "LoginModel": { "properties": { "username": { "type": "string", "title": "Username" }, "password": { "type": "string", "title": "Password" }, "ou": { "type": "string", "title": "Ou" } }, "type": "object", "required": [ "username", "password" ], "title": "LoginModel" }, "MemberCreateRequest": { "properties": { "username": { "type": "string", "title": "Username" } }, "type": "object", "required": [ "username" ], "title": "MemberCreateRequest" }, "MemberResponse": { "properties": { "project_member_id": { "type": "integer", "title": "Project Member Id" }, "username": { "type": "string", "title": "Username" }, "project_id": { "type": "integer", "title": "Project Id" }, "role": { "type": "string", "title": "Role" }, "joined_at": { "type": "string", "format": "date-time", "title": "Joined At" } }, "type": "object", "required": [ "project_member_id", "username", "project_id", "role", "joined_at" ], "title": "MemberResponse" }, "MessageRequest": { "properties": { "message": { "type": "string", "title": "Message" } }, "type": "object", "required": [ "message" ], "title": "MessageRequest" }, "NotificationCreate": { "properties": { "message": { "type": "string", "title": "Message" }, "created_by": { "type": "string", "title": "Created By" }, "notification_type": { "type": "string", "pattern": "^(system|user)$", "title": "Notification Type" }, "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action" }, "file_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "File Id" }, "related_to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Related To" }, "avatar_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avatar Path" }, "project_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Project Id" }, "mentioned_user": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mentioned User" } }, "type": "object", "required": [ "message", "created_by", "notification_type" ], "title": "NotificationCreate" }, "NotificationResponse": { "properties": { "message": { "type": "string", "title": "Message" }, "created_by": { "type": "string", "title": "Created By" }, "notification_type": { "type": "string", "pattern": "^(system|user)$", "title": "Notification Type" }, "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action" }, "file_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "File Id" }, "related_to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Related To" }, "avatar_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avatar Path" }, "project_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Project Id" }, "mentioned_user": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mentioned User" }, "id": { "type": "integer", "title": "Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "viewed": { "type": "boolean", "title": "Viewed" } }, "type": "object", "required": [ "message", "created_by", "notification_type", "id", "created_at", "viewed" ], "title": "NotificationResponse" }, "OrganizationCreate": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" } }, "type": "object", "required": [ "name" ], "title": "OrganizationCreate" }, "OrganizationResponse": { "properties": { "id": { "type": "integer", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "is_active": { "type": "boolean", "title": "Is Active" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "user": { "type": "integer", "title": "User" }, "usernames": { "items": { "$ref": "#/components/schemas/UserInfo" }, "type": "array", "title": "Usernames", "default": [] } }, "type": "object", "required": [ "id", "name", "description", "is_active", "created_at", "user" ], "title": "OrganizationResponse" }, "OrganizationUpdate": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active" } }, "type": "object", "title": "OrganizationUpdate" }, "PinnedProjectResponse": { "properties": { "project_id": { "type": "integer", "title": "Project Id" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "pinned_at": { "type": "string", "format": "date-time", "title": "Pinned At" }, "is_archived": { "type": "boolean", "title": "Is Archived", "default": false } }, "type": "object", "required": [ "project_id", "name", "description", "pinned_at" ], "title": "PinnedProjectResponse" }, "PlatformAgentCatalogResponse": { "properties": { "agents": { "items": { "$ref": "#/components/schemas/PlatformAgentSchema" }, "type": "array", "title": "Agents" }, "total": { "type": "integer", "title": "Total" } }, "type": "object", "required": [ "agents", "total" ], "title": "PlatformAgentCatalogResponse", "description": "Response for GET /platform-agents catalog endpoint." }, "PlatformAgentExecuteRequest": { "properties": { "query": { "type": "string", "title": "Query", "description": "The task or question to send to the agent" }, "project_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Project Id", "description": "Project ID for connector-scoped execution. Omit for admin-level access." } }, "type": "object", "required": [ "query" ], "title": "PlatformAgentExecuteRequest", "description": "Request for POST /platform-agents/{name}/execute." }, "PlatformAgentExecuteResponse": { "properties": { "success": { "type": "boolean", "title": "Success" }, "result": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Result" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "agent_name": { "type": "string", "title": "Agent Name" } }, "type": "object", "required": [ "success", "agent_name" ], "title": "PlatformAgentExecuteResponse", "description": "Response for POST /platform-agents/{name}/execute." }, "PlatformAgentSchema": { "properties": { "name": { "type": "string", "title": "Name", "description": "Agent name (used in platform.agent() calls)" }, "description": { "type": "string", "title": "Description", "description": "What the agent does" }, "requires_connector": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Requires Connector", "description": "Connector type required (e.g., 'ELK', 'Splunk'), null if none required" }, "input_schema": { "additionalProperties": true, "type": "object", "title": "Input Schema", "description": "JSON schema for the agent's input parameters" }, "tools": { "items": { "$ref": "#/components/schemas/PlatformToolSchema" }, "type": "array", "title": "Tools", "description": "Internal tools available within this agent" } }, "type": "object", "required": [ "name", "description", "input_schema" ], "title": "PlatformAgentSchema", "description": "Schema for a single platform agent in the catalog." }, "PlatformToolSchema": { "properties": { "name": { "type": "string", "title": "Name", "description": "Tool name" }, "description": { "type": "string", "title": "Description", "description": "What the tool does" } }, "type": "object", "required": [ "name", "description" ], "title": "PlatformToolSchema", "description": "Schema for an internal tool within a platform agent." }, "ProjectBase": { "properties": { "org_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Org Id" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "is_archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Archived", "default": false }, "archived_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Archived At" }, "llm_config_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Llm Config Id" } }, "type": "object", "required": [ "name" ], "title": "ProjectBase" }, "ProjectCreateRequest": { "properties": { "org_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Org Id" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "is_archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Archived", "default": false }, "archived_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Archived At" }, "llm_config_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Llm Config Id" }, "username": { "type": "string", "title": "Username" } }, "type": "object", "required": [ "name", "username" ], "title": "ProjectCreateRequest" }, "ProjectDataConnectorResponse": { "properties": { "project_id": { "type": "integer", "title": "Project Id" }, "data_connector_id": { "type": "integer", "title": "Data Connector Id" }, "is_enabled": { "type": "boolean", "title": "Is Enabled", "default": true }, "project_data_connector_id": { "type": "integer", "title": "Project Data Connector Id" }, "last_status_change_at": { "type": "string", "format": "date-time", "title": "Last Status Change At" } }, "type": "object", "required": [ "project_id", "data_connector_id", "project_data_connector_id", "last_status_change_at" ], "title": "ProjectDataConnectorResponse" }, "ProjectDataConnectorUpdate": { "properties": { "is_enabled": { "type": "boolean", "title": "Is Enabled", "default": true } }, "type": "object", "title": "ProjectDataConnectorUpdate" }, "ProjectResponse": { "properties": { "org_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Org Id" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "is_archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Archived", "default": false }, "archived_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Archived At" }, "llm_config_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Llm Config Id" }, "project_id": { "type": "integer", "title": "Project Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" } }, "type": "object", "required": [ "name", "project_id", "created_at", "updated_at" ], "title": "ProjectResponse" }, "ProjectUpdateRequest": { "properties": { "org_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Org Id" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "is_archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Archived", "default": false }, "archived_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Archived At" }, "llm_config_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Llm Config Id" } }, "type": "object", "required": [ "name" ], "title": "ProjectUpdateRequest" }, "RocketChatCreate": { "properties": { "server_url": { "type": "string", "title": "Server Url" }, "room_name": { "type": "string", "title": "Room Name" }, "username": { "type": "string", "title": "Username" }, "password": { "type": "string", "title": "Password" } }, "type": "object", "required": [ "server_url", "room_name", "username", "password" ], "title": "RocketChatCreate" }, "RocketChatGet": { "properties": { "server_url": { "type": "string", "title": "Server Url" }, "room_name": { "type": "string", "title": "Room Name" }, "username": { "type": "string", "title": "Username" }, "password": { "type": "string", "title": "Password" }, "id": { "type": "integer", "title": "Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "server_url", "room_name", "username", "password", "id", "created_at" ], "title": "RocketChatGet" }, "RoleCreate": { "properties": { "role_name": { "type": "string", "title": "Role Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "created_by": { "type": "string", "title": "Created By" }, "can_submit_agent": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Can Submit Agent", "default": false }, "can_create_background_job": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Can Create Background Job", "default": false }, "can_view_agent_trace": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Can View Agent Trace", "default": false }, "options": { "items": { "$ref": "#/components/schemas/RoleOption" }, "type": "array", "title": "Options" }, "nav_permission": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Nav Permission" }, "action_permission": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Action Permission" }, "is_editable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Editable", "default": true } }, "type": "object", "required": [ "role_name", "created_by", "options" ], "title": "RoleCreate" }, "RoleOption": { "properties": { "entity_name": { "type": "string", "title": "Entity Name" }, "entity_type": { "anyOf": [ { "$ref": "#/components/schemas/EntityType" }, { "type": "null" } ] }, "entity_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Entity Id" } }, "type": "object", "required": [ "entity_name" ], "title": "RoleOption" }, "RoleResponse": { "properties": { "role_id": { "type": "integer", "title": "Role Id" }, "role_name": { "type": "string", "title": "Role Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "created_by": { "type": "string", "title": "Created By" }, "can_submit_agent": { "type": "boolean", "title": "Can Submit Agent" }, "can_create_background_job": { "type": "boolean", "title": "Can Create Background Job" }, "can_view_agent_trace": { "type": "boolean", "title": "Can View Agent Trace" }, "options": { "items": { "$ref": "#/components/schemas/RoleOption" }, "type": "array", "title": "Options" }, "is_editable": { "type": "boolean", "title": "Is Editable" } }, "type": "object", "required": [ "role_id", "role_name", "created_by", "can_submit_agent", "can_create_background_job", "can_view_agent_trace", "options", "is_editable" ], "title": "RoleResponse" }, "RoleUpdate": { "properties": { "role_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role Name" }, "can_submit_agent": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Can Submit Agent" }, "can_create_background_job": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Can Create Background Job" }, "can_view_agent_trace": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Can View Agent Trace" }, "options": { "anyOf": [ { "items": { "$ref": "#/components/schemas/RoleOption" }, "type": "array" }, { "type": "null" } ], "title": "Options" }, "is_editable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Editable" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" } }, "type": "object", "title": "RoleUpdate" }, "SDKAgentDeployResponse": { "properties": { "message": { "type": "string", "title": "Message" }, "agent_id": { "type": "string", "title": "Agent Id" }, "agent_name": { "type": "string", "title": "Agent Name" }, "status": { "$ref": "#/components/schemas/SDKAgentStatus" } }, "type": "object", "required": [ "message", "agent_id", "agent_name", "status" ], "title": "SDKAgentDeployResponse", "description": "Response for agent deployment." }, "SDKAgentListResponse": { "properties": { "agents": { "items": { "$ref": "#/components/schemas/SDKAgentStatusResponse" }, "type": "array", "title": "Agents" }, "total": { "type": "integer", "title": "Total" } }, "type": "object", "required": [ "agents", "total" ], "title": "SDKAgentListResponse", "description": "Response for listing agents." }, "SDKAgentRemoveResponse": { "properties": { "message": { "type": "string", "title": "Message" }, "agent_name": { "type": "string", "title": "Agent Name" } }, "type": "object", "required": [ "message", "agent_name" ], "title": "SDKAgentRemoveResponse", "description": "Response for agent removal." }, "SDKAgentStatus": { "type": "string", "enum": [ "PENDING", "DEPLOYING", "RUNNING", "STOPPED", "FAILED", "REMOVED" ], "title": "SDKAgentStatus", "description": "Status of an SDK agent deployment." }, "SDKAgentStatusResponse": { "properties": { "agent_id": { "type": "string", "title": "Agent Id" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "status": { "$ref": "#/components/schemas/SDKAgentStatus" }, "version": { "type": "string", "title": "Version" }, "deployed_by": { "type": "string", "title": "Deployed By" }, "deployed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Deployed At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message" } }, "type": "object", "required": [ "agent_id", "name", "status", "version", "deployed_by" ], "title": "SDKAgentStatusResponse", "description": "Response for agent status." }, "SDKAuthRequest": { "properties": { "username": { "type": "string", "title": "Username", "description": "Username" }, "password": { "type": "string", "title": "Password", "description": "Password" } }, "type": "object", "required": [ "username", "password" ], "title": "SDKAuthRequest", "description": "Request for SDK authentication." }, "SDKAuthResponse": { "properties": { "message": { "type": "string", "title": "Message" }, "api_key": { "type": "string", "title": "Api Key", "description": "JWT token for SDK API access" }, "username": { "type": "string", "title": "Username" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First Name" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Name" } }, "type": "object", "required": [ "message", "api_key", "username" ], "title": "SDKAuthResponse", "description": "Response for SDK authentication." }, "SearchResponse": { "properties": { "results": { "items": { "$ref": "#/components/schemas/SearchResultItem" }, "type": "array", "title": "Results" } }, "type": "object", "required": [ "results" ], "title": "SearchResponse" }, "SearchResultItem": { "properties": { "conversation_id": { "type": "integer", "title": "Conversation Id" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "match_type": { "type": "string", "enum": [ "title", "message" ], "title": "Match Type" }, "snippet": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Snippet" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "conversation_id", "match_type", "created_at" ], "title": "SearchResultItem" }, "TagGroup": { "properties": { "type": { "type": "string", "title": "Type" }, "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags" }, "tags_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Tags Meta" }, "instances": { "items": { "$ref": "#/components/schemas/TagInstance" }, "type": "array", "title": "Instances" } }, "type": "object", "required": [ "type", "tags", "instances" ], "title": "TagGroup" }, "TagInstance": { "properties": { "id": { "type": "integer", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags" }, "tags_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Tags Meta" } }, "type": "object", "required": [ "id", "name", "tags" ], "title": "TagInstance" }, "UserInfo": { "properties": { "id": { "type": "integer", "title": "Id" }, "username": { "type": "string", "title": "Username" }, "firstname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Firstname" }, "lastname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lastname" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role" } }, "type": "object", "required": [ "id", "username" ], "title": "UserInfo" }, "UserModel": { "properties": { "cn": { "type": "string", "title": "Cn" }, "sn": { "type": "string", "title": "Sn" }, "given_name": { "type": "string", "title": "Given Name" }, "email": { "type": "string", "format": "email", "title": "Email" }, "password": { "type": "string", "title": "Password" } }, "type": "object", "required": [ "cn", "sn", "given_name", "email", "password" ], "title": "UserModel" }, "UserPreferencesBase": { "properties": { "user_id": { "type": "string", "title": "User Id" }, "notifications": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Notifications", "default": [] } }, "type": "object", "required": [ "user_id" ], "title": "UserPreferencesBase" }, "UserPreferencesCreate": { "properties": { "user_id": { "type": "string", "title": "User Id" }, "notifications": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Notifications", "default": [] } }, "type": "object", "required": [ "user_id" ], "title": "UserPreferencesCreate" }, "UserPreferencesUpdate": { "properties": { "notifications": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Notifications" } }, "type": "object", "title": "UserPreferencesUpdate" }, "ValidateRequest": { "properties": { "data_connector_type": { "type": "string", "title": "Data Connector Type" }, "config_details": { "additionalProperties": true, "type": "object", "title": "Config Details" } }, "type": "object", "required": [ "data_connector_type", "config_details" ], "title": "ValidateRequest" }, "ValidateResponse": { "properties": { "success": { "type": "boolean", "title": "Success" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "field_errors": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Field Errors" }, "details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Details" } }, "type": "object", "required": [ "success" ], "title": "ValidateResponse" }, "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" } }, "securitySchemes": { "BearerToken": { "type": "http", "description": "Enter your JWT token (without 'Bearer ' prefix)", "scheme": "bearer" } } } }