{ "openapi": "3.1.0", "info": { "title": "SeekrFlow API", "description": "SeekrFlow API Documentation", "termsOfService": "http://www.seekr.com/support", "contact": { "name": "Seekr API Support", "url": "http://www.seekr.com/contact", "email": "contact@seekr.com" }, "version": "5.99.0" }, "paths": { "/v1/flow/agents/": { "get": { "tags": [ "Agents" ], "summary": "List agents v1", "description": "Retrieve a list of all agents in your organization.", "operationId": "list_agents_v1_flow_agents__get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAgentsResponse" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/v1/flow/agents/{agent_id}": { "get": { "tags": [ "Agents" ], "summary": "Get agent v1", "operationId": "get_agent_by_id_v1_flow_agents__agent_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Retrieve an agent's configuration by ID." }, "patch": { "tags": [ "Agents" ], "summary": "Update agent v1", "description": "Partially update an agent's configuration. Omitted fields remain unchanged.", "operationId": "patch_v1_flow_agents__agent_id__patch", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchAgentRequest" }, "examples": { "preferred_tool_ids": { "summary": "Preferred usage using tool_ids", "value": { "name": "My Agent", "instructions": "You are a helpful assistant that can search files, browse the web, and run Python code.", "model_id": "deployment-123", "temperature": 0.4, "reasoning_effort": "medium", "tool_ids": [ "tool-123", "tool-456" ] } }, "legacy_tools_deprecated": { "summary": "Legacy usage using tools (deprecated)", "description": "DEPRECATED: Use tool_ids instead.", "value": { "name": "My Agent", "instructions": "You are a helpful assistant that can search files, browse the web, and run Python code.", "model_id": "deployment-123", "temperature": 0.4, "reasoning_effort": "medium", "tools": [ { "name": "file_search", "tool_env": { "file_search_index": "my-index", "document_tool_desc": "Search through documents", "top_k": 10, "score_threshold": 0.7 } }, { "name": "web_search", "tool_env": { "web_search_tool_description": "Search the web for current information" } }, { "name": "run_python", "tool_env": { "run_python_tool_desc": "Execute Python code", "function_ids": [ "func-123", "func-456" ] } }, { "name": "agent_as_tool", "agent_id": "ag-123...", "description": "Description of subagent tool." } ] } } } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Agents" ], "summary": "Delete agent v1", "description": "Permanently delete an agent by ID.", "operationId": "delete_v1_flow_agents__agent_id__delete", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentDeleteResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/flow/agents/create": { "post": { "tags": [ "Agents" ], "summary": "Create agent v1", "operationId": "create_v1_flow_agents_create_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAgentRequest" }, "examples": { "preferred_tool_ids": { "summary": "Preferred usage using tool_ids", "value": { "name": "My Agent", "instructions": "You are a helpful assistant that can search files, browse the web, and run Python code.", "model_id": "deployment-123", "temperature": 0.4, "reasoning_effort": "medium", "tool_ids": [ "tool-123", "tool-456" ] } }, "legacy_tools_deprecated": { "summary": "Legacy usage using tools (deprecated)", "description": "DEPRECATED: Use tool_ids instead.", "value": { "name": "My Agent", "instructions": "You are a helpful assistant that can search files, browse the web, and run Python code.", "model_id": "deployment-123", "temperature": 0.4, "reasoning_effort": "medium", "tools": [ { "name": "file_search", "tool_env": { "file_search_index": "my-index", "document_tool_desc": "Search through documents", "top_k": 10, "score_threshold": 0.7 } }, { "name": "web_search", "tool_env": { "web_search_tool_description": "Search the web for current information" } }, { "name": "run_python", "tool_env": { "run_python_tool_desc": "Execute Python code", "function_ids": [ "func-123", "func-456" ] } }, { "name": "agent_as_tool", "agent_id": "ag-123...", "description": "Description of subagent tool." } ] } } } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ], "description": "Create a new agent with a model, instructions, and optional tools." } }, "/v1/flow/agents/{agent_id}/update": { "put": { "tags": [ "Agents" ], "summary": "Replace agent v1", "description": "Update an agent's model, instructions, or tools.", "operationId": "update_v1_flow_agents__agent_id__update_put", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAgentRequest" }, "examples": { "preferred_tool_ids": { "summary": "Preferred usage using tool_ids", "value": { "name": "My Agent", "instructions": "You are a helpful assistant that can search files, browse the web, and run Python code.", "model_id": "deployment-123", "temperature": 0.4, "reasoning_effort": "medium", "tool_ids": [ "tool-123", "tool-456" ] } }, "legacy_tools_deprecated": { "summary": "Legacy usage using tools (deprecated)", "description": "DEPRECATED: Use tool_ids instead.", "value": { "name": "My Agent", "instructions": "You are a helpful assistant that can search files, browse the web, and run Python code.", "model_id": "deployment-123", "temperature": 0.4, "reasoning_effort": "medium", "tools": [ { "name": "file_search", "tool_env": { "file_search_index": "my-index", "document_tool_desc": "Search through documents", "top_k": 10, "score_threshold": 0.7 } }, { "name": "web_search", "tool_env": { "web_search_tool_description": "Search the web for current information" } }, { "name": "run_python", "tool_env": { "run_python_tool_desc": "Execute Python code", "function_ids": [ "func-123", "func-456" ] } }, { "name": "agent_as_tool", "agent_id": "ag-123...", "description": "Description of subagent tool." } ] } } } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/flow/agents/{agent_id}/promote": { "put": { "tags": [ "Agents" ], "summary": "Promote agent v1", "operationId": "promote_v1_flow_agents__agent_id__promote_put", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Promote an agent to active status so it can serve requests." } }, "/v1/flow/agents/{agent_id}/demote": { "put": { "tags": [ "Agents" ], "summary": "Demote agent v1", "operationId": "demote_v1_flow_agents__agent_id__demote_put", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Demote an agent to inactive status." } }, "/v1/flow/agents/{agent_id}/diff": { "patch": { "tags": [ "Agents" ], "summary": "Preview agent update v1", "description": "Preview the changes a patch request would make to an agent without applying them. Returns a before-and-after diff of the affected fields.", "operationId": "diff_v1_flow_agents__agent_id__diff_patch", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchAgentRequest" }, "examples": { "preferred_tool_ids": { "summary": "Preferred usage using tool_ids", "value": { "name": "My Agent", "instructions": "You are a helpful assistant that can search files, browse the web, and run Python code.", "model_id": "deployment-123", "temperature": 0.4, "reasoning_effort": "medium", "tool_ids": [ "tool-123", "tool-456" ] } }, "legacy_tools_deprecated": { "summary": "Legacy usage using tools (deprecated)", "description": "DEPRECATED: Use tool_ids instead.", "value": { "name": "My Agent", "instructions": "You are a helpful assistant that can search files, browse the web, and run Python code.", "model_id": "deployment-123", "temperature": 0.4, "reasoning_effort": "medium", "tools": [ { "name": "file_search", "tool_env": { "file_search_index": "my-index", "document_tool_desc": "Search through documents", "top_k": 10, "score_threshold": 0.7 } }, { "name": "web_search", "tool_env": { "web_search_tool_description": "Search the web for current information" } }, { "name": "run_python", "tool_env": { "run_python_tool_desc": "Execute Python code", "function_ids": [ "func-123", "func-456" ] } }, { "name": "agent_as_tool", "agent_id": "ag-123...", "description": "Description of subagent tool." } ] } } } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchAgentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/flow/internal/agents/{agent_id}/update-status": { "patch": { "tags": [ "Agents" ], "summary": "Update Status", "description": "An internal-only endpoint (no built-in auth validation) to update the agent's status in the DB, if it exists.\n\nIf the provided status is 'Active', and the Agent's current status is NOT 'Active', the `last_deployed_at` field\nis also updated in the DB to reflect the current date/time.\n\nIf the provided status is changed to 'Failed' from any other status, the Agent yaml is deleted from the git repo,\nand the status is updated to 'Failed' in the DB.\n\nArguments:\n agent_id: the ID of the agent to update\n update_request: the AgentUpdateStatusRequest object from the body containing the new status\n\nReturns:\n An AgentUpdateStatusResponse containing the Agent's ID, old and new status.", "operationId": "update_status_v1_flow_internal_agents__agent_id__update_status_patch", "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentUpdateStatusRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentUpdateStatusResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-excluded": true } }, "/v2/flow/agents/": { "get": { "tags": [ "Agents V2" ], "summary": "List agents", "description": "Retrieve a list of all agents in your organization.", "operationId": "list_agents_v2_flow_agents__get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAgentsResponseV2" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/v2/flow/agents/{agent_id}": { "get": { "tags": [ "Agents V2" ], "summary": "Get agent", "operationId": "get_agent_by_id_v2_flow_agents__agent_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSchemaV2" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Retrieve an agent's configuration by ID." }, "patch": { "tags": [ "Agents V2" ], "summary": "Update agent", "description": "Partially update an agent's configuration. Omitted fields remain unchanged.", "operationId": "patch_v2_flow_agents__agent_id__patch", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchAgentRequest" }, "examples": { "preferred_tool_ids": { "summary": "Preferred usage using tool_ids", "value": { "name": "My Agent", "instructions": "You are a helpful assistant that can search files, browse the web, and run Python code.", "model_id": "deployment-123", "temperature": 0.4, "reasoning_effort": "medium", "tool_ids": [ "tool-123", "tool-456" ] } }, "legacy_tools_deprecated": { "summary": "Legacy usage using tools (deprecated)", "description": "DEPRECATED: Use tool_ids instead.", "value": { "name": "My Agent", "instructions": "You are a helpful assistant that can search files, browse the web, and run Python code.", "model_id": "deployment-123", "temperature": 0.4, "reasoning_effort": "medium", "tools": [ { "name": "file_search", "tool_env": { "file_search_index": "my-index", "document_tool_desc": "Search through documents", "top_k": 10, "score_threshold": 0.7 } }, { "name": "web_search", "tool_env": { "web_search_tool_description": "Search the web for current information" } }, { "name": "run_python", "tool_env": { "run_python_tool_desc": "Execute Python code", "function_ids": [ "func-123", "func-456" ] } }, { "name": "agent_as_tool", "agent_id": "ag-123...", "description": "Description of subagent tool." } ] } } } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSchemaV2" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Agents V2" ], "summary": "Delete agent", "description": "Permanently delete an agent by ID.", "operationId": "delete_v2_flow_agents__agent_id__delete", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentDeleteResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v2/flow/agents/create": { "post": { "tags": [ "Agents V2" ], "summary": "Create agent", "operationId": "create_v2_flow_agents_create_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAgentRequest" }, "examples": { "preferred_tool_ids": { "summary": "Preferred usage using tool_ids", "value": { "name": "My Agent", "instructions": "You are a helpful assistant that can search files, browse the web, and run Python code.", "model_id": "deployment-123", "temperature": 0.4, "reasoning_effort": "medium", "tool_ids": [ "tool-123", "tool-456" ] } }, "legacy_tools_deprecated": { "summary": "Legacy usage using tools (deprecated)", "description": "DEPRECATED: Use tool_ids instead.", "value": { "name": "My Agent", "instructions": "You are a helpful assistant that can search files, browse the web, and run Python code.", "model_id": "deployment-123", "temperature": 0.4, "reasoning_effort": "medium", "tools": [ { "name": "file_search", "tool_env": { "file_search_index": "my-index", "document_tool_desc": "Search through documents", "top_k": 10, "score_threshold": 0.7 } }, { "name": "web_search", "tool_env": { "web_search_tool_description": "Search the web for current information" } }, { "name": "run_python", "tool_env": { "run_python_tool_desc": "Execute Python code", "function_ids": [ "func-123", "func-456" ] } }, { "name": "agent_as_tool", "agent_id": "ag-123...", "description": "Description of subagent tool." } ] } } } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSchemaV2" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ], "description": "Create a new agent with a model, instructions, and optional tools." } }, "/v2/flow/agents/{agent_id}/update": { "put": { "tags": [ "Agents V2" ], "summary": "Replace agent", "description": "Update an agent's model, instructions, or tools.", "operationId": "update_v2_flow_agents__agent_id__update_put", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAgentRequest" }, "examples": { "preferred_tool_ids": { "summary": "Preferred usage using tool_ids", "value": { "name": "My Agent", "instructions": "You are a helpful assistant that can search files, browse the web, and run Python code.", "model_id": "deployment-123", "temperature": 0.4, "reasoning_effort": "medium", "tool_ids": [ "tool-123", "tool-456" ] } }, "legacy_tools_deprecated": { "summary": "Legacy usage using tools (deprecated)", "description": "DEPRECATED: Use tool_ids instead.", "value": { "name": "My Agent", "instructions": "You are a helpful assistant that can search files, browse the web, and run Python code.", "model_id": "deployment-123", "temperature": 0.4, "reasoning_effort": "medium", "tools": [ { "name": "file_search", "tool_env": { "file_search_index": "my-index", "document_tool_desc": "Search through documents", "top_k": 10, "score_threshold": 0.7 } }, { "name": "web_search", "tool_env": { "web_search_tool_description": "Search the web for current information" } }, { "name": "run_python", "tool_env": { "run_python_tool_desc": "Execute Python code", "function_ids": [ "func-123", "func-456" ] } }, { "name": "agent_as_tool", "agent_id": "ag-123...", "description": "Description of subagent tool." } ] } } } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSchemaV2" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v2/flow/agents/{agent_id}/promote": { "put": { "tags": [ "Agents V2" ], "summary": "Promote agent", "operationId": "promote_v2_flow_agents__agent_id__promote_put", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSchemaV2" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Promote an agent to active status so it can serve requests." } }, "/v2/flow/agents/{agent_id}/demote": { "put": { "tags": [ "Agents V2" ], "summary": "Demote agent", "operationId": "demote_v2_flow_agents__agent_id__demote_put", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSchemaV2" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Demote an agent to inactive status." } }, "/v2/flow/agents/{agent_id}/diff": { "patch": { "tags": [ "Agents V2" ], "summary": "Preview agent update", "description": "Preview the changes a patch request would make to an agent without applying them. Returns a before-and-after diff of the affected fields.", "operationId": "diff_v2_flow_agents__agent_id__diff_patch", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchAgentRequest" }, "examples": { "preferred_tool_ids": { "summary": "Preferred usage using tool_ids", "value": { "name": "My Agent", "instructions": "You are a helpful assistant that can search files, browse the web, and run Python code.", "model_id": "deployment-123", "temperature": 0.4, "reasoning_effort": "medium", "tool_ids": [ "tool-123", "tool-456" ] } }, "legacy_tools_deprecated": { "summary": "Legacy usage using tools (deprecated)", "description": "DEPRECATED: Use tool_ids instead.", "value": { "name": "My Agent", "instructions": "You are a helpful assistant that can search files, browse the web, and run Python code.", "model_id": "deployment-123", "temperature": 0.4, "reasoning_effort": "medium", "tools": [ { "name": "file_search", "tool_env": { "file_search_index": "my-index", "document_tool_desc": "Search through documents", "top_k": 10, "score_threshold": 0.7 } }, { "name": "web_search", "tool_env": { "web_search_tool_description": "Search the web for current information" } }, { "name": "run_python", "tool_env": { "run_python_tool_desc": "Execute Python code", "function_ids": [ "func-123", "func-456" ] } }, { "name": "agent_as_tool", "agent_id": "ag-123...", "description": "Description of subagent tool." } ] } } } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchAgentResponseV2" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v2/flow/internal/agents/{agent_id}/update-status": { "patch": { "tags": [ "Internal", "Agents V2" ], "summary": "Update Status", "description": "An internal-only endpoint (no built-in auth validation) to update the agent's status in the DB, if it exists.\n\nIf the provided status is 'Active', and the Agent's current status is NOT 'Active', the `last_deployed_at` field\nis also updated in the DB to reflect the current date/time.\n\nIf the provided status is changed to 'Failed' from any other status, the Agent yaml is deleted from the git repo,\nand the status is updated to 'Failed' in the DB.\n\nArguments:\n agent_id: the ID of the agent to update\n update_request: the AgentUpdateStatusRequest object from the body containing the new status\n\nReturns:\n An AgentUpdateStatusResponseV2 containing the Agent's ID, old and new status.", "operationId": "update_status_v2_flow_internal_agents__agent_id__update_status_patch", "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentUpdateStatusRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentUpdateStatusResponseV2" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-excluded": true } }, "/v1/flow/alignment": { "get": { "tags": [ "Alignment" ], "summary": "List alignment jobs", "description": "Retrieve a list of all alignment jobs in your organization.", "operationId": "alignment_list_v1_flow_alignment_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlignmentList" } } } } }, "deprecated": true, "security": [ { "APIKeyHeader": [] } ] } }, "/v1/flow/alignment/ingestion": { "get": { "tags": [ "Alignment" ], "summary": "List file conversion jobs", "description": "Retrieve a list of all file conversion jobs in your organization.", "operationId": "ingestion_list_v1_flow_alignment_ingestion_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IngestionList" } } } } }, "deprecated": true, "security": [ { "APIKeyHeader": [] } ] }, "post": { "tags": [ "Alignment" ], "summary": "Convert PDF files to markdown", "description": "Convert PDF files to Markdown format for use in alignment and fine-tuning.", "operationId": "ingest_files_v1_flow_alignment_ingestion_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IngestionRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IngestionResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "deprecated": true, "security": [ { "APIKeyHeader": [] } ] } }, "/v1/flow/alignment/ingestion/{ingestion_job_id}": { "get": { "tags": [ "Alignment" ], "summary": "Get file conversion job", "description": "Retrieve the status and file records for a specific file conversion job.", "operationId": "ingestion_get_v1_flow_alignment_ingestion__ingestion_job_id__get", "deprecated": true, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "ingestion_job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Ingestion Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IngestionResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/flow/alignment/{alignment_job_id}": { "get": { "tags": [ "Alignment" ], "summary": "Get alignment job", "description": "Retrieve the status and details of a specific alignment job.", "operationId": "alignment_get_v1_flow_alignment__alignment_job_id__get", "deprecated": true, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "alignment_job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Alignment Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlignmentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Alignment" ], "summary": "Delete alignment job", "operationId": "alignment_delete_v1_flow_alignment__alignment_job_id__delete", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "alignment_job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Alignment Job Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Permanently delete an alignment job." } }, "/v1/flow/alignment/generate": { "post": { "tags": [ "Alignment" ], "summary": "Generate training pairs", "description": "Generate instruction fine-tuning pairs from your data for use in alignment jobs.", "operationId": "alignment_generate_v1_flow_alignment_generate_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlignmentRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlignmentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "deprecated": true, "security": [ { "APIKeyHeader": [] } ] } }, "/v1/flow/alignment/{alignment_job_id}/cancel": { "post": { "tags": [ "Alignment" ], "summary": "Cancel alignment job", "description": "Cancel an alignment job that is queued or in progress.", "operationId": "cancel_alignment_job_v1_flow_alignment__alignment_job_id__cancel_post", "deprecated": true, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "alignment_job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Alignment Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlignmentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/flow/alignment/{alignment_job_id}/workflow-phase": { "get": { "tags": [ "Alignment", "Internal" ], "summary": "Alignment Workflow Phase", "description": "Internal: the live Argo workflow phase for an alignment job.\n\nNot part of the public SDK. Lets the integration suite confirm a cancelled\njob's workflow actually terminated (the DB `cancelled` write alone doesn't\nprove the Argo stop landed). ``phase`` is None when the workflow was never\nstarted or no longer exists in Argo.", "operationId": "alignment_workflow_phase_v1_flow_alignment__alignment_job_id__workflow_phase_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "alignment_job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Alignment Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowPhaseResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-excluded": true } }, "/v1/flow/alignment/{alignment_job_id}/outputs": { "get": { "tags": [ "Alignment" ], "summary": "Get alignment metadata", "description": "Retrieve the output file metadata for a completed alignment job.", "operationId": "alignment_outputs_v1_flow_alignment__alignment_job_id__outputs_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "alignment_job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Alignment Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "title": "Response Alignment Outputs V1 Flow Alignment Alignment Job Id Outputs Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/flow/tools": { "post": { "tags": [ "Tools" ], "summary": "Create tool", "description": "Create a new tool that agents can use to extend their capabilities.", "operationId": "create_tool_v1_flow_tools_post", "security": [ { "APIKeyHeader": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/llm_training__agents__tools__standalone__schemas__CreateFileSearch" }, { "$ref": "#/components/schemas/llm_training__agents__tools__standalone__schemas__CreateRunPython" }, { "$ref": "#/components/schemas/llm_training__agents__tools__standalone__schemas__CreateWebSearch" }, { "$ref": "#/components/schemas/CreateAgentAsTool" }, { "$ref": "#/components/schemas/CreateMCPConnectorTool" } ], "title": "Request" }, "examples": { "file_search": { "summary": "File search request", "value": { "name": "my file search tool", "description": "contains files about ", "type": "file_search", "config": { "file_search_index": "my-document-index", "top_k": 10, "score_threshold": 0.7 } } }, "run_python": { "summary": "Code interpreter / Custom functions request", "value": { "name": "my python functions tool", "type": "run_python", "description": "Execute Python code for data analysis and calculations", "config": { "function_ids": [ "func-123", "func-456" ] } } }, "web_search": { "summary": "Web search request", "value": { "name": "my web search tool", "type": "web_search", "description": "Search the web for current information" } }, "agent_as_tool": { "summary": "Create agent as a tool request", "value": { "name": "sports history bot", "description": "an expert on the history of sports", "config": { "agent_id": "agent-00c6a3dc-4d32-4f52-9594-912aa345fffa" } } }, "mcp_connector": { "summary": "MCP Connector Tool request", "value": { "name": "mcp connector tool", "description": "MCP connector tool with external authorization", "type": "mcp_connector", "config": { "url": "https://example.com/mcp-connector" } } } } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/FileSearchResponse" }, { "$ref": "#/components/schemas/RunPythonResponse" }, { "$ref": "#/components/schemas/WebSearchResponse" }, { "$ref": "#/components/schemas/AgentAsToolResponse" }, { "$ref": "#/components/schemas/MCPConnectorToolResponse" } ], "discriminator": { "propertyName": "type", "mapping": { "file_search": "#/components/schemas/FileSearchResponse", "run_python": "#/components/schemas/RunPythonResponse", "web_search": "#/components/schemas/WebSearchResponse", "agent_as_tool": "#/components/schemas/AgentAsToolResponse", "mcp_connector": "#/components/schemas/MCPConnectorToolResponse" } }, "title": "Response Create Tool V1 Flow Tools Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Tools" ], "summary": "List tools", "description": "Retrieve a list of all tools in your organization.", "operationId": "list_tools_v1_flow_tools_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "tool_type", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ToolType" }, { "type": "null" } ], "description": "Filter by tool type", "title": "Tool Type" }, "description": "Filter by tool type" }, { "name": "tool_status", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ToolStatus" }, { "type": "null" } ], "description": "Filter by tool status", "title": "Tool Status" }, "description": "Filter by tool status" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetToolsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/flow/tools/{tool_id}": { "get": { "tags": [ "Tools" ], "summary": "Get tool", "description": "Get a specific tool by ID.", "operationId": "get_tool_v1_flow_tools__tool_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tool Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/FileSearchResponse" }, { "$ref": "#/components/schemas/RunPythonResponse" }, { "$ref": "#/components/schemas/WebSearchResponse" }, { "$ref": "#/components/schemas/AgentAsToolResponse" }, { "$ref": "#/components/schemas/MCPConnectorToolResponse" } ], "discriminator": { "propertyName": "type", "mapping": { "file_search": "#/components/schemas/FileSearchResponse", "run_python": "#/components/schemas/RunPythonResponse", "web_search": "#/components/schemas/WebSearchResponse", "agent_as_tool": "#/components/schemas/AgentAsToolResponse", "mcp_connector": "#/components/schemas/MCPConnectorToolResponse" } }, "title": "Response Get Tool V1 Flow Tools Tool Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "Tools" ], "summary": "Update tool", "description": "Partially update an existing tool. Omitted fields remain unchanged.", "operationId": "patch_tool_v1_flow_tools__tool_id__patch", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tool Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchToolBaseRequest" }, "examples": { "file_search": { "summary": "File search patch request", "value": { "name": "my file search tool", "description": "contains files about ", "config": { "file_search_index": "my-document-index", "top_k": 10, "score_threshold": 0.7 } } }, "run_python": { "summary": "Code interpreter / Custom functions patch request", "value": { "name": "my python functions tool", "description": "Execute Python code for data analysis and calculations", "config": { "function_ids": [ "func-123", "func-456" ] } } }, "web_search": { "summary": "Web search patch request", "value": { "name": "my web search tool", "description": "Search the web for current information" } }, "agent_as_tool": { "summary": "Agent as tool patch request", "value": { "name": "sports history bot", "description": "an expert on the history of sports" } }, "mcp_connector": { "summary": "MCP Connector Tool patch request", "value": { "name": "mcp connector tool", "description": "MCP connector tool with external authorization" } } } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/FileSearchResponse" }, { "$ref": "#/components/schemas/RunPythonResponse" }, { "$ref": "#/components/schemas/WebSearchResponse" }, { "$ref": "#/components/schemas/AgentAsToolResponse" }, { "$ref": "#/components/schemas/MCPConnectorToolResponse" } ], "discriminator": { "propertyName": "type", "mapping": { "file_search": "#/components/schemas/FileSearchResponse", "run_python": "#/components/schemas/RunPythonResponse", "web_search": "#/components/schemas/WebSearchResponse", "agent_as_tool": "#/components/schemas/AgentAsToolResponse", "mcp_connector": "#/components/schemas/MCPConnectorToolResponse" } }, "title": "Response Patch Tool V1 Flow Tools Tool Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Tools" ], "summary": "Replace tool", "description": "Update an existing tool.", "operationId": "update_tool_v1_flow_tools__tool_id__put", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tool Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/llm_training__agents__tools__standalone__schemas__CreateFileSearch" }, { "$ref": "#/components/schemas/llm_training__agents__tools__standalone__schemas__CreateRunPython" }, { "$ref": "#/components/schemas/llm_training__agents__tools__standalone__schemas__CreateWebSearch" }, { "$ref": "#/components/schemas/CreateAgentAsTool" }, { "$ref": "#/components/schemas/CreateMCPConnectorTool" } ], "title": "Request" }, "examples": { "file_search": { "summary": "File search request", "value": { "name": "my file search tool", "description": "contains files about ", "type": "file_search", "config": { "file_search_index": "my-document-index", "top_k": 10, "score_threshold": 0.7 } } }, "run_python": { "summary": "Code interpreter / Custom functions request", "value": { "name": "my python functions tool", "type": "run_python", "description": "Execute Python code for data analysis and calculations", "config": { "function_ids": [ "func-123", "func-456" ] } } }, "web_search": { "summary": "Web search request", "value": { "name": "my web search tool", "type": "web_search", "description": "Search the web for current information" } }, "agent_as_tool": { "summary": "Create agent as a tool request", "value": { "name": "sports history bot", "description": "an expert on the history of sports", "config": { "agent_id": "agent-00c6a3dc-4d32-4f52-9594-912aa345fffa" } } }, "mcp_connector": { "summary": "MCP Connector Tool request", "value": { "name": "mcp connector tool", "description": "MCP connector tool with external authorization", "type": "mcp_connector", "config": { "url": "https://example.com/mcp-connector" } } } } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/FileSearchResponse" }, { "$ref": "#/components/schemas/RunPythonResponse" }, { "$ref": "#/components/schemas/WebSearchResponse" }, { "$ref": "#/components/schemas/AgentAsToolResponse" }, { "$ref": "#/components/schemas/MCPConnectorToolResponse" } ], "discriminator": { "propertyName": "type", "mapping": { "file_search": "#/components/schemas/FileSearchResponse", "run_python": "#/components/schemas/RunPythonResponse", "web_search": "#/components/schemas/WebSearchResponse", "agent_as_tool": "#/components/schemas/AgentAsToolResponse", "mcp_connector": "#/components/schemas/MCPConnectorToolResponse" } }, "title": "Response Update Tool V1 Flow Tools Tool Id Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Tools" ], "summary": "Delete tool", "description": "Delete a tool if it's not referenced by active agents.", "operationId": "delete_tool_v1_flow_tools__tool_id__delete", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tool Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolDeleteResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/flow/tools/{tool_id}/agents": { "get": { "tags": [ "Tools" ], "summary": "List linked agents", "description": "Returns the agents that are linked to a given tool.", "operationId": "get_agents_for_tool_v1_flow_tools__tool_id__agents_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tool Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ToolAgentSummarySchema" }, "title": "Response Get Agents For Tool V1 Flow Tools Tool Id Agents Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/flow/tools/{tool_id}/diff": { "patch": { "tags": [ "Tools" ], "summary": "Preview tool update", "description": "Preview the changes a patch request would make to a tool without applying them. Returns a before-and-after diff of the affected fields.", "operationId": "diff_tool_changes_v1_flow_tools__tool_id__diff_patch", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tool Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchToolBaseRequest" }, "examples": { "file_search": { "summary": "File search patch request", "value": { "name": "my file search tool", "description": "contains files about ", "config": { "file_search_index": "my-document-index", "top_k": 10, "score_threshold": 0.7 } } }, "run_python": { "summary": "Code interpreter / Custom functions patch request", "value": { "name": "my python functions tool", "description": "Execute Python code for data analysis and calculations", "config": { "function_ids": [ "func-123", "func-456" ] } } }, "web_search": { "summary": "Web search patch request", "value": { "name": "my web search tool", "description": "Search the web for current information" } }, "agent_as_tool": { "summary": "Agent as tool patch request", "value": { "name": "sports history bot", "description": "an expert on the history of sports" } }, "mcp_connector": { "summary": "MCP Connector Tool patch request", "value": { "name": "mcp connector tool", "description": "MCP connector tool with external authorization" } } } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchToolResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/flow/tools/{tool_id}/duplicate": { "post": { "tags": [ "Tools" ], "summary": "Clone tool", "description": "Duplicate an existing tool with a new name.", "operationId": "duplicate_tool_v1_flow_tools__tool_id__duplicate_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tool Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ToolDuplicateRequest" }, { "type": "null" } ], "title": "Request" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/FileSearchResponse" }, { "$ref": "#/components/schemas/RunPythonResponse" }, { "$ref": "#/components/schemas/WebSearchResponse" }, { "$ref": "#/components/schemas/AgentAsToolResponse" }, { "$ref": "#/components/schemas/MCPConnectorToolResponse" } ], "discriminator": { "propertyName": "type", "mapping": { "file_search": "#/components/schemas/FileSearchResponse", "run_python": "#/components/schemas/RunPythonResponse", "web_search": "#/components/schemas/WebSearchResponse", "agent_as_tool": "#/components/schemas/AgentAsToolResponse", "mcp_connector": "#/components/schemas/MCPConnectorToolResponse" } }, "title": "Response Duplicate Tool V1 Flow Tools Tool Id Duplicate Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/flow/internal/tools/mcp-connector/sync": { "post": { "tags": [ "Tools" ], "summary": "Sync MCP connector tool lifecycle state", "description": "Sync MCP connector lifecycle state from mcp-vault.", "operationId": "sync_mcp_connector_tool_state_v1_flow_internal_tools_mcp_connector_sync_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MCPConnectorSyncRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MCPConnectorSyncResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-excluded": true } }, "/v1/flow/internal/tools/tool-metadata/{tool_id}": { "get": { "tags": [ "Tools" ], "summary": "Resolve tool metadata by tool ID", "operationId": "get_tool_metadata_v1_flow_internal_tools_tool_metadata__tool_id__get", "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tool Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/FileSearchResponse" }, { "$ref": "#/components/schemas/RunPythonResponse" }, { "$ref": "#/components/schemas/WebSearchResponse" }, { "$ref": "#/components/schemas/AgentAsToolResponse" }, { "$ref": "#/components/schemas/MCPConnectorToolResponse" } ], "discriminator": { "propertyName": "type", "mapping": { "file_search": "#/components/schemas/FileSearchResponse", "run_python": "#/components/schemas/RunPythonResponse", "web_search": "#/components/schemas/WebSearchResponse", "agent_as_tool": "#/components/schemas/AgentAsToolResponse", "mcp_connector": "#/components/schemas/MCPConnectorToolResponse" } }, "title": "Response Get Tool Metadata V1 Flow Internal Tools Tool Metadata Tool Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-excluded": true } }, "/v1/flow_internal/health": { "get": { "tags": [ "Internal" ], "summary": "Health", "operationId": "health_v1_flow_internal_health_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "x-excluded": true } }, "/v1/flow/data-jobs/gen_system_prompt": { "post": { "tags": [ "Data jobs" ], "summary": "Generate system prompt", "description": "Generate a system prompt based on a use case description and optional source documents.", "operationId": "generate_system_prompt_v1_flow_data_jobs_gen_system_prompt_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateSystemPromptRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Generate System Prompt V1 Flow Data Jobs Gen System Prompt Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/flow/data-jobs": { "post": { "tags": [ "Data jobs" ], "summary": "Submit data job", "operationId": "submit_data_job_v1_flow_data_jobs_post", "security": [ { "APIKeyHeader": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataJobCreateRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataJobResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Create a new data job." }, "get": { "tags": [ "Data jobs" ], "summary": "List data jobs", "operationId": "get_data_jobs_v1_flow_data_jobs_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "job_type", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataJobType" }, { "type": "null" } ], "title": "Job Type" } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/SortableField", "default": "created_at" } }, { "name": "sort_order", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^(asc|desc)$", "default": "desc", "title": "Sort Order" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 25, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataJobListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Retrieve a list of all data jobs." } }, "/v1/flow/data-jobs/{data_job_id}": { "get": { "tags": [ "Data jobs" ], "summary": "Get data job", "operationId": "get_data_job_v1_flow_data_jobs__data_job_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "data_job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Data Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataJobDetailResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Retrieve details for a specific data job." }, "patch": { "tags": [ "Data jobs" ], "summary": "Update data job", "operationId": "patch_data_job_v1_flow_data_jobs__data_job_id__patch", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "data_job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Data Job Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataJobUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataJobDetailResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Update the details of an existing data job." } }, "/v1/flow/data-jobs/{data_job_id}/add-files": { "post": { "tags": [ "Data jobs" ], "summary": "Add files to data job", "operationId": "add_files_to_data_job_v1_flow_data_jobs__data_job_id__add_files_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "data_job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Data Job Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataJobAddFileRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataJobDetailResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Add files to an existing data job." } }, "/v1/flow/data-jobs/{data_job_id}/remove-files": { "post": { "tags": [ "Data jobs" ], "summary": "Remove files from data job", "operationId": "remove_files_from_data_job_v1_flow_data_jobs__data_job_id__remove_files_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "data_job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Data Job Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataJobRemoveFilesRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataJobDetailResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Remove files from an existing data job." } }, "/v1/flow/data-jobs/{data_job_id}/start": { "post": { "tags": [ "Data jobs" ], "summary": "Start data job alignment", "operationId": "start_data_job_alignment_v1_flow_data_jobs__data_job_id__start_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "data_job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Data Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataJobDetailResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Start the alignment process for a data job." } }, "/v1/flow/data-jobs/{data_job_id}/cancel": { "post": { "tags": [ "Data jobs" ], "summary": "Cancel data job", "description": "Cancel the alignment job associated with a data job.", "operationId": "cancel_data_job_v1_flow_data_jobs__data_job_id__cancel_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "data_job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Data Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataJobDetailResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/flow/evals/cases": { "post": { "tags": [ "Internal", "Evals" ], "summary": "Create Case Route", "operationId": "create_case_route_v1_flow_evals_cases_post", "security": [ { "APIKeyHeader": [] } ], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CreateCaseForm" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Case" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-excluded": true }, "get": { "tags": [ "Internal", "Evals" ], "summary": "List Cases Route", "description": "List cases with optional filtering.", "operationId": "list_cases_route_v1_flow_evals_cases_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "min_datetime", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Min Datetime" } }, { "name": "max_datetime", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Max Datetime" } }, { "name": "tags", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Tags" } }, { "name": "tag_strategy", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/TagStrategy", "default": "contains" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 20, "title": "Limit" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^(asc|desc)$", "default": "desc", "title": "Order" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Case" }, "title": "Response List Cases Route V1 Flow Evals Cases Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-excluded": true } }, "/v1/flow/evals/cases/{case_id}": { "get": { "tags": [ "Internal", "Evals" ], "summary": "Get Case Route", "description": "Get a specific case by ID.", "operationId": "get_case_route_v1_flow_evals_cases__case_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "case_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the case to retrieve", "title": "Case Id" }, "description": "The ID of the case to retrieve" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Case" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-excluded": true }, "put": { "tags": [ "Internal", "Evals" ], "summary": "Update Case Route", "description": "Update a case by ID.", "operationId": "update_case_route_v1_flow_evals_cases__case_id__put", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "case_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the case to update", "title": "Case Id" }, "description": "The ID of the case to update" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCaseRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Case" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-excluded": true }, "delete": { "tags": [ "Internal", "Evals" ], "summary": "Delete Case Route", "description": "Delete a case by ID.", "operationId": "delete_case_route_v1_flow_evals_cases__case_id__delete", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "case_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the case to delete", "title": "Case Id" }, "description": "The ID of the case to delete" } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-excluded": true } }, "/v1/flow/feedback/upload": { "post": { "tags": [ "Internal", "Feedback" ], "summary": "Upload Feedback Route", "operationId": "upload_feedback_route_v1_flow_feedback_upload_post", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Body_upload_feedback_route_v1_flow_feedback_upload_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeedbackResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ], "x-excluded": true } }, "/v1/flow/feedback/images/{image_id}": { "get": { "tags": [ "Internal", "Feedback" ], "summary": "Get Feedback Image Route", "operationId": "get_feedback_image_route_v1_flow_feedback_images__image_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "image_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Image Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-excluded": true } }, "/v1/flow/feedback/": { "post": { "tags": [ "Internal", "Feedback" ], "summary": "Create Feedback Route", "operationId": "create_feedback_route_v1_flow_feedback__post", "security": [ { "APIKeyHeader": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFeedbackRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeedbackResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-excluded": true }, "get": { "tags": [ "Internal", "Feedback" ], "summary": "List Feedback Route", "operationId": "list_feedback_route_v1_flow_feedback__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "model_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Id" } }, { "name": "min_datetime", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Min Datetime" } }, { "name": "max_datetime", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Max Datetime" } }, { "name": "tags", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Tags" } }, { "name": "tag_strategy", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/TagStrategy", "default": "contains" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 20, "title": "Limit" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^(asc|desc)$", "default": "desc", "title": "Order" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FeedbackResponse" }, "title": "Response List Feedback Route V1 Flow Feedback Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-excluded": true } }, "/v1/flow/feedback/{feedback_id}": { "get": { "tags": [ "Internal", "Feedback" ], "summary": "Get Feedback Route", "operationId": "get_feedback_route_v1_flow_feedback__feedback_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "feedback_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Feedback Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeedbackResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-excluded": true }, "delete": { "tags": [ "Internal", "Feedback" ], "summary": "Delete Feedback Route", "description": "Delete feedback by id.", "operationId": "delete_feedback_route_v1_flow_feedback__feedback_id__delete", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "feedback_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Feedback Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-excluded": true }, "put": { "tags": [ "Internal", "Feedback" ], "summary": "Update Feedback Route", "operationId": "update_feedback_route_v1_flow_feedback__feedback_id__put", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "feedback_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Feedback Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFeedbackRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeedbackResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-excluded": true } }, "/v1/flow/internal/images/{image_id}": { "get": { "tags": [ "Internal", "Images" ], "summary": "Get Image Route", "description": "Returns the ImageResponse metadata for a given image_id.", "operationId": "get_image_route_v1_flow_internal_images__image_id__get", "parameters": [ { "name": "image_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Image Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-excluded": true }, "delete": { "tags": [ "Internal", "Images" ], "summary": "Delete Image Route", "operationId": "delete_image_route_v1_flow_internal_images__image_id__delete", "parameters": [ { "name": "image_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Image Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-excluded": true } }, "/v1/flow/internal/images/{image_id}/content": { "get": { "tags": [ "Internal", "Images" ], "summary": "Get Image Content Route", "description": "Internal route without auth for proxying image from object storage.", "operationId": "get_image_content_route_v1_flow_internal_images__image_id__content_get", "parameters": [ { "name": "image_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Image Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-excluded": true } }, "/v1/flow/internal/images": { "post": { "tags": [ "Internal", "Images" ], "summary": "Create Images Route", "operationId": "create_images_route_v1_flow_internal_images_post", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CreateImageForm" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ImageResponse" }, "type": "array", "title": "Response Create Images Route V1 Flow Internal Images Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-excluded": true } }, "/v1/flow/fine-tune": { "post": { "tags": [ "Fine-tuning" ], "summary": "Create fine-tuning job", "operationId": "fine_tune_v1_flow_fine_tune_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestConfig" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinetuneResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ], "description": "Create a new fine-tuning job using the specified base model and training files." } }, "/v1/flow/fine-tunes/{fine_tune_id}": { "get": { "tags": [ "Fine-tuning" ], "summary": "Get fine-tuning job", "operationId": "get_fine_tune_v1_flow_fine_tunes__fine_tune_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "fine_tune_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Fine Tune Id" } }, { "name": "include_deleted", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Deleted" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinetuneResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Retrieve the status and configuration of a specific fine-tuning job." }, "patch": { "tags": [ "Fine-tuning" ], "summary": "Modify fine-tuning job", "operationId": "patch_fine_tune_v1_flow_fine_tunes__fine_tune_id__patch", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "fine_tune_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Fine Tune Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFineTuneRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinetuneResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Update the configuration of an existing fine-tuning job." }, "delete": { "tags": [ "Fine-tuning" ], "summary": "Delete fine-tuning job", "operationId": "delete_fine_tune_v1_flow_fine_tunes__fine_tune_id__delete", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "fine_tune_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Fine Tune Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Delete a fine-tuning job and its associated artifacts." } }, "/v1/flow/fine-tunes/{fine_tune_id}/download": { "get": { "tags": [ "Fine-tuning" ], "summary": "Download fine-tune", "operationId": "download_fine_tune_v1_flow_fine_tunes__fine_tune_id__download_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "fine_tune_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Fine Tune Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Download the artifacts for a completed fine-tuning job." } }, "/v1/flow/fine-tunes/{fine_tune_id}/cancel": { "put": { "tags": [ "Fine-tuning" ], "summary": "Cancel fine-tuning job", "operationId": "cancel_fine_tune_v1_flow_fine_tunes__fine_tune_id__cancel_put", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "fine_tune_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Fine Tune Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinetuneResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Cancel a fine-tuning job that is queued or in progress." } }, "/v1/flow/fine-tunes/{fine_tune_id}/workflow-phase": { "get": { "tags": [ "Fine-tuning", "Internal" ], "summary": "Fine Tune Workflow Phase", "description": "Internal: the live Argo workflow phase for a fine-tune job.\n\nNot part of the public SDK. Lets the integration suite confirm a cancelled\njob's workflow actually terminated (the DB `cancelled` write alone doesn't\nprove the Argo stop landed). ``phase`` is None when the workflow was never\nstarted or no longer exists in Argo.", "operationId": "fine_tune_workflow_phase_v1_flow_fine_tunes__fine_tune_id__workflow_phase_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "fine_tune_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Fine Tune Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowPhaseResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-excluded": true } }, "/v1/flow/fine-tunes/{fine_tune_id}/demote-model": { "get": { "tags": [ "Fine-tuning", "Internal" ], "summary": "Demote Model", "operationId": "demote_model_v1_flow_fine_tunes__fine_tune_id__demote_model_get", "deprecated": true, "parameters": [ { "name": "fine_tune_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Fine Tune 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" } } } } }, "x-excluded": true } }, "/v1/flow/fine-tunes/{fine_tune_id}/promote-model": { "get": { "tags": [ "Fine-tuning", "Internal" ], "summary": "Promote Model", "operationId": "promote_model_v1_flow_fine_tunes__fine_tune_id__promote_model_get", "deprecated": true, "parameters": [ { "name": "fine_tune_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Fine Tune 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" } } } } }, "x-excluded": true } }, "/v1/flow/fine-tunes": { "get": { "tags": [ "Fine-tuning" ], "summary": "List fine-tuning jobs", "operationId": "list_fine_tune_v1_flow_fine_tunes_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "project_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Id" } }, { "name": "include_deleted", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Deleted" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinetuneList" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Retrieve a list of all fine-tuning jobs in your organization." } }, "/internal/finetune/{fine_tune_id}/status": { "post": { "tags": [ "Internal" ], "summary": "Training Status Update", "operationId": "training_status_update_internal_finetune__fine_tune_id__status_post", "parameters": [ { "name": "fine_tune_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Fine Tune Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "type": "string", "default": "", "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-excluded": true } }, "/v1/flow/files": { "get": { "tags": [ "Files" ], "summary": "List files", "operationId": "list_files_v1_flow_files_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 250, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^(created_at|filename|type|bytes)$", "default": "created_at", "title": "Sort By" } }, { "name": "sort_order", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^(asc|desc)$", "default": "desc", "title": "Sort Order" } }, { "name": "purpose", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^(ingestion|vector-ingestion|alignment|reinforcement-fine-tune|fine-tune|pre-train|preference-fine-tune)?$" }, { "type": "null" } ], "title": "Purpose" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileList" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Retrieve a list of all files in your organization." }, "put": { "tags": [ "Files" ], "summary": "Upload file", "description": "Upload a file to your organization for use in fine-tuning, alignment, or vector databases.", "operationId": "file_upload_v1_flow_files_put", "security": [ { "APIKeyHeader": [] } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_file_upload_v1_flow_files_put" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/flow/files/token-counts": { "get": { "tags": [ "Files" ], "summary": "Get file token count", "operationId": "file_token_counts_v1_flow_files_token_counts_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "file_ids", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" }, "title": "File Ids" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Get the token count for one or more files." } }, "/v1/flow/files/{file_id}": { "delete": { "tags": [ "Files" ], "summary": "Delete file", "operationId": "delete_file_v1_flow_files__file_id__delete", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "file_id", "in": "path", "required": true, "schema": { "type": "string", "title": "File Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileDeleteResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Permanently delete a file from your organization." }, "get": { "tags": [ "Files" ], "summary": "Get file details", "operationId": "file_download_v1_flow_files__file_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "file_id", "in": "path", "required": true, "schema": { "type": "string", "title": "File Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Retrieve metadata and details for a specific file." } }, "/v1/flow/bulk_files": { "put": { "tags": [ "Files" ], "summary": "Bulk upload files", "description": "Upload multiple files in a single request.", "operationId": "bulk_file_upload_v1_flow_bulk_files_put", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Body_bulk_file_upload_v1_flow_bulk_files_put" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/FileResponse" }, "type": "array", "title": "Response Bulk File Upload V1 Flow Bulk Files Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/v1/flow/files/{file_id}/content": { "get": { "tags": [ "Files" ], "summary": "Get file contents", "operationId": "file_download_content_v1_flow_files__file_id__content_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "file_id", "in": "path", "required": true, "schema": { "type": "string", "title": "File Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Download the raw content of a file by ID." } }, "/v1/flow/files/validate_metadata": { "post": { "tags": [ "Files" ], "summary": "Validate file metadata", "operationId": "file_validate_metadata_v1_flow_files_validate_metadata_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlignFileMetadataValidationReq" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ], "description": "Validate file metadata before uploading." } }, "/v1/flow/files/{file_id}/vector-dbs": { "get": { "tags": [ "Files" ], "summary": "List file vector databases", "operationId": "get_file_vector_dbs_v1_flow_files__file_id__vector_dbs_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "file_id", "in": "path", "required": true, "schema": { "type": "string", "title": "File Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdList" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Returns the IDs of vector databases that contain a given file." } }, "/v1/flow/files/{file_id}/data-jobs": { "get": { "tags": [ "Files" ], "summary": "List file data jobs", "operationId": "get_file_data_jobs_v1_flow_files__file_id__data_jobs_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "file_id", "in": "path", "required": true, "schema": { "type": "string", "title": "File Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdList" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Returns the IDs of data jobs that reference a given file." } }, "/v1/flow/files/{file_id}/derived-files": { "get": { "tags": [ "Files" ], "summary": "List derived files", "operationId": "get_file_derived_files_v1_flow_files__file_id__derived_files_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "file_id", "in": "path", "required": true, "schema": { "type": "string", "title": "File Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdList" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Returns the IDs of files derived from a given file, such as alignment outputs." } }, "/v1/flow/files/{file_id}/rename": { "put": { "tags": [ "Files" ], "summary": "Change file name", "operationId": "rename_file_v1_flow_files__file_id__rename_put", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "file_id", "in": "path", "required": true, "schema": { "type": "string", "title": "File Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileRenameRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Update the display name of an existing file." } }, "/v1/flow/health": { "get": { "tags": [ "Health" ], "summary": "Get health", "operationId": "get_health_external_v1_flow_health_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetHealthResponse" } } } } }, "description": "Check the health and availability of the SeekrFlow API." } }, "/v1/flow/internal/health": { "get": { "tags": [ "Health", "Internal", "Health" ], "summary": "Get Health Internal", "description": "Adds the commit id to the app version.", "operationId": "get_health_internal_v1_flow_internal_health_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetHealthResponse" } } } } }, "x-excluded": true } }, "/v1/flow/metrics/deployments": { "get": { "tags": [ "Deployments" ], "summary": "Get deployment metrics", "operationId": "get_deployment_metrics_v1_flow_metrics_deployments_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeploymentMetrics" } } } } }, "security": [ { "APIKeyHeader": [] } ], "description": "Retrieve performance metrics for active deployments." } }, "/v1/flow/models": { "get": { "tags": [ "Models" ], "summary": "List models", "operationId": "ml_models_v1_flow_models_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "model_type", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/MLModelType" }, { "type": "null" } ], "title": "Model Type" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMLModelsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Retrieve a list of all available models." } }, "/v1/flow/models/info": { "get": { "tags": [ "Models" ], "summary": "Get model", "operationId": "ml_model_by_model_id_v1_flow_models_info_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "model_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Model Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMLModelInfoResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Retrieve details and metadata for a specific model." } }, "/v1/flow/models/hf_revision": { "get": { "tags": [ "Models" ], "summary": "Get model revision", "operationId": "ml_model_hf_revision_by_model_name_v1_flow_models_hf_revision_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "model_name", "in": "query", "required": true, "schema": { "type": "string", "title": "Model Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMLModelHfRevision" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Retrieve the Hugging Face revision hash for a specific model." } }, "/v1/flow/projects": { "get": { "tags": [ "Fine-tuning" ], "summary": "List projects", "operationId": "get_projects_v1_flow_projects_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "skip", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Skip" } }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ], "title": "Limit" } }, { "name": "include_deleted", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Deleted" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProjectsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Retrieve a list of all projects in your organization." }, "post": { "tags": [ "Fine-tuning" ], "summary": "Create or update project", "operationId": "upsert_project_v1_flow_projects_post", "security": [ { "APIKeyHeader": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostProjectRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Create a new project or update an existing one by name." } }, "/v1/flow/projects/{project_id}": { "get": { "tags": [ "Fine-tuning" ], "summary": "Get project", "operationId": "get_project_by_id_v1_flow_projects__project_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "include_deleted", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Deleted" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Retrieve the details of a specific project." }, "delete": { "tags": [ "Fine-tuning" ], "summary": "Delete project", "operationId": "delete_project_v1_flow_projects__project_id__delete", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Delete a project and disassociate it from its fine-tuning jobs." } }, "/v1/flow/events/deployments/{deployment_id}": { "get": { "tags": [ "Deployments" ], "summary": "Get deployment event", "operationId": "get_deployment_events_by_id_v1_flow_events_deployments__deployment_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "deployment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Deployment Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEventsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Retrieve the event history for a specific deployment." } }, "/v1/flow/events/files/{file_id}": { "get": { "tags": [ "Files" ], "summary": "Get file event", "operationId": "get_file_events_by_id_v1_flow_events_files__file_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "file_id", "in": "path", "required": true, "schema": { "type": "string", "title": "File Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEventsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Retrieve the event history for a specific file." } }, "/v1/flow/events/finetunes/{finetune_id}": { "get": { "tags": [ "Fine-tuning" ], "summary": "Get fine-tuning event", "operationId": "get_finetune_events_by_id_v1_flow_events_finetunes__finetune_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "finetune_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Finetune Id" } }, { "name": "type_filter", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/FinetuneFilter", "default": "FINETUNE_ONLY" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEventsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Retrieve the event history for a specific fine-tuning job." } }, "/v1/flow/deployments": { "get": { "tags": [ "Deployments" ], "summary": "List deployments", "operationId": "get_deployments_v1_flow_deployments_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "deployment_status", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeploymentStatus" }, { "type": "null" } ], "title": "Deployment Status" } }, { "name": "fine_tune_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fine Tune Id" } }, { "name": "skip", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Skip" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 100, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDeploymentsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Retrieve a list of all deployments in your organization." }, "post": { "tags": [ "Deployments" ], "summary": "Create deployment", "operationId": "deploy_v1_flow_deployments_post", "security": [ { "APIKeyHeader": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewDeploymentRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deployment" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Deploy a fine-tuned model to a serving endpoint." } }, "/v1/flow/deployments/{deployment_id}": { "get": { "tags": [ "Deployments" ], "summary": "Get deployment", "operationId": "deployment_by_id_v1_flow_deployments__deployment_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "deployment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Deployment Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deployment" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Retrieve the configuration and status of a specific deployment." }, "patch": { "tags": [ "Deployments" ], "summary": "Update deployment", "operationId": "update_deployment_v1_flow_deployments__deployment_id__patch", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "deployment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Deployment Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDeploymentRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deployment" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Update the configuration of an existing deployment." } }, "/v1/flow/deployments/{deployment_id}/promote": { "put": { "tags": [ "Deployments" ], "summary": "Promote deployment", "operationId": "promote_v1_flow_deployments__deployment_id__promote_put", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "deployment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Deployment Id" } } ], "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deployment" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Promote a deployment from staging to production status." } }, "/v1/flow/deployments/{deployment_id}/demote": { "put": { "tags": [ "Deployments" ], "summary": "Demote deployment", "operationId": "demote_v1_flow_deployments__deployment_id__demote_put", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "deployment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Deployment Id" } } ], "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deployment" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Move a deployment from production to staging status." } }, "/v1/flow/pricing/inference/serverless": { "post": { "tags": [ "Internal", "Pricing" ], "summary": "Generate Price Estimate For Serverless Inference", "description": "Generates a price estimate for running inference using a base-model in a server-less deployment environment.\n**Note:** We currently only support inference for fine-tuned models in dedicated servers.\n\n### Key Input Fields:\n\n- **pricing_estimate_request.deployment.model_id**: Used to fetch the model and determine the `model_size`, which influences the pricing multipliers applied in the calculation. Also used in logic in determining whether model deployed is a fine-tuned or base model.\n\n- **pricing_estimate_request.file_ids**: A list of file IDs used to pull files from S3 and parse them for token counts. These token counts will be used as `input_tokens` in the pricing equation, while `output_tokens` will use default values. If no `file_ids` are provided, `input_tokens` will default to predefined values.\n\n**Returns:** A JSON object with the price estimate.", "operationId": "generate_price_estimate_for_serverless_inference_v1_flow_pricing_inference_serverless_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PricingEstimateServerlessInferenceRequestModel" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PricingEstimateResponseModel" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ], "x-excluded": true } }, "/v1/flow/pricing/fine-tuning": { "post": { "tags": [ "Internal", "Pricing" ], "summary": "Generate Price Estimate For Finetuning", "description": "Generates a price estimate for applying a fine-tuning job for a given model.\n\n### Key input fields:\n- **pricing_estimate_request.deployment.model_id**: - used to fetch the model, and determine the model_size which in turn is used for calculating multipliers used in equations\n- **pricing_estimate_request.num_of_epochs**: - number of times training set is passed through model during training.\n A direct input into the equation calculations\n\n**Returns:** A JSON object with the price estimate.", "operationId": "generate_price_estimate_for_finetuning_v1_flow_pricing_fine_tuning_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PricingEstimateFineTuningRequestModel" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PricingEstimateResponseModel" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ], "x-excluded": true } }, "/v1/flow/pricing/inference/dedicated": { "post": { "tags": [ "Internal", "Pricing" ], "summary": "Generate Price Estimate For Dedicated Inference", "description": "Generates a price estimate for running inference using a base or fine-tuned model in a dedicated deployment environment.\nNote: We currently only support GAUDI2 for our hardware but recognize future use of A100, H100, GAUDI3 accelerator types.\nKey input fields:\n- **pricing_estimate_request.estimated_compute_hours**: - hours of total usage of the model. A direct input used in calculation\n Also has a default if nothing is entered\n- **pricing_estimate_request.deployment.n_instances**: - instances of the hardware resource used. A direct input used in calculations\n- **pricing_estimate_request.deployment.hardware**: - used to calculate pricing multiplier based on the mapping (CPU, GPU, HPU) listed.\n For the input value `GAUDI2` we actually bypass the mapping and set the multiplier by 1, because it is our default offering.", "operationId": "generate_price_estimate_for_dedicated_inference_v1_flow_pricing_inference_dedicated_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PricingEstimateDedicatedInferenceRequestModel" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PricingEstimateResponseModel" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ], "x-excluded": true } }, "/v1/flow/vectordb": { "post": { "tags": [ "Vector database" ], "summary": "Create vector database", "description": "Create a new vector database for use with file search tools.", "operationId": "create_vector_database_route_v1_flow_vectordb_post", "security": [ { "APIKeyHeader": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VectorDatabaseCreate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VectorDatabaseResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Vector database" ], "summary": "List vector databases", "description": "Retrieve a list of all vector databases in your organization.", "operationId": "list_vector_databases_v1_flow_vectordb_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "types", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/DBType" } }, { "type": "null" } ], "title": "Types" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VectorDatabaseList" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/flow/vectordb/{database_id}": { "delete": { "tags": [ "Vector database" ], "summary": "Delete vector database", "description": "Permanently delete a vector database and its contents.", "operationId": "delete_vector_database_route_v1_flow_vectordb__database_id__delete", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Database Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VectorDatabaseDeleteResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Vector database" ], "summary": "Get vector database", "description": "Retrieve the configuration and status of a specific vector database.", "operationId": "get_vector_database_route_v1_flow_vectordb__database_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Database Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VectorDatabaseResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "Vector database" ], "summary": "Update vector database", "description": "Update a vector database's name or description.", "operationId": "update_vector_database_route_v1_flow_vectordb__database_id__patch", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Database Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVectorDbRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VectorDatabaseResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/flow/vectordb/{database_id}/tools": { "get": { "tags": [ "Vector database" ], "summary": "List vector database tools", "description": "Returns the IDs of file search tools that reference a given vector database.", "operationId": "get_tools_for_vector_database_v1_flow_vectordb__database_id__tools_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Database Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdList" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/flow/vectordb/{database_id}/data-jobs": { "get": { "tags": [ "Vector database" ], "summary": "List vector database data jobs", "description": "Returns the IDs of data jobs that reference a given vector database.", "operationId": "get_data_jobs_for_vector_database_v1_flow_vectordb__database_id__data_jobs_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Database Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdList" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/flow/vectordb/{database_id}/ingestion": { "post": { "tags": [ "Vector database" ], "summary": "Create vector database ingestion job", "description": "Start a new ingestion job to add files to a vector database.", "operationId": "create_vector_database_ingestion_job_v1_flow_vectordb__database_id__ingestion_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Database Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VectorDatabaseIngestionRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VectorDatabaseIngestionResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Vector database" ], "summary": "List vector database ingestion jobs", "description": "Retrieve a list of all ingestion jobs for a vector database.", "operationId": "list_vector_database_ingestion_jobs_v1_flow_vectordb__database_id__ingestion_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Database Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VectorDatabaseIngestionList" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/flow/vectordb/{database_id}/ingestion/{job_id}": { "get": { "tags": [ "Vector database" ], "summary": "Get vector database ingestion job status", "description": "Retrieve the status of a specific vector database ingestion job.", "operationId": "get_vector_database_ingestion_job_v1_flow_vectordb__database_id__ingestion__job_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Database Id" } }, { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VectorDatabaseIngestionResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/flow/vectordb/{database_id}/files": { "get": { "tags": [ "Vector database" ], "summary": "List files in vector database", "description": "Retrieve a list of files in a vector database, including their queue positions.", "operationId": "list_vector_database_files_v1_flow_vectordb__database_id__files_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Database Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VectorDatabaseFileList" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/flow/vectordb/{database_id}/chunk/{chunk_id}": { "get": { "tags": [ "Vector database" ], "summary": "Get vector database chunk", "description": "Retrieve provenance details for a chunk in a vector database.", "operationId": "get_vector_database_chunk_v1_flow_vectordb__database_id__chunk__chunk_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Database Id" } }, { "name": "chunk_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Chunk Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VectorDatabaseChunkResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/flow/vectordb/{database_id}/chunks": { "post": { "tags": [ "Vector database" ], "summary": "List chunks", "description": "Search and list chunks in a vector database, with optional filtering by file, chunk IDs, or metadata fields. Results are paginated.", "operationId": "list_vector_database_chunks_v1_flow_vectordb__database_id__chunks_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Database Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VectorDatabaseChunkSearchRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VectorDatabaseChunkListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/flow/vectordb/{database_id}/files/{file_id}": { "delete": { "tags": [ "Vector database" ], "summary": "Delete file in vector database", "description": "Remove a file from a vector database.", "operationId": "delete_vector_database_file_v1_flow_vectordb__database_id__files__file_id__delete", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Database Id" } }, { "name": "file_id", "in": "path", "required": true, "schema": { "type": "string", "title": "File Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VectorDatabaseFileDeleteResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/flow/vectordb/{database_id}/metadata": { "patch": { "tags": [ "Vector database" ], "summary": "Update chunk metadata", "description": "Overwrite metadata on chunks in a vector database, targeted by file IDs or chunk IDs. This replaces all existing metadata on the targeted chunks.", "operationId": "update_vector_database_metadata_v1_flow_vectordb__database_id__metadata_patch", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Database Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VectorDatabaseMetadataUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VectorDatabaseMetadataUpdateResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Vector database" ], "summary": "Generate metadata snapshot", "description": "Generate or refresh the metadata snapshot for a vector database by sampling its chunks and ranking the most common metadata keys and values.", "operationId": "generate_vector_database_metadata_snapshot_v1_flow_vectordb__database_id__metadata_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Database Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VectorDatabaseMetadataSnapshotGenerateResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Vector database" ], "summary": "Get metadata snapshot", "description": "Retrieve the current metadata snapshot for a vector database, listing the most common metadata keys and values across its chunks.", "operationId": "get_vector_database_metadata_snapshot_v1_flow_vectordb__database_id__metadata_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Database Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VectorDatabaseMetadataSnapshotResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/flow/versions": { "get": { "tags": [ "Versions" ], "summary": "Get versions", "operationId": "get_versions_v1_flow_versions_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Response Get Versions V1 Flow Versions Get" } } } } }, "security": [ { "APIKeyHeader": [] } ], "description": "Retrieve version information for the SeekrFlow API." } }, "/v1/flow/billing/resource-deployment-events": { "post": { "tags": [ "Billing", "Resource Deployment Events" ], "summary": "List resource deployment events", "operationId": "list_resource_deployment_events_v1_flow_billing_resource_deployment_events_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceDeploymentEventsQuery" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceDeploymentEventsListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Retrieve a paginated list of billing events associated with resource deployments, optionally filtered by resource, user, and time range." } }, "/v1/flow/internal/deployments/{deployment_id}": { "get": { "tags": [ "Internal", "Deployments" ], "summary": "Internal Deployment By Id", "operationId": "internal_deployment_by_id_v1_flow_internal_deployments__deployment_id__get", "parameters": [ { "name": "deployment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Deployment Id" } }, { "name": "team-id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Team-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deployment" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-excluded": true } }, "/v1/flow/internal/deployments/{deployment_id}/status": { "post": { "tags": [ "Internal", "Deployments" ], "summary": "Update the status of a deployment (Internal)", "description": "Internal endpoint for the Kubernetes event tracker to update the status of a deployment.", "operationId": "update_deployment_status_internal_v1_flow_internal_deployments__deployment_id__status_post", "parameters": [ { "name": "deployment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Deployment Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDeploymentStatusRequest" } } } }, "responses": { "200": { "description": "Confirmation message of the status update.", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-excluded": true } }, "/v1/flow/internal/models": { "get": { "tags": [ "Internal", "Models" ], "summary": "Ml Models", "operationId": "ml_models_v1_flow_internal_models_get", "parameters": [ { "name": "model_type", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/MLModelType" }, { "type": "null" } ], "title": "Model Type" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMLModelsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-excluded": true } }, "/v1/flow/internal/deployments": { "get": { "tags": [ "Internal", "Models" ], "summary": "Deployments", "operationId": "deployments_v1_flow_internal_deployments_get", "parameters": [ { "name": "team-id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Team-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDeploymentsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-excluded": true } }, "/v1/flow/internal/models/info": { "get": { "tags": [ "Internal", "Models" ], "summary": "Ml Model By Model Id", "operationId": "ml_model_by_model_id_v1_flow_internal_models_info_get", "parameters": [ { "name": "model_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Model Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMLModelInfoResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-excluded": true } }, "/v1/flow/internal/models/hf_revision": { "get": { "tags": [ "Internal", "Models" ], "summary": "Ml Model Hf Revision By Model Name", "operationId": "ml_model_hf_revision_by_model_name_v1_flow_internal_models_hf_revision_get", "parameters": [ { "name": "model_name", "in": "query", "required": true, "schema": { "type": "string", "title": "Model Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMLModelHfRevision" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-excluded": true } }, "/v1/flow/explain/models/{model_id}/influential-finetuning-data": { "get": { "tags": [ "Fine-tuning" ], "summary": "Get influential training data", "description": "Retrieve influential QA pair training data for a specific model.", "operationId": "get_influential_training_data_route_v1_flow_explain_models__model_id__influential_finetuning_data_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "model_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Model Id" } }, { "name": "question", "in": "query", "required": true, "schema": { "type": "string", "title": "Question" } }, { "name": "system_prompt", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "System Prompt" } }, { "name": "answer", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Answer" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InfluentialFinetuningDataResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/flow/internal/explain/populate-index": { "post": { "tags": [ "Internal", "Insights" ], "summary": "Populate Explainability Index Route", "description": "Populate the explainability index with data from a vector database.\nThis is an internal endpoint that calls the explainability service.", "operationId": "populate_explainability_index_route_v1_flow_internal_explain_populate_index_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PopulateIndexRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PopulateIndexResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-excluded": true } } }, "components": { "schemas": { "AcceleratorType": { "type": "string", "enum": [ "GAUDI2", "GAUDI3", "A100", "A10", "H100", "MI300X" ], "title": "AcceleratorType" }, "AgentAsToolConfig": { "properties": { "AGENT_ID": { "type": "string", "title": "Agent Id" } }, "additionalProperties": false, "type": "object", "required": [ "AGENT_ID" ], "title": "AgentAsToolConfig" }, "AgentAsToolResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "type": { "type": "string", "const": "agent_as_tool", "title": "Type", "default": "agent_as_tool" }, "config": { "$ref": "#/components/schemas/AgentAsToolConfig" }, "user_id": { "type": "string", "title": "User Id" }, "team_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Team Id" }, "status": { "$ref": "#/components/schemas/ToolStatus" }, "version": { "type": "integer", "title": "Version" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" } }, "type": "object", "required": [ "id", "name", "config", "user_id", "team_id", "status", "version", "created_at", "updated_at" ], "title": "AgentAsToolResponse" }, "AgentDeleteResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "deleted": { "type": "boolean", "title": "Deleted" } }, "type": "object", "required": [ "id", "deleted" ], "title": "AgentDeleteResponse" }, "AgentOutputConfig": { "properties": { "frequency": { "anyOf": [ { "$ref": "#/components/schemas/AgentOutputFrequency" }, { "type": "null" } ], "description": "When the agent produces a written response: `always`, `automatic` (the agent decides), or `never`." }, "instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instructions", "description": "Instructions for generating the agent's final response. When set, the top-level `instructions` guide only the agent's reasoning, and these guide the response." }, "model_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Id", "description": "The model used to generate the agent's final response, overriding the top-level `model_id`. Can be a base model or fine-tuned model." }, "temperature": { "anyOf": [ { "type": "number", "maximum": 2, "minimum": 0 }, { "type": "null" } ], "title": "Temperature", "description": "Controls the predictability of the agent's final response. Accepts a value from `0` to `2`. Defaults to `0.6`." } }, "type": "object", "title": "AgentOutputConfig" }, "AgentOutputFrequency": { "type": "string", "enum": [ "always", "never", "automatic" ], "title": "AgentOutputFrequency" }, "AgentSchema": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "instructions": { "type": "string", "title": "Instructions" }, "status": { "$ref": "#/components/schemas/AgentStatus" }, "model_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Id" }, "output": { "anyOf": [ { "$ref": "#/components/schemas/AgentOutputConfig" }, { "type": "null" } ] }, "temperature": { "anyOf": [ { "type": "number", "maximum": 2, "minimum": 0 }, { "type": "null" } ], "title": "Temperature" }, "reasoning_effort": { "$ref": "#/components/schemas/ReasoningEffort" }, "planner_temperature": { "anyOf": [ { "type": "number", "maximum": 2, "minimum": 0 }, { "type": "null" } ], "title": "Planner Temperature" }, "user_id": { "type": "string", "title": "User Id" }, "team_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Team Id" }, "tools": { "items": { "oneOf": [ { "$ref": "#/components/schemas/llm_training__agents__tools__schemas__file_search__FileSearch" }, { "$ref": "#/components/schemas/llm_training__agents__tools__schemas__web_search__WebSearch" }, { "$ref": "#/components/schemas/llm_training__agents__tools__schemas__run_python__RunPython" }, { "$ref": "#/components/schemas/llm_training__agents__tools__schemas__agent_as_tool__AgentAsTool" }, { "$ref": "#/components/schemas/llm_training__agents__tools__schemas__mcp_connector__MCPConnectorTool" } ], "discriminator": { "propertyName": "name", "mapping": { "agent_as_tool": "#/components/schemas/llm_training__agents__tools__schemas__agent_as_tool__AgentAsTool", "file_search": "#/components/schemas/llm_training__agents__tools__schemas__file_search__FileSearch", "mcp_connector": "#/components/schemas/llm_training__agents__tools__schemas__mcp_connector__MCPConnectorTool", "run_python": "#/components/schemas/llm_training__agents__tools__schemas__run_python__RunPython", "web_search": "#/components/schemas/llm_training__agents__tools__schemas__web_search__WebSearch" } } }, "type": "array", "title": "Tools" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "last_deployed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Deployed At" }, "active_duration": { "type": "integer", "minimum": 0, "title": "Active Duration", "default": 0 } }, "type": "object", "required": [ "id", "name", "instructions", "status", "reasoning_effort", "user_id", "team_id", "created_at", "updated_at" ], "title": "AgentSchema" }, "AgentSchemaV2": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "instructions": { "type": "string", "title": "Instructions" }, "status": { "$ref": "#/components/schemas/AgentStatus" }, "model_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Id" }, "output": { "anyOf": [ { "$ref": "#/components/schemas/AgentOutputConfig" }, { "type": "null" } ] }, "temperature": { "anyOf": [ { "type": "number", "maximum": 2, "minimum": 0 }, { "type": "null" } ], "title": "Temperature" }, "reasoning_effort": { "$ref": "#/components/schemas/ReasoningEffort" }, "planner_temperature": { "anyOf": [ { "type": "number", "maximum": 2, "minimum": 0 }, { "type": "null" } ], "title": "Planner Temperature" }, "user_id": { "type": "string", "title": "User Id" }, "team_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Team Id" }, "tools": { "items": { "oneOf": [ { "$ref": "#/components/schemas/llm_training__agents__tools__standalone__schemas__FileSearch" }, { "$ref": "#/components/schemas/llm_training__agents__tools__standalone__schemas__RunPython" }, { "$ref": "#/components/schemas/llm_training__agents__tools__standalone__schemas__WebSearch" }, { "$ref": "#/components/schemas/llm_training__agents__tools__standalone__schemas__AgentAsTool" }, { "$ref": "#/components/schemas/llm_training__agents__tools__standalone__schemas__MCPConnectorTool" } ], "discriminator": { "propertyName": "type", "mapping": { "agent_as_tool": "#/components/schemas/llm_training__agents__tools__standalone__schemas__AgentAsTool", "file_search": "#/components/schemas/llm_training__agents__tools__standalone__schemas__FileSearch", "mcp_connector": "#/components/schemas/llm_training__agents__tools__standalone__schemas__MCPConnectorTool", "run_python": "#/components/schemas/llm_training__agents__tools__standalone__schemas__RunPython", "web_search": "#/components/schemas/llm_training__agents__tools__standalone__schemas__WebSearch" } } }, "type": "array", "title": "Tools" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "last_deployed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Deployed At" }, "active_duration": { "type": "integer", "minimum": 0, "title": "Active Duration", "default": 0 } }, "type": "object", "required": [ "id", "name", "instructions", "status", "reasoning_effort", "user_id", "team_id", "created_at", "updated_at" ], "title": "AgentSchemaV2" }, "AgentStatus": { "type": "string", "enum": [ "Inactive", "Pending", "Active", "Updating", "Failed" ], "title": "AgentStatus" }, "AgentUpdateStatusRequest": { "properties": { "new_status": { "$ref": "#/components/schemas/AgentStatus" } }, "additionalProperties": false, "type": "object", "required": [ "new_status" ], "title": "AgentUpdateStatusRequest" }, "AgentUpdateStatusResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "old_status": { "$ref": "#/components/schemas/AgentStatus" }, "new_status": { "$ref": "#/components/schemas/AgentStatus" }, "user_id": { "type": "string", "title": "User Id" }, "team_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Team Id" } }, "type": "object", "required": [ "id", "old_status", "new_status", "user_id", "team_id" ], "title": "AgentUpdateStatusResponse" }, "AgentUpdateStatusResponseV2": { "properties": { "id": { "type": "string", "title": "Id" }, "old_status": { "$ref": "#/components/schemas/AgentStatus" }, "new_status": { "$ref": "#/components/schemas/AgentStatus" }, "user_id": { "type": "string", "title": "User Id" }, "team_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Team Id" }, "agent": { "$ref": "#/components/schemas/AgentSchemaV2" } }, "type": "object", "required": [ "id", "old_status", "new_status", "user_id", "team_id", "agent" ], "title": "AgentUpdateStatusResponseV2" }, "AlignFileMetadataValidationReq": { "properties": { "purpose": { "type": "string", "title": "Purpose" }, "suffix": { "type": "string", "title": "Suffix" }, "size": { "type": "integer", "title": "Size" } }, "additionalProperties": true, "type": "object", "required": [ "purpose", "suffix", "size" ], "title": "AlignFileMetadataValidationReq" }, "AlignmentFileType": { "type": "string", "enum": [ "html", "md", "rst", "rtf", "txt", "xml", "json", "jsonl", "csv", "doc", "docx", "pdf", "ppt", "pptx" ], "title": "AlignmentFileType" }, "AlignmentJobStatus": { "type": "string", "enum": [ "pending", "queued", "running", "cancelled", "failed", "completed", "stopped" ], "title": "AlignmentJobStatus" }, "AlignmentList": { "properties": { "object": { "anyOf": [ { "type": "string", "const": "list" }, { "type": "null" } ], "title": "Object" }, "data": { "anyOf": [ { "items": { "$ref": "#/components/schemas/AlignmentResponse" }, "type": "array" }, { "type": "null" } ], "title": "Data" } }, "additionalProperties": true, "type": "object", "title": "AlignmentList" }, "AlignmentRequest": { "properties": { "instructions": { "type": "string", "title": "Instructions", "description": "Task description/instructions for the alignment task" }, "system_prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "System Prompt", "description": "Optional system prompt baked into the generated dataset's `system` role on every conversation. If omitted, one is generated from `instructions` and the recursive document summary." }, "files": { "items": { "type": "string" }, "type": "array", "title": "Files", "description": "List of file ids to use for alignment" }, "type": { "$ref": "#/components/schemas/AlignmentType", "description": "Type of alignment task (principle or context_data)", "default": "principle" }, "vector_database_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vector Database Id", "description": "Optional vector database id to use for context retrieval during context_data alignment" } }, "additionalProperties": true, "type": "object", "required": [ "instructions", "files" ], "title": "AlignmentRequest" }, "AlignmentResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At" }, "stopped_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Stopped At" }, "status": { "$ref": "#/components/schemas/AlignmentJobStatus" }, "current_step": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Current Step", "description": "The processing step the job is currently working on. `null` until the job starts running." }, "step_progress": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Step Progress", "description": "Progress through the current step. `null` when no step is in progress." }, "progress": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Progress", "description": "Overall completion of the job across all steps. `null` until progress can be calculated." }, "estimated_completion_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Estimated Completion At", "description": "Projected completion timestamp (UTC). `null` until enough progress data is available to produce an estimate." }, "eta_minutes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Eta Minutes", "description": "Estimated number of minutes remaining until the job completes. `null` until an estimate is available." }, "status_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status Message", "description": "Human-readable description of the job's current state, suitable for display to end users." } }, "additionalProperties": true, "type": "object", "required": [ "id", "created_at", "status" ], "title": "AlignmentResponse" }, "AlignmentType": { "type": "string", "enum": [ "principle", "context_data" ], "title": "AlignmentType" }, "BillingType": { "type": "string", "enum": [ "Fine-Tuning", "Training", "Inference" ], "title": "BillingType" }, "Body_bulk_file_upload_v1_flow_bulk_files_put": { "properties": { "purpose": { "$ref": "#/components/schemas/FilePurpose" }, "files": { "items": { "type": "string", "contentMediaType": "application/octet-stream" }, "type": "array", "title": "Files" } }, "type": "object", "required": [ "purpose", "files" ], "title": "Body_bulk_file_upload_v1_flow_bulk_files_put" }, "Body_file_upload_v1_flow_files_put": { "properties": { "purpose": { "$ref": "#/components/schemas/FilePurpose" }, "files": { "type": "string", "contentMediaType": "application/octet-stream", "title": "Files" }, "vector_database_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vector Database Id" } }, "type": "object", "required": [ "purpose", "files" ], "title": "Body_file_upload_v1_flow_files_put" }, "Body_upload_feedback_route_v1_flow_feedback_upload_post": { "properties": { "files": { "items": { "type": "string", "contentMediaType": "application/octet-stream" }, "type": "array", "title": "Files" }, "model_id": { "type": "string", "title": "Model Id" }, "version": { "type": "string", "title": "Version" }, "feedback": { "type": "string", "title": "Feedback", "description": "Stringified json object for feedback data" }, "tags": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tags" } }, "type": "object", "required": [ "model_id", "version", "feedback" ], "title": "Body_upload_feedback_route_v1_flow_feedback_upload_post" }, "CalculationParameter": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "value": { "anyOf": [ {}, { "type": "null" } ], "title": "Value" } }, "type": "object", "required": [ "name", "description" ], "title": "CalculationParameter" }, "Case": { "properties": { "id": { "type": "string", "title": "Id" }, "user_id": { "type": "string", "title": "User Id" }, "question": { "type": "string", "title": "Question" }, "ground_truth": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ground Truth" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "case_metadata": { "additionalProperties": true, "type": "object", "title": "Case Metadata" }, "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags" }, "file_ids": { "items": { "type": "string" }, "type": "array", "title": "File Ids" } }, "type": "object", "required": [ "id", "user_id", "question", "created_at", "updated_at" ], "title": "Case" }, "CreateAgentAsTool": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "type": { "type": "string", "const": "agent_as_tool", "title": "Type", "default": "agent_as_tool" }, "config": { "$ref": "#/components/schemas/AgentAsToolConfig" } }, "additionalProperties": false, "type": "object", "required": [ "name", "description", "config" ], "title": "CreateAgentAsTool" }, "CreateAgentRequest": { "properties": { "name": { "type": "string", "title": "Name" }, "instructions": { "type": "string", "title": "Instructions" }, "tools": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/llm_training__agents__tools__schemas__file_search__CreateFileSearch" }, { "$ref": "#/components/schemas/llm_training__agents__tools__schemas__web_search__CreateWebSearch" }, { "$ref": "#/components/schemas/llm_training__agents__tools__schemas__run_python__CreateRunPython" } ], "discriminator": { "propertyName": "name", "mapping": { "file_search": "#/components/schemas/llm_training__agents__tools__schemas__file_search__CreateFileSearch", "run_python": "#/components/schemas/llm_training__agents__tools__schemas__run_python__CreateRunPython", "web_search": "#/components/schemas/llm_training__agents__tools__schemas__web_search__CreateWebSearch" } } }, "type": "array" }, { "type": "null" } ], "title": "Tools", "description": "DEPRECATED: Use `tool_ids` instead.", "deprecated": true }, "tool_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tool Ids", "description": "Preferred way to associate tools with an agent." }, "model_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Id" }, "output": { "anyOf": [ { "$ref": "#/components/schemas/AgentOutputConfig" }, { "type": "null" } ], "description": "Optional configuration for the agent's final response. Overrides the top-level settings for response generation." }, "temperature": { "anyOf": [ { "type": "number", "maximum": 2, "minimum": 0 }, { "type": "null" } ], "title": "Temperature", "description": "Controls the predictability of the agent's reasoning. Accepts a value from `0` to `2`. Defaults to `0.6`. Lower values produce more consistent results, and higher values introduce more variation." }, "reasoning_effort": { "anyOf": [ { "$ref": "#/components/schemas/ReasoningEffort" }, { "type": "null" } ], "default": "medium" } }, "additionalProperties": false, "type": "object", "required": [ "name", "instructions" ], "title": "CreateAgentRequest" }, "CreateCaseForm": { "properties": { "question": { "type": "string", "title": "Question" }, "ground_truth": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ground Truth" }, "case_metadata": { "additionalProperties": true, "type": "object", "title": "Case Metadata", "default": {} }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "files": { "anyOf": [ { "items": { "type": "string", "contentMediaType": "application/octet-stream" }, "type": "array" }, { "type": "null" } ], "title": "Files" } }, "type": "object", "required": [ "question" ], "title": "CreateCaseForm" }, "CreateFeedbackRequest": { "properties": { "model_id": { "type": "string", "title": "Model Id", "description": "The name of a model (TinyLlama/TinyLlama-1.1B-Chat-v1.0) deployment id" }, "feedback": { "additionalProperties": true, "type": "object", "title": "Feedback", "description": "Json object" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "The version of feedback data", "default": "" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" } }, "type": "object", "required": [ "model_id", "feedback" ], "title": "CreateFeedbackRequest" }, "CreateImageForm": { "properties": { "user_id": { "type": "string", "title": "User Id" }, "team_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Team Id" }, "files": { "anyOf": [ { "items": { "type": "string", "contentMediaType": "application/octet-stream" }, "type": "array" }, { "type": "null" } ], "title": "Files" } }, "additionalProperties": true, "type": "object", "required": [ "user_id" ], "title": "CreateImageForm" }, "CreateMCPConnectorTool": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "type": { "type": "string", "const": "mcp_connector", "title": "Type", "default": "mcp_connector" }, "config": { "$ref": "#/components/schemas/MCPConnectorToolConfig" } }, "additionalProperties": false, "type": "object", "required": [ "name", "description", "config" ], "title": "CreateMCPConnectorTool" }, "DBType": { "type": "string", "enum": [ "RAG", "explainability" ], "title": "DBType" }, "DataJobAddFileRequest": { "properties": { "file_ids": { "items": { "type": "string" }, "type": "array", "minItems": 1, "title": "File Ids", "description": "Files to associate with the data job" }, "method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Method", "description": "Ingestion method used for non-alignment-ready files", "default": "best" } }, "type": "object", "required": [ "file_ids" ], "title": "DataJobAddFileRequest" }, "DataJobCloneRequest": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 255, "minLength": 1 }, { "type": "null" } ], "title": "Name" } }, "type": "object", "title": "DataJobCloneRequest" }, "DataJobCreateRequest": { "properties": { "name": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Name" }, "job_type": { "$ref": "#/components/schemas/DataJobType" }, "system_prompt": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "System Prompt" }, "instructions": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Instructions", "description": "Natural-language description of the task the generated dataset should support. Alignment uses it to shape the examples it produces, such as the topics and the kinds of questions a fine-tuned model should be able to handle." }, "vector_database_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vector Database Id" } }, "type": "object", "required": [ "name", "job_type" ], "title": "DataJobCreateRequest" }, "DataJobDetailResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "user_id": { "type": "string", "title": "User Id" }, "name": { "type": "string", "title": "Name" }, "job_type": { "type": "string", "title": "Job Type" }, "alignment_job_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Alignment Job Id" }, "origin_data_job_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Origin Data Job Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/DataJobStatus" }, { "$ref": "#/components/schemas/AlignmentJobStatus" } ], "title": "Status" }, "status_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status Message" }, "system_prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "System Prompt" }, "system_prompt_updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "System Prompt Updated At" }, "instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instructions" }, "instructions_updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Instructions Updated At" }, "resolved_instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resolved Instructions" }, "vector_database_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vector Database Id" }, "additional_alignment_file_ids": { "items": { "type": "string" }, "type": "array", "title": "Additional Alignment File Ids" }, "ingestion_jobs": { "items": { "$ref": "#/components/schemas/IngestionJobDetail" }, "type": "array", "title": "Ingestion Jobs" }, "alignment_job": { "anyOf": [ { "$ref": "#/components/schemas/AlignmentResponse" }, { "type": "null" } ] }, "files": { "items": { "$ref": "#/components/schemas/DataJobFile" }, "type": "array", "title": "Files" }, "fine_tuning_job_ids": { "items": { "type": "string" }, "type": "array", "title": "Fine Tuning Job Ids" }, "timeline": { "items": { "$ref": "#/components/schemas/TimelineEvent" }, "type": "array", "title": "Timeline" } }, "type": "object", "required": [ "id", "user_id", "name", "job_type", "alignment_job_id", "created_at", "updated_at", "status" ], "title": "DataJobDetailResponse", "description": "Extends DataJobResponse Full detail payload for the per-job view." }, "DataJobFile": { "properties": { "file_id": { "type": "string", "title": "File Id", "description": "Alignment file identifier" }, "record_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Record Id", "description": "Ingestion job file record identifier (if any)" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Human readable file name" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type", "description": "Detected file type" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At", "description": "Creation timestamp of the underlying file" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status", "description": "Processing status for ingestion records" }, "suggested_fix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Suggested Fix", "description": "Suggested fix when ingestion failed" }, "bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Bytes", "description": "File size in bytes" } }, "type": "object", "required": [ "file_id" ], "title": "DataJobFile" }, "DataJobListResponse": { "properties": { "object": { "type": "string", "const": "list", "title": "Object", "default": "list" }, "data": { "items": { "$ref": "#/components/schemas/DataJobResponse" }, "type": "array", "title": "Data" } }, "type": "object", "title": "DataJobListResponse" }, "DataJobRemoveFilesRequest": { "properties": { "file_ids": { "items": { "type": "string" }, "type": "array", "minItems": 1, "title": "File Ids", "description": "File IDs to remove" } }, "type": "object", "required": [ "file_ids" ], "title": "DataJobRemoveFilesRequest" }, "DataJobResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "user_id": { "type": "string", "title": "User Id" }, "name": { "type": "string", "title": "Name" }, "job_type": { "type": "string", "title": "Job Type" }, "alignment_job_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Alignment Job Id" }, "origin_data_job_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Origin Data Job Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/DataJobStatus" }, { "$ref": "#/components/schemas/AlignmentJobStatus" } ], "title": "Status" }, "status_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status Message" }, "system_prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "System Prompt" }, "system_prompt_updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "System Prompt Updated At" }, "instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instructions" }, "instructions_updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Instructions Updated At" }, "resolved_instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resolved Instructions" }, "vector_database_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vector Database Id" } }, "type": "object", "required": [ "id", "user_id", "name", "job_type", "alignment_job_id", "created_at", "updated_at", "status" ], "title": "DataJobResponse", "description": "Lightweight response for list view performance." }, "DataJobStatus": { "type": "string", "enum": [ "file_processing", "needs_review", "ready_to_start" ], "title": "DataJobStatus", "description": "Status values that exist BEFORE an alignment job is linked. Once\nlinked, the real status comes from AlignmentJobStatus directly — see\nDataJobResponse.status's union type and derive_data_job_status." }, "DataJobType": { "type": "string", "enum": [ "principle_files", "context_grounded_files", "context_grounded_vector_db" ], "title": "DataJobType", "description": "Valid job types for data jobs." }, "DataJobUpdateRequest": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 255, "minLength": 1 }, { "type": "null" } ], "title": "Name" }, "system_prompt": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "System Prompt" }, "instructions": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Instructions", "description": "Natural-language description of the task the generated dataset should support. Alignment uses it to shape the examples it produces, such as the topics and the kinds of questions a fine-tuned model should be able to handle." }, "vector_database_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vector Database Id" } }, "type": "object", "title": "DataJobUpdateRequest" }, "Deployment": { "properties": { "id": { "type": "string", "title": "Id" }, "model_type": { "$ref": "#/components/schemas/DeploymentType" }, "model_id": { "type": "string", "title": "Model Id" }, "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "status": { "$ref": "#/components/schemas/DeploymentStatus" }, "memory": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Memory" }, "hardware_type": { "$ref": "#/components/schemas/HardwareType", "default": "Dedicated" }, "total_input_tokens": { "type": "integer", "title": "Total Input Tokens" }, "total_output_tokens": { "type": "integer", "title": "Total Output Tokens" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "last_deployed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Deployed At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "processor": { "$ref": "#/components/schemas/DeploymentProcessor", "default": "GAUDI2" }, "n_instances": { "type": "integer", "title": "N Instances" }, "user_id": { "type": "string", "title": "User Id" }, "team_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Team Id" }, "model_name": { "type": "string", "title": "Model Name" }, "n_epochs": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "N Epochs" }, "batch_size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Batch Size" }, "learning_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Learning Rate" }, "training_files": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Training Files" }, "project_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Project Id" }, "project_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Name" }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At" }, "finetune_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Finetune Name" }, "finetune_created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Finetune Created At" }, "active_duration": { "type": "integer", "minimum": 0, "title": "Active Duration", "default": 0 }, "is_lora_adapter": { "type": "boolean", "title": "Is Lora Adapter", "default": false } }, "type": "object", "required": [ "id", "model_type", "model_id", "name", "description", "status", "total_input_tokens", "total_output_tokens", "created_at", "updated_at", "n_instances", "user_id", "team_id", "model_name" ], "title": "Deployment" }, "DeploymentMetrics": { "properties": { "count_by_deployment_status": { "$ref": "#/components/schemas/DeploymentStatusCounts" }, "total_inbound_tokens": { "type": "integer", "title": "Total Inbound Tokens" }, "total_outbound_tokens": { "type": "integer", "title": "Total Outbound Tokens" } }, "type": "object", "required": [ "count_by_deployment_status", "total_inbound_tokens", "total_outbound_tokens" ], "title": "DeploymentMetrics" }, "DeploymentProcessor": { "type": "string", "enum": [ "GAUDI2", "GAUDI3", "A100", "A10", "AMD", "H100", "MI300X" ], "title": "DeploymentProcessor" }, "DeploymentStatus": { "type": "string", "enum": [ "Inactive", "Pending", "Active", "Failed", "Started", "Success" ], "title": "DeploymentStatus" }, "DeploymentStatusCounts": { "properties": { "active": { "type": "integer", "title": "Active" }, "inactive": { "type": "integer", "title": "Inactive" }, "failed": { "type": "integer", "title": "Failed" }, "pending": { "type": "integer", "title": "Pending" } }, "type": "object", "required": [ "active", "inactive", "failed", "pending" ], "title": "DeploymentStatusCounts" }, "DeploymentType": { "type": "string", "enum": [ "Fine-tuned Run", "Base Model" ], "title": "DeploymentType" }, "Event": { "properties": { "id": { "type": "integer", "title": "Id" }, "type": { "$ref": "#/components/schemas/EventType" }, "type_id": { "type": "string", "title": "Type Id" }, "status": { "$ref": "#/components/schemas/EventStatus" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "type", "type_id", "status", "created_at" ], "title": "Event" }, "EventStatus": { "type": "string", "enum": [ "Inactive", "Pending", "Active", "Failed", "Started", "Success", "Uploading", "Completed", "Deleted", "Cancelled", "Queued", "Running" ], "title": "EventStatus" }, "EventType": { "type": "string", "enum": [ "Files", "Finetune", "Deployments", "Alignment" ], "title": "EventType" }, "FeedbackResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "user_id": { "type": "string", "title": "User Id" }, "model_id": { "type": "string", "title": "Model Id" }, "feedback": { "additionalProperties": true, "type": "object", "title": "Feedback" }, "timestamp": { "type": "string", "format": "date-time", "title": "Timestamp" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version" }, "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags" }, "file_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "File Ids" } }, "type": "object", "required": [ "id", "user_id", "model_id", "feedback", "timestamp", "updated_at" ], "title": "FeedbackResponse" }, "FileDeleteResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "object": { "type": "string", "const": "file", "title": "Object" }, "deleted": { "type": "boolean", "title": "Deleted" } }, "additionalProperties": true, "type": "object", "required": [ "id", "object", "deleted" ], "title": "FileDeleteResponse" }, "FileList": { "properties": { "object": { "anyOf": [ { "type": "string", "const": "list" }, { "type": "null" } ], "title": "Object" }, "data": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FileResponse" }, "type": "array" }, { "type": "null" } ], "title": "Data" } }, "additionalProperties": true, "type": "object", "title": "FileList" }, "FilePurpose": { "type": "string", "enum": [ "reinforcement-fine-tune", "fine-tune", "preference-fine-tune", "pre-train", "alignment" ], "title": "FilePurpose" }, "FileRenameRequest": { "properties": { "new_filename": { "type": "string", "title": "New Filename" } }, "type": "object", "required": [ "new_filename" ], "title": "FileRenameRequest" }, "FileResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "object": { "type": "string", "const": "file", "title": "Object" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "type": { "anyOf": [ { "$ref": "#/components/schemas/TrainingFileType" }, { "$ref": "#/components/schemas/AlignmentFileType" }, { "type": "null" } ], "title": "Type" }, "purpose": { "anyOf": [ { "$ref": "#/components/schemas/FilePurpose" }, { "type": "null" } ] }, "filename": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filename" }, "bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Bytes" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "original_file_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Original File Id" }, "deleted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Deleted" } }, "additionalProperties": true, "type": "object", "required": [ "id", "object" ], "title": "FileResponse", "description": "Files API response type" }, "FileSearchConfig": { "properties": { "FILE_SEARCH_INDEX": { "type": "string", "minLength": 1, "title": "File Search Index" }, "EMBEDDING_MODEL": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Embedding Model" }, "TOP_K": { "type": "integer", "maximum": 100, "minimum": 1, "title": "Top K", "description": "Top K must be >= 1 and <= 100", "default": 10 }, "SCORE_THRESHOLD": { "type": "number", "exclusiveMaximum": 1, "minimum": 0, "title": "Score Threshold", "description": "Score must be ≥ 0.0 and < 1.0", "default": 0 } }, "additionalProperties": false, "type": "object", "required": [ "FILE_SEARCH_INDEX" ], "title": "FileSearchConfig" }, "FileSearchEnv": { "properties": { "FILE_SEARCH_INDEX": { "type": "string", "minLength": 1, "title": "File Search Index" }, "EMBEDDING_MODEL": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Embedding Model" }, "DOCUMENT_TOOL_DESC": { "type": "string", "minLength": 1, "title": "Document Tool Desc" }, "TOP_K": { "type": "integer", "maximum": 100, "minimum": 1, "title": "Top K", "description": "Top K must be >= 1 and <= 100", "default": 10 }, "SCORE_THRESHOLD": { "type": "number", "exclusiveMaximum": 1, "minimum": 0, "title": "Score Threshold", "description": "Score must be ≥ 0.0 and < 1.0", "default": 0 } }, "type": "object", "required": [ "FILE_SEARCH_INDEX", "DOCUMENT_TOOL_DESC" ], "title": "FileSearchEnv" }, "FileSearchResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "type": { "type": "string", "const": "file_search", "title": "Type", "default": "file_search" }, "config": { "$ref": "#/components/schemas/FileSearchConfig" }, "user_id": { "type": "string", "title": "User Id" }, "team_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Team Id" }, "status": { "$ref": "#/components/schemas/ToolStatus" }, "version": { "type": "integer", "title": "Version" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" } }, "type": "object", "required": [ "id", "name", "config", "user_id", "team_id", "status", "version", "created_at", "updated_at" ], "title": "FileSearchResponse" }, "FineTuneType": { "type": "string", "enum": [ "STANDARD", "PREFERENCE", "GRPO", "REINFORCEMENT" ], "title": "FineTuneType" }, "FinetuneEvent": { "additionalProperties": true, "type": "object" }, "FinetuneFilter": { "type": "string", "enum": [ "FINETUNE_ONLY", "ALL", "FINETUNE_DEPLOYMENT", "FINETUNE_FILES" ], "title": "FinetuneFilter" }, "FinetuneJobStatus": { "type": "string", "enum": [ "pending", "queued", "running", "cancelled", "failed", "completed", "deleted" ], "title": "FinetuneJobStatus", "description": "Possible fine-tune job status" }, "FinetuneList": { "properties": { "object": { "anyOf": [ { "type": "string", "const": "list" }, { "type": "null" } ], "title": "Object" }, "data": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FinetuneResponse" }, "type": "array" }, { "type": "null" } ], "title": "Data" } }, "additionalProperties": true, "type": "object", "title": "FinetuneList" }, "FinetuneResponse": { "additionalProperties": true, "type": "object" }, "FormatCheckGrader": { "properties": { "type": { "type": "string", "const": "format_check", "title": "Type", "default": "format_check" }, "weight": { "anyOf": [ { "type": "number", "maximum": 1, "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Weight" } }, "type": "object", "title": "FormatCheckGrader", "description": "Format-compliance grader. Carries no operation or config." }, "GenerateSystemPromptRequest": { "properties": { "instructions": { "type": "string", "title": "Instructions" }, "document_summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Document Summary" } }, "type": "object", "required": [ "instructions" ], "title": "GenerateSystemPromptRequest" }, "GetAgentsResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/AgentSchema" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "GetAgentsResponse", "description": "Agents API response type" }, "GetAgentsResponseV2": { "properties": { "data": { "items": { "$ref": "#/components/schemas/AgentSchemaV2" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "GetAgentsResponseV2", "description": "Agents API response type" }, "GetDeploymentsResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Deployment" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "GetDeploymentsResponse" }, "GetEventsResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Event" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "GetEventsResponse" }, "GetHealthResponse": { "properties": { "deployment_pending_average": { "type": "integer", "title": "Deployment Pending Average" }, "deployment_pending_maximum": { "type": "integer", "title": "Deployment Pending Maximum" }, "deployment_pending_count": { "type": "integer", "title": "Deployment Pending Count" }, "deployment_pending_by_model_name": { "additionalProperties": { "$ref": "#/components/schemas/SinceUpdateMetrics" }, "type": "object", "title": "Deployment Pending By Model Name" }, "version": { "type": "string", "title": "Version" }, "agent_pending_average": { "type": "integer", "title": "Agent Pending Average" }, "agent_pending_maximum": { "type": "integer", "title": "Agent Pending Maximum" }, "agent_pending_count": { "type": "integer", "title": "Agent Pending Count" }, "agent_failed_count": { "type": "integer", "title": "Agent Failed Count" }, "finetune_queued_average": { "type": "integer", "title": "Finetune Queued Average" }, "finetune_queued_maximum": { "type": "integer", "title": "Finetune Queued Maximum" }, "finetune_queued_count": { "type": "integer", "title": "Finetune Queued Count" }, "finetune_queued_by_model_name": { "additionalProperties": { "$ref": "#/components/schemas/SinceUpdateMetrics" }, "type": "object", "title": "Finetune Queued By Model Name" }, "alignment_queued_average": { "type": "integer", "title": "Alignment Queued Average" }, "alignment_queued_maximum": { "type": "integer", "title": "Alignment Queued Maximum" }, "alignment_queued_count": { "type": "integer", "title": "Alignment Queued Count" }, "environment_management_on": { "type": "string", "title": "Environment Management On" } }, "type": "object", "required": [ "deployment_pending_average", "deployment_pending_maximum", "deployment_pending_count", "deployment_pending_by_model_name", "version", "agent_pending_average", "agent_pending_maximum", "agent_pending_count", "agent_failed_count", "finetune_queued_average", "finetune_queued_maximum", "finetune_queued_count", "finetune_queued_by_model_name", "alignment_queued_average", "alignment_queued_maximum", "alignment_queued_count", "environment_management_on" ], "title": "GetHealthResponse" }, "GetMLModelHfRevision": { "properties": { "name": { "type": "string", "title": "Name" }, "hf_revision": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hf Revision" } }, "type": "object", "required": [ "name", "hf_revision" ], "title": "GetMLModelHfRevision" }, "GetMLModelInfoResponse": { "properties": { "name": { "type": "string", "title": "Name" }, "size": { "type": "integer", "title": "Size" }, "model_type": { "anyOf": [ { "$ref": "#/components/schemas/MLModelType" }, { "type": "null" } ] } }, "type": "object", "required": [ "name", "size", "model_type" ], "title": "GetMLModelInfoResponse" }, "GetMLModelsResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/MLModel" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "GetMLModelsResponse" }, "GetProjectsResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ProjectWithRuns" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "GetProjectsResponse" }, "GetToolsResponse": { "properties": { "data": { "items": { "oneOf": [ { "$ref": "#/components/schemas/FileSearchResponse" }, { "$ref": "#/components/schemas/RunPythonResponse" }, { "$ref": "#/components/schemas/WebSearchResponse" }, { "$ref": "#/components/schemas/AgentAsToolResponse" }, { "$ref": "#/components/schemas/MCPConnectorToolResponse" } ], "discriminator": { "propertyName": "type", "mapping": { "agent_as_tool": "#/components/schemas/AgentAsToolResponse", "file_search": "#/components/schemas/FileSearchResponse", "mcp_connector": "#/components/schemas/MCPConnectorToolResponse", "run_python": "#/components/schemas/RunPythonResponse", "web_search": "#/components/schemas/WebSearchResponse" } } }, "type": "array", "title": "Data" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total" } }, "type": "object", "required": [ "data" ], "title": "GetToolsResponse", "description": "Response schema for paginated tool list." }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "HardwareType": { "type": "string", "enum": [ "Serverless", "Dedicated" ], "title": "HardwareType" }, "IdList": { "properties": { "object": { "type": "string", "const": "list", "title": "Object", "default": "list" }, "data": { "items": { "type": "string" }, "type": "array", "title": "Data" } }, "additionalProperties": true, "type": "object", "required": [ "data" ], "title": "IdList", "description": "Generic response model for a list of resource IDs." }, "ImageResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "filename": { "type": "string", "title": "Filename" }, "uploaded_at": { "type": "string", "format": "date-time", "title": "Uploaded At" }, "bytes": { "type": "integer", "title": "Bytes" }, "file_hash": { "type": "string", "title": "File Hash" }, "algorithm": { "type": "string", "title": "Algorithm" }, "deleted_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Deleted At" } }, "additionalProperties": true, "type": "object", "required": [ "id", "filename", "uploaded_at", "bytes", "file_hash", "algorithm" ], "title": "ImageResponse" }, "InfluenceLevel": { "type": "string", "enum": [ "high", "medium", "low", "irrelevant" ], "title": "InfluenceLevel" }, "InfluentialFinetuningDataResponse": { "properties": { "answer": { "type": "string", "title": "Answer", "description": "The answer from the model or provided by the user" }, "results": { "items": { "$ref": "#/components/schemas/QuestionAnswerPair" }, "type": "array", "title": "Results", "description": "List of influential training data results" }, "version": { "type": "string", "title": "Version", "description": "Version of the explainability service" } }, "type": "object", "required": [ "answer", "results", "version" ], "title": "InfluentialFinetuningDataResponse", "description": "Response model for influential training data" }, "InfrastructureConfig": { "properties": { "accel_type": { "$ref": "#/components/schemas/AcceleratorType" }, "n_accel": { "type": "integer", "title": "N Accel" }, "n_node": { "type": "integer", "title": "N Node", "default": 1 } }, "additionalProperties": true, "type": "object", "required": [ "accel_type", "n_accel" ], "title": "InfrastructureConfig" }, "IngestionFileRecord": { "properties": { "record_id": { "type": "string", "title": "Record Id", "description": "File record ID" }, "ingestion_job_id": { "type": "string", "title": "Ingestion Job Id", "description": "Parent ingestion job ID" }, "alignment_file_id": { "type": "string", "title": "Alignment File Id", "description": "Alignment file ID" }, "user_id": { "type": "string", "title": "User Id", "description": "Owner of the ingestion job" }, "filename": { "type": "string", "title": "Filename", "description": "Filename" }, "metaflow_job_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Metaflow Job Id", "description": "Metaflow job handling this file" }, "method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Method", "description": "Ingestion method used for processing" }, "status": { "type": "string", "title": "Status", "description": "File processing status" }, "queue_position": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Queue Position", "description": "Position in queue if status is queued" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message", "description": "Error message if failed" }, "suggested_fix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Suggested Fix", "description": "Suggested fix when processing fails" }, "worker_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Worker Id", "description": "Worker currently handling the file" }, "deleted": { "type": "boolean", "title": "Deleted", "description": "Whether this record has been soft-deleted", "default": false }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "processing_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Processing At", "description": "Timestamp when processing started" }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At", "description": "Timestamp when processing completed" }, "failed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Failed At", "description": "Timestamp when processing failed" } }, "additionalProperties": true, "type": "object", "required": [ "record_id", "ingestion_job_id", "alignment_file_id", "user_id", "filename", "status", "created_at" ], "title": "IngestionFileRecord" }, "IngestionJobDetail": { "properties": { "id": { "type": "string", "title": "Id" }, "status": { "$ref": "#/components/schemas/IngestionJobStatus" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "file_ids": { "items": { "type": "string" }, "type": "array", "title": "File Ids" }, "records": { "items": { "$ref": "#/components/schemas/IngestionFileRecord" }, "type": "array", "title": "Records" } }, "type": "object", "required": [ "id", "status", "created_at", "updated_at" ], "title": "IngestionJobDetail" }, "IngestionJobStatus": { "type": "string", "enum": [ "queued", "running", "completed", "failed" ], "title": "IngestionJobStatus" }, "IngestionList": { "properties": { "object": { "anyOf": [ { "type": "string", "const": "list" }, { "type": "null" } ], "title": "Object" }, "data": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IngestionResponse" }, "type": "array" }, { "type": "null" } ], "title": "Data" } }, "additionalProperties": true, "type": "object", "title": "IngestionList" }, "IngestionRequest": { "properties": { "files": { "items": { "type": "string" }, "type": "array", "title": "Files", "description": "List of file ids to use for alignment" }, "method": { "type": "string", "title": "Method", "description": "Method to use for ingestion", "default": "best" } }, "additionalProperties": true, "type": "object", "required": [ "files" ], "title": "IngestionRequest" }, "IngestionResponse": { "properties": { "id": { "type": "string", "title": "Id", "description": "Ingestion job ID" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "status": { "$ref": "#/components/schemas/IngestionJobStatus" }, "output_files": { "items": { "type": "string" }, "type": "array", "title": "Output Files" }, "file_records": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IngestionFileRecord" }, "type": "array" }, { "type": "null" } ], "title": "File Records", "description": "Detailed file records with queue positions" } }, "additionalProperties": true, "type": "object", "required": [ "id", "created_at", "status", "output_files" ], "title": "IngestionResponse" }, "LLMGrader": { "properties": { "type": { "type": "string", "const": "llm", "title": "Type", "default": "llm" }, "weight": { "anyOf": [ { "type": "number", "maximum": 1, "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Weight" }, "seed": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Seed" }, "top_p": { "anyOf": [ { "type": "number", "maximum": 1, "minimum": 0 }, { "type": "null" } ], "title": "Top P" }, "temperature": { "type": "number", "maximum": 1.5, "minimum": 0, "title": "Temperature", "default": 0 }, "max_completion_tokens": { "type": "integer", "minimum": 1, "title": "Max Completion Tokens", "default": 512 } }, "type": "object", "title": "LLMGrader", "description": "LLM-as-a-judge grader.\n\nThe user-facing generation parameters live directly on the grader (no nested\nconfig). The training service injects operational settings (inference endpoint,\nconcurrency, timeouts) at runtime; those are not exposed to API users here." }, "LoRAConfig": { "properties": { "r": { "type": "integer", "exclusiveMinimum": 0, "title": "R", "description": "Rank of the update matrices.", "default": 8 }, "alpha": { "type": "integer", "exclusiveMinimum": 0, "title": "Alpha", "description": "Scaling factor applied to LoRA updates.", "default": 32 }, "dropout": { "type": "number", "maximum": 1, "minimum": 0, "title": "Dropout", "description": "Fraction of LoRA neurons dropped during training.", "default": 0.1 }, "bias": { "type": "string", "enum": [ "none", "all", "lora_only" ], "title": "Bias", "description": "Bias terms to train; choose from 'none', 'all', or 'lora_only'.", "default": "none" }, "extras": { "additionalProperties": true, "type": "object", "title": "Extras" } }, "additionalProperties": true, "type": "object", "title": "LoRAConfig" }, "MCPConnectorSyncRequest": { "properties": { "tool_id": { "type": "string", "title": "Tool Id", "description": "Tool ID in llm-training" }, "state": { "$ref": "#/components/schemas/MCPConnectorSyncState", "description": "Lifecycle state from mcp-vault" }, "connection_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Connection Version", "description": "Optional connection version for rotation tracking" } }, "type": "object", "required": [ "tool_id", "state" ], "title": "MCPConnectorSyncRequest", "description": "Request body for MCP connector lifecycle sync." }, "MCPConnectorSyncResponse": { "properties": { "tool_id": { "type": "string", "title": "Tool Id" }, "status": { "type": "string", "title": "Status" }, "applied": { "type": "boolean", "title": "Applied" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" } }, "type": "object", "required": [ "tool_id", "status", "applied" ], "title": "MCPConnectorSyncResponse", "description": "Response body when a state transition is applied." }, "MCPConnectorSyncState": { "type": "string", "enum": [ "Active", "Failed" ], "title": "MCPConnectorSyncState", "description": "Lifecycle state values sent by mcp-vault." }, "MCPConnectorToolConfig": { "properties": { "URL": { "type": "string", "minLength": 1, "title": "Url" }, "CLIENT_ID": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Client Id" }, "CLIENT_SECRET": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Client Secret" } }, "additionalProperties": false, "type": "object", "required": [ "URL" ], "title": "MCPConnectorToolConfig" }, "MCPConnectorToolEnv": { "properties": { "URL": { "type": "string", "minLength": 1, "title": "Url" }, "TRANSPORT": { "type": "string", "enum": [ "sse", "streamable-http" ], "title": "Transport", "default": "streamable-http" }, "AUTHORIZATION_URL": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization Url" } }, "type": "object", "required": [ "URL" ], "title": "MCPConnectorToolEnv" }, "MCPConnectorToolResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "type": { "type": "string", "const": "mcp_connector", "title": "Type", "default": "mcp_connector" }, "config": { "$ref": "#/components/schemas/MCPConnectorToolResponseConfig" }, "user_id": { "type": "string", "title": "User Id" }, "team_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Team Id" }, "status": { "$ref": "#/components/schemas/ToolStatus" }, "version": { "type": "integer", "title": "Version" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" } }, "type": "object", "required": [ "id", "name", "config", "user_id", "team_id", "status", "version", "created_at", "updated_at" ], "title": "MCPConnectorToolResponse" }, "MCPConnectorToolResponseConfig": { "properties": { "URL": { "type": "string", "minLength": 1, "title": "Url" }, "TRANSPORT": { "type": "string", "enum": [ "sse", "streamable-http" ], "title": "Transport", "default": "streamable-http" }, "AUTHORIZATION_URL": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization Url" } }, "additionalProperties": false, "type": "object", "required": [ "URL" ], "title": "MCPConnectorToolResponseConfig" }, "MLModel": { "properties": { "id": { "type": "integer", "title": "Id" }, "name": { "type": "string", "maxLength": 100, "minLength": 5, "title": "Name" }, "source": { "type": "string", "maxLength": 100, "minLength": 1, "title": "Source" }, "description": { "type": "string", "maxLength": 1000, "minLength": 5, "title": "Description" }, "size": { "type": "integer", "title": "Size" }, "logo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Logo" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" }, "model_type": { "$ref": "#/components/schemas/MLModelType" }, "inference_available": { "type": "boolean", "title": "Inference Available" }, "training_available": { "type": "boolean", "title": "Training Available" }, "deployment_available": { "type": "boolean", "title": "Deployment Available" }, "supports_lora": { "type": "boolean", "title": "Supports Lora" }, "max_lora_rank": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Max Lora Rank" }, "vision_model": { "type": "boolean", "title": "Vision Model" }, "hf_revision": { "anyOf": [ { "type": "string", "maxLength": 128, "minLength": 1 }, { "type": "null" } ], "title": "Hf Revision" }, "internal_only": { "type": "boolean", "title": "Internal Only" } }, "type": "object", "required": [ "id", "name", "source", "description", "size", "model_type", "inference_available", "training_available", "deployment_available", "supports_lora", "vision_model", "internal_only" ], "title": "MLModel" }, "MLModelType": { "type": "string", "enum": [ "Base", "Instruct", "Embedding" ], "title": "MLModelType" }, "MathAccuracyGrader": { "properties": { "type": { "type": "string", "const": "math_accuracy", "title": "Type", "default": "math_accuracy" }, "weight": { "anyOf": [ { "type": "number", "maximum": 1, "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Weight" } }, "type": "object", "title": "MathAccuracyGrader", "description": "Math-correctness grader. Carries no operation or config." }, "MetadataSnapshotKey": { "properties": { "key_name": { "type": "string", "title": "Key Name", "description": "Name of the metadata key." }, "value_type": { "type": "string", "enum": [ "string", "number", "boolean" ], "title": "Value Type", "description": "Inferred type of the key's values: `string`, `number`, or `boolean`." }, "top_values": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "type": "array", "title": "Top Values", "description": "Most common values for this key, ranked by how often they occur in the sample." } }, "type": "object", "required": [ "key_name", "value_type", "top_values" ], "title": "MetadataSnapshotKey" }, "NewDeploymentRequest": { "properties": { "model_type": { "$ref": "#/components/schemas/DeploymentType" }, "model_id": { "type": "string", "title": "Model Id" }, "name": { "type": "string", "maxLength": 100, "minLength": 5, "title": "Name" }, "description": { "type": "string", "maxLength": 1000, "minLength": 5, "title": "Description" }, "n_instances": { "type": "integer", "maximum": 50, "minimum": 1, "title": "N Instances" }, "hardware": { "anyOf": [ { "$ref": "#/components/schemas/AcceleratorType" }, { "type": "null" } ] } }, "type": "object", "required": [ "model_type", "model_id", "name", "description", "n_instances" ], "title": "NewDeploymentRequest" }, "PatchAgentRequest": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instructions" }, "model_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Id" }, "output": { "anyOf": [ { "$ref": "#/components/schemas/AgentOutputConfig" }, { "type": "null" } ], "description": "Optional configuration for the agent's final response. Overrides the top-level settings for response generation." }, "temperature": { "anyOf": [ { "type": "number", "maximum": 2, "minimum": 0 }, { "type": "null" } ], "title": "Temperature", "description": "Controls the predictability of the agent's reasoning. Accepts a value from `0` to `2`. Defaults to `0.6`. Lower values produce more consistent results, and higher values introduce more variation." }, "tool_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tool Ids" }, "reasoning_effort": { "anyOf": [ { "$ref": "#/components/schemas/ReasoningEffort" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "title": "PatchAgentRequest" }, "PatchAgentResponse": { "properties": { "before": { "$ref": "#/components/schemas/AgentSchema" }, "after": { "$ref": "#/components/schemas/AgentSchema" }, "diff": { "additionalProperties": { "additionalProperties": true, "type": "object" }, "type": "object", "title": "Diff", "default": {} } }, "type": "object", "required": [ "before", "after" ], "title": "PatchAgentResponse" }, "PatchAgentResponseV2": { "properties": { "before": { "$ref": "#/components/schemas/AgentSchemaV2" }, "after": { "$ref": "#/components/schemas/AgentSchemaV2" }, "diff": { "additionalProperties": { "additionalProperties": true, "type": "object" }, "type": "object", "title": "Diff", "default": {} } }, "type": "object", "required": [ "before", "after" ], "title": "PatchAgentResponseV2" }, "PatchToolBaseRequest": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "type": { "anyOf": [ { "$ref": "#/components/schemas/ToolType" }, { "type": "null" } ] }, "config": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Config" } }, "additionalProperties": false, "type": "object", "title": "PatchToolBaseRequest" }, "PatchToolResponse": { "properties": { "before": { "oneOf": [ { "$ref": "#/components/schemas/FileSearchResponse" }, { "$ref": "#/components/schemas/RunPythonResponse" }, { "$ref": "#/components/schemas/WebSearchResponse" }, { "$ref": "#/components/schemas/AgentAsToolResponse" }, { "$ref": "#/components/schemas/MCPConnectorToolResponse" } ], "title": "Before", "discriminator": { "propertyName": "type", "mapping": { "agent_as_tool": "#/components/schemas/AgentAsToolResponse", "file_search": "#/components/schemas/FileSearchResponse", "mcp_connector": "#/components/schemas/MCPConnectorToolResponse", "run_python": "#/components/schemas/RunPythonResponse", "web_search": "#/components/schemas/WebSearchResponse" } } }, "after": { "oneOf": [ { "$ref": "#/components/schemas/FileSearchResponse" }, { "$ref": "#/components/schemas/RunPythonResponse" }, { "$ref": "#/components/schemas/WebSearchResponse" }, { "$ref": "#/components/schemas/AgentAsToolResponse" }, { "$ref": "#/components/schemas/MCPConnectorToolResponse" } ], "title": "After", "discriminator": { "propertyName": "type", "mapping": { "agent_as_tool": "#/components/schemas/AgentAsToolResponse", "file_search": "#/components/schemas/FileSearchResponse", "mcp_connector": "#/components/schemas/MCPConnectorToolResponse", "run_python": "#/components/schemas/RunPythonResponse", "web_search": "#/components/schemas/WebSearchResponse" } } }, "diff": { "additionalProperties": { "additionalProperties": true, "type": "object" }, "type": "object", "title": "Diff", "default": {} } }, "type": "object", "required": [ "before", "after" ], "title": "PatchToolResponse" }, "PopulateIndexRequest": { "properties": { "index_name": { "type": "string", "title": "Index Name", "description": "Name of the vector database to use for population" }, "user_id": { "type": "string", "title": "User Id", "description": "User ID" }, "team_id": { "type": "string", "title": "Team Id", "description": "Team ID" }, "file_ids": { "items": { "type": "string" }, "type": "array", "title": "File Ids", "description": "List of training file IDs to create the index with" } }, "type": "object", "required": [ "index_name", "user_id", "team_id", "file_ids" ], "title": "PopulateIndexRequest", "description": "Request model for populating explainability index" }, "PopulateIndexResponse": { "properties": { "job_id": { "type": "string", "title": "Job Id", "description": "Job ID for the index population task" }, "status": { "type": "string", "title": "Status", "description": "Status of the index population task" } }, "type": "object", "required": [ "job_id", "status" ], "title": "PopulateIndexResponse", "description": "Response model for populate index operation" }, "PostProjectRequest": { "properties": { "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "name": { "type": "string", "maxLength": 100, "minLength": 5, "title": "Name" }, "description": { "type": "string", "maxLength": 1000, "minLength": 5, "title": "Description" } }, "type": "object", "required": [ "name", "description" ], "title": "PostProjectRequest" }, "PricingEstimateDedicatedInferenceRequestModel": { "properties": { "deployment": { "$ref": "#/components/schemas/NewDeploymentRequest" }, "estimated_compute_hours": { "anyOf": [ { "type": "integer", "maximum": 8760, "minimum": 1 }, { "type": "null" } ], "title": "Estimated Compute Hours" } }, "type": "object", "required": [ "deployment", "estimated_compute_hours" ], "title": "PricingEstimateDedicatedInferenceRequestModel" }, "PricingEstimateFineTuningRequestModel": { "properties": { "deployment": { "$ref": "#/components/schemas/NewDeploymentRequest" }, "num_of_epochs": { "type": "integer", "maximum": 2000, "minimum": 1, "title": "Num Of Epochs" }, "file_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "File Ids" } }, "type": "object", "required": [ "deployment", "num_of_epochs" ], "title": "PricingEstimateFineTuningRequestModel" }, "PricingEstimateResponseModel": { "properties": { "status": { "type": "integer", "title": "Status" }, "pricing_estimate": { "type": "number", "title": "Pricing Estimate" }, "billing_type": { "$ref": "#/components/schemas/BillingType" }, "resource_type": { "$ref": "#/components/schemas/HardwareType" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "deployment": { "$ref": "#/components/schemas/NewDeploymentRequest" }, "description": { "type": "string", "title": "Description" }, "tokens_used": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Tokens Used" }, "calculation_parameters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/CalculationParameter" }, "type": "array" }, { "type": "null" } ], "title": "Calculation Parameters" } }, "type": "object", "required": [ "status", "pricing_estimate", "billing_type", "resource_type", "created_at", "deployment", "description" ], "title": "PricingEstimateResponseModel" }, "PricingEstimateServerlessInferenceRequestModel": { "properties": { "deployment": { "$ref": "#/components/schemas/NewDeploymentRequest" }, "file_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "File Ids" } }, "type": "object", "required": [ "deployment" ], "title": "PricingEstimateServerlessInferenceRequestModel" }, "Project": { "properties": { "id": { "type": "integer", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "user_id": { "type": "string", "title": "User Id" }, "team_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Team Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" } }, "type": "object", "required": [ "id", "name", "description", "user_id", "team_id", "created_at", "updated_at" ], "title": "Project" }, "ProjectWithRuns": { "properties": { "id": { "type": "integer", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "user_id": { "type": "string", "title": "User Id" }, "team_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Team Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "runs": { "type": "integer", "title": "Runs" }, "runs_deployed": { "type": "integer", "title": "Runs Deployed" }, "last_modified": { "type": "string", "format": "date-time", "title": "Last Modified" } }, "type": "object", "required": [ "id", "name", "description", "user_id", "team_id", "created_at", "updated_at", "runs", "runs_deployed", "last_modified" ], "title": "ProjectWithRuns" }, "QuestionAnswerPair": { "properties": { "id": { "type": "string", "title": "Id", "description": "Unique identifier for the QA pair" }, "file_id": { "type": "string", "title": "File Id", "description": "ID of the source file" }, "influence_level": { "$ref": "#/components/schemas/InfluenceLevel", "description": "Level of influence this QA pair has (high, medium, low, irrelevant)" }, "messages": { "type": "string", "title": "Messages", "description": "The question-answer content" } }, "type": "object", "required": [ "id", "file_id", "influence_level", "messages" ], "title": "QuestionAnswerPair" }, "ReasoningEffort": { "type": "string", "enum": [ "low", "medium", "high", "speed_optimized", "performance_optimized" ], "title": "ReasoningEffort", "description": "Controls how much reasoning the agent uses when working through a request. Accepts `low`, `medium`, or `high`, where higher levels produce more thorough reasoning. The `speed_optimized` and `performance_optimized` values are only supported for backward compatibility. `speed_optimized` maps to `low`, and `performance_optimized` maps to `high`." }, "RequestConfig": { "properties": { "project_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Project Id" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "training_config": { "$ref": "#/components/schemas/TrainingConfig" }, "infrastructure_config": { "$ref": "#/components/schemas/InfrastructureConfig" } }, "type": "object", "required": [ "training_config", "infrastructure_config" ], "title": "RequestConfig" }, "ResourceDeploymentEventResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "resource_id": { "type": "string", "title": "Resource Id" }, "resource_type": { "type": "string", "title": "Resource Type" }, "resource_amount": { "type": "integer", "title": "Resource Amount" }, "allocation_type": { "type": "string", "title": "Allocation Type" }, "user_id": { "type": "string", "title": "User Id" }, "event_timestamp": { "type": "string", "format": "date-time", "title": "Event Timestamp" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "resource_id", "resource_type", "resource_amount", "allocation_type", "user_id", "event_timestamp", "created_at" ], "title": "ResourceDeploymentEventResponse" }, "ResourceDeploymentEventsListResponse": { "properties": { "object": { "type": "string", "const": "list", "title": "Object", "default": "list" }, "data": { "items": { "$ref": "#/components/schemas/ResourceDeploymentEventResponse" }, "type": "array", "title": "Data" }, "event_timestamp_start": { "type": "string", "format": "date-time", "title": "Event Timestamp Start" }, "event_timestamp_end": { "type": "string", "format": "date-time", "title": "Event Timestamp End" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "has_more": { "type": "boolean", "title": "Has More", "default": false } }, "type": "object", "required": [ "event_timestamp_start", "event_timestamp_end" ], "title": "ResourceDeploymentEventsListResponse" }, "ResourceDeploymentEventsQuery": { "properties": { "event_timestamp_start": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Event Timestamp Start" }, "event_timestamp_end": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Event Timestamp End" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id" }, "resource_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resource Id" }, "limit": { "type": "integer", "maximum": 1000, "minimum": 1, "title": "Limit", "default": 500 }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" }, "order": { "type": "string", "enum": [ "asc", "desc" ], "title": "Order", "default": "asc" } }, "type": "object", "title": "ResourceDeploymentEventsQuery" }, "RewardComponents": { "properties": { "format_reward_weight": { "type": "number", "maximum": 1, "exclusiveMinimum": 0, "title": "Format Reward Weight", "default": 0.1 }, "graders": { "items": { "oneOf": [ { "$ref": "#/components/schemas/FormatCheckGrader" }, { "$ref": "#/components/schemas/MathAccuracyGrader" }, { "$ref": "#/components/schemas/StringCheckGrader" }, { "$ref": "#/components/schemas/TextSimilarityGrader" }, { "$ref": "#/components/schemas/LLMGrader" } ], "discriminator": { "propertyName": "type", "mapping": { "format_check": "#/components/schemas/FormatCheckGrader", "llm": "#/components/schemas/LLMGrader", "math_accuracy": "#/components/schemas/MathAccuracyGrader", "string_check": "#/components/schemas/StringCheckGrader", "text_similarity": "#/components/schemas/TextSimilarityGrader" } } }, "type": "array", "minItems": 1, "title": "Graders" } }, "additionalProperties": true, "type": "object", "required": [ "graders" ], "title": "RewardComponents" }, "RunPythonConfig": { "properties": { "FUNCTION_IDS": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Function Ids" } }, "additionalProperties": false, "type": "object", "title": "RunPythonConfig" }, "RunPythonEnv": { "properties": { "RUN_PYTHON_TOOL_DESC": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Run Python Tool Desc" }, "FUNCTION_IDS": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Function Ids" } }, "type": "object", "title": "RunPythonEnv" }, "RunPythonResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "type": { "type": "string", "const": "run_python", "title": "Type", "default": "run_python" }, "config": { "$ref": "#/components/schemas/RunPythonConfig", "default": {} }, "user_id": { "type": "string", "title": "User Id" }, "team_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Team Id" }, "status": { "$ref": "#/components/schemas/ToolStatus" }, "version": { "type": "integer", "title": "Version" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" } }, "type": "object", "required": [ "id", "name", "user_id", "team_id", "status", "version", "created_at", "updated_at" ], "title": "RunPythonResponse" }, "SinceUpdateMetrics": { "properties": { "average": { "type": "integer", "title": "Average" }, "maximum": { "type": "integer", "title": "Maximum" }, "count": { "type": "integer", "title": "Count" } }, "type": "object", "required": [ "average", "maximum", "count" ], "title": "SinceUpdateMetrics" }, "SortableField": { "type": "string", "enum": [ "name", "created_at", "job_type" ], "title": "SortableField", "description": "Valid fields for sorting data jobs." }, "StatusUpdate": { "properties": { "status": { "type": "string", "enum": [ "RUNNING", "COMPLETED", "FAILED" ], "title": "Status" }, "checkpoint_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Checkpoint Path" } }, "type": "object", "required": [ "status" ], "title": "StatusUpdate" }, "StringCheckGrader": { "properties": { "type": { "type": "string", "const": "string_check", "title": "Type", "default": "string_check" }, "weight": { "anyOf": [ { "type": "number", "maximum": 1, "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Weight" }, "operation": { "$ref": "#/components/schemas/StringOperation" } }, "type": "object", "required": [ "operation" ], "title": "StringCheckGrader", "description": "String-comparison grader. Requires a StringOperation." }, "StringOperation": { "type": "string", "enum": [ "equals", "not_equals", "contains", "case_insensitive_contains" ], "title": "StringOperation" }, "TagStrategy": { "type": "string", "enum": [ "contains", "overlap" ], "title": "TagStrategy" }, "TextSimilarityGrader": { "properties": { "type": { "type": "string", "const": "text_similarity", "title": "Type", "default": "text_similarity" }, "weight": { "anyOf": [ { "type": "number", "maximum": 1, "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Weight" }, "operation": { "$ref": "#/components/schemas/TextSimilarityOperation" } }, "type": "object", "required": [ "operation" ], "title": "TextSimilarityGrader", "description": "Text-similarity grader. Requires a TextSimilarityOperation." }, "TextSimilarityOperation": { "type": "string", "enum": [ "bleu", "rouge" ], "title": "TextSimilarityOperation" }, "TimelineEvent": { "properties": { "timestamp": { "type": "string", "format": "date-time", "title": "Timestamp" }, "event_type": { "type": "string", "title": "Event Type" }, "message": { "type": "string", "title": "Message" }, "metadata": { "additionalProperties": true, "type": "object", "title": "Metadata" } }, "type": "object", "required": [ "timestamp", "event_type", "message" ], "title": "TimelineEvent" }, "ToolAgentSummarySchema": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "status": { "$ref": "#/components/schemas/AgentStatus" } }, "type": "object", "required": [ "id", "name", "status" ], "title": "ToolAgentSummarySchema", "description": "Schema for tool agent summary." }, "ToolConfig": { "properties": {}, "additionalProperties": false, "type": "object", "title": "ToolConfig" }, "ToolDeleteResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "deleted": { "type": "boolean", "title": "Deleted" }, "message": { "type": "string", "title": "Message" } }, "type": "object", "required": [ "id", "deleted", "message" ], "title": "ToolDeleteResponse", "description": "Response schema for tool deletion." }, "ToolDuplicateRequest": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" } }, "type": "object", "title": "ToolDuplicateRequest", "description": "Request schema for duplicating a tool." }, "ToolEnv": { "properties": {}, "type": "object", "title": "ToolEnv", "description": "Base class for tool environments." }, "ToolStatus": { "type": "string", "enum": [ "Active", "Inactive", "Deprecated", "Pending_authorization", "Failed" ], "title": "ToolStatus" }, "ToolType": { "type": "string", "enum": [ "file_search", "web_search", "run_python", "agent_as_tool", "mcp_connector" ], "title": "ToolType" }, "TrainingConfig": { "properties": { "training_files": { "items": { "type": "string" }, "type": "array", "title": "Training Files" }, "model": { "type": "string", "title": "Model" }, "n_epochs": { "type": "integer", "title": "N Epochs" }, "learning_rate": { "type": "number", "title": "Learning Rate" }, "n_checkpoints": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "N Checkpoints" }, "batch_size": { "type": "integer", "maximum": 1024, "minimum": 1, "title": "Batch Size" }, "experiment_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Experiment Name" }, "max_length": { "type": "integer", "title": "Max Length", "default": 2500 }, "pre_train": { "type": "boolean", "title": "Pre Train", "default": false }, "fine_tune_type": { "$ref": "#/components/schemas/FineTuneType", "default": "STANDARD" }, "lora_config": { "anyOf": [ { "$ref": "#/components/schemas/LoRAConfig" }, { "type": "null" } ] }, "reward_components": { "anyOf": [ { "$ref": "#/components/schemas/RewardComponents" }, { "type": "null" } ] }, "beta": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Beta" }, "loss_type": { "anyOf": [ { "type": "string", "enum": [ "SIGMOID", "HINGE", "IPO", "KTO_PAIR" ] }, { "type": "null" } ], "title": "Loss Type" }, "gradient_checkpointing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Gradient Checkpointing" } }, "additionalProperties": true, "type": "object", "required": [ "training_files", "model", "n_epochs", "learning_rate", "batch_size" ], "title": "TrainingConfig" }, "TrainingFileType": { "type": "string", "enum": [ "jsonl", "parquet", "pt" ], "title": "TrainingFileType" }, "UpdateAgentRequest": { "properties": { "name": { "type": "string", "title": "Name" }, "instructions": { "type": "string", "title": "Instructions" }, "tools": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/llm_training__agents__tools__schemas__file_search__CreateFileSearch" }, { "$ref": "#/components/schemas/llm_training__agents__tools__schemas__web_search__CreateWebSearch" }, { "$ref": "#/components/schemas/llm_training__agents__tools__schemas__run_python__CreateRunPython" } ], "discriminator": { "propertyName": "name", "mapping": { "file_search": "#/components/schemas/llm_training__agents__tools__schemas__file_search__CreateFileSearch", "run_python": "#/components/schemas/llm_training__agents__tools__schemas__run_python__CreateRunPython", "web_search": "#/components/schemas/llm_training__agents__tools__schemas__web_search__CreateWebSearch" } } }, "type": "array" }, { "type": "null" } ], "title": "Tools", "description": "DEPRECATED: Use `tool_ids` instead.", "deprecated": true }, "tool_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tool Ids", "description": "Preferred way to associate tools with an agent." }, "model_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Id" }, "output": { "anyOf": [ { "$ref": "#/components/schemas/AgentOutputConfig" }, { "type": "null" } ] }, "temperature": { "anyOf": [ { "type": "number", "maximum": 2, "minimum": 0 }, { "type": "null" } ], "title": "Temperature" }, "reasoning_effort": { "anyOf": [ { "$ref": "#/components/schemas/ReasoningEffort" }, { "type": "null" } ], "default": "medium" } }, "additionalProperties": false, "type": "object", "required": [ "name", "instructions" ], "title": "UpdateAgentRequest" }, "UpdateCaseRequest": { "properties": { "question": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Question" }, "ground_truth": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ground Truth" }, "case_metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Case Metadata" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" } }, "type": "object", "title": "UpdateCaseRequest" }, "UpdateDeploymentRequest": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" } }, "type": "object", "title": "UpdateDeploymentRequest" }, "UpdateDeploymentStatusRequest": { "properties": { "status": { "$ref": "#/components/schemas/DeploymentStatus" }, "last_deployed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Deployed At" } }, "type": "object", "required": [ "status" ], "title": "UpdateDeploymentStatusRequest" }, "UpdateFeedbackRequest": { "properties": { "model_id": { "type": "string", "title": "Model Id", "description": "The name of a model (TinyLlama/TinyLlama-1.1B-Chat-v1.0) deployment id" }, "feedback": { "additionalProperties": true, "type": "object", "title": "Feedback", "description": "Json object. If images are included, they must be base64 encoded." }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "The version of feedback data" }, "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags", "description": "List of tags" } }, "type": "object", "required": [ "model_id", "feedback" ], "title": "UpdateFeedbackRequest" }, "UpdateFineTuneRequest": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" } }, "type": "object", "title": "UpdateFineTuneRequest" }, "UpdateVectorDbRequest": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 100, "minLength": 1 }, { "type": "null" } ], "title": "Name", "description": "New name of the vector database" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Description", "description": "New description of the vector database" }, "db_type": { "anyOf": [ { "$ref": "#/components/schemas/DBType" }, { "type": "null" } ], "description": "Type of vector database to create", "examples": [ "RAG", "explainability" ] } }, "type": "object", "title": "UpdateVectorDbRequest" }, "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" }, "VectorDatabaseChunkListItem": { "properties": { "chunk_id": { "type": "string", "title": "Chunk Id" }, "file_id": { "type": "string", "title": "File Id" }, "text": { "type": "string", "title": "Text" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" }, "hierarchy": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Hierarchy" }, "locations": { "anyOf": [ { "items": { "$ref": "#/components/schemas/VectorDatabaseMarkdownLocation" }, "type": "array" }, { "type": "null" } ], "title": "Locations" } }, "type": "object", "required": [ "chunk_id", "file_id", "text" ], "title": "VectorDatabaseChunkListItem" }, "VectorDatabaseChunkListResponse": { "properties": { "object": { "type": "string", "const": "list", "title": "Object", "default": "list" }, "data": { "items": { "$ref": "#/components/schemas/VectorDatabaseChunkListItem" }, "type": "array", "title": "Data" }, "total": { "type": "integer", "title": "Total" }, "limit": { "type": "integer", "title": "Limit" }, "offset": { "type": "integer", "title": "Offset" } }, "type": "object", "required": [ "data", "total", "limit", "offset" ], "title": "VectorDatabaseChunkListResponse" }, "VectorDatabaseChunkResponse": { "properties": { "chunk_id": { "type": "string", "title": "Chunk Id" }, "file_id": { "type": "string", "title": "File Id" }, "text": { "type": "string", "title": "Text" }, "locations": { "anyOf": [ { "items": { "$ref": "#/components/schemas/VectorDatabaseMarkdownLocation" }, "type": "array" }, { "type": "null" } ], "title": "Locations" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata", "description": "User-defined metadata attached to this chunk at ingestion time, or updated via PATCH /vectordb/{database_id}/metadata. Null if no metadata was provided." } }, "type": "object", "required": [ "chunk_id", "file_id", "text" ], "title": "VectorDatabaseChunkResponse" }, "VectorDatabaseChunkSearchRequest": { "properties": { "file_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Id", "description": "Filter to chunks from a specific file" }, "chunk_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Chunk Ids", "description": "Chunk IDs to retrieve" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata", "description": "Metadata key-value filters with optional operators ($gt, $gte, $lt, $lte, $in). Example: {\"year\": {\"$gte\": 2023}, \"doc_type\": \"SOP\"}" }, "limit": { "type": "integer", "maximum": 100, "minimum": 1, "title": "Limit", "description": "Max results to return", "default": 20 }, "offset": { "type": "integer", "minimum": 0, "title": "Offset", "description": "Pagination offset", "default": 0 } }, "type": "object", "title": "VectorDatabaseChunkSearchRequest", "description": "Request body for searching/listing chunks in a vector database." }, "VectorDatabaseCreate": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the vector database" }, "model": { "type": "string", "title": "Model", "description": "Model used to generate the vectors" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Optional description" }, "db_type": { "anyOf": [ { "$ref": "#/components/schemas/DBType" }, { "type": "null" } ], "description": "Type of vector database to create", "default": "RAG" } }, "type": "object", "required": [ "name", "model" ], "title": "VectorDatabaseCreate" }, "VectorDatabaseDeleteResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "object": { "type": "string", "const": "vector_database", "title": "Object" }, "deleted": { "type": "boolean", "title": "Deleted" } }, "type": "object", "required": [ "id", "object", "deleted" ], "title": "VectorDatabaseDeleteResponse" }, "VectorDatabaseFileDeleteResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "object": { "type": "string", "const": "vector_database.file", "title": "Object" }, "deleted": { "type": "boolean", "title": "Deleted" } }, "type": "object", "required": [ "id", "object", "deleted" ], "title": "VectorDatabaseFileDeleteResponse" }, "VectorDatabaseFileList": { "properties": { "object": { "type": "string", "title": "Object", "default": "list" }, "data": { "items": { "$ref": "#/components/schemas/VectorDatabaseFileResponse" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "VectorDatabaseFileList", "description": "Response model for a list of vector database files" }, "VectorDatabaseFileResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "record_id": { "type": "string", "title": "Record Id" }, "vector_database_id": { "type": "string", "title": "Vector Database Id" }, "filename": { "type": "string", "title": "Filename" }, "method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Method" }, "chunk_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Chunk Method" }, "token_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Token Count" }, "overlap_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Overlap Tokens" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "ingestion_job_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ingestion Job Id" }, "status": { "type": "string", "title": "Status" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message" }, "suggested_fix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Suggested Fix" }, "processing_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Processing At" }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At" }, "failed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Failed At" }, "file_size_in_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "File Size In Bytes" }, "queue_position": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Queue Position", "description": "Position in queue if status is queued" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata", "description": "User-defined metadata associated with this file's chunks. Set at ingestion time or updated via PATCH /vectordb/{database_id}/metadata." } }, "type": "object", "required": [ "id", "record_id", "vector_database_id", "filename", "created_at", "status" ], "title": "VectorDatabaseFileResponse", "description": "Response model for a vector database file" }, "VectorDatabaseIngestionList": { "properties": { "object": { "type": "string", "const": "list", "title": "Object" }, "data": { "items": { "$ref": "#/components/schemas/VectorDatabaseIngestionResponse" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "object", "data" ], "title": "VectorDatabaseIngestionList" }, "VectorDatabaseIngestionRequest": { "properties": { "file_ids": { "items": { "type": "string" }, "type": "array", "title": "File Ids", "description": "List of file ids to use for alignment" }, "method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Method", "description": "Document extraction strategy used to convert raw files into clean markdown before chunking. `accuracy-optimized` (default) — runs the full Seekr extraction pipeline: tries up to 12 conversion methods in priority order (bookmark-aware hybrid extraction, Seekr-SaaS OCR, LLM post-processing, PyMuPDF, and more) with no word-count restrictions, selecting the highest-quality result for each document. Best for complex PDFs, tables, and documents where retrieval accuracy matters. `speed-optimized` — uses the same pipeline but skips methods that exceed per-method word-count thresholds, dramatically reducing processing time on large documents while still producing high-quality output.", "default": "accuracy-optimized", "examples": [ "accuracy-optimized", "speed-optimized" ] }, "chunking_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Chunking Method", "description": "Strategy used to split the extracted markdown into chunks before embedding. `markdown` (default) — parses the heading hierarchy (`#`–`######`) to identify section boundaries, groups subsections into token-bounded chunks, and intelligently handles tables by repeating table headers across continuation chunks so every chunk is self-contained. Best for structured documents (reports, policies, manuals). `semantic` — uses spaCy sentence detection, generates paragraph-level embeddings, then applies Ward hierarchical clustering to group paragraphs by meaning rather than position. Produces topically coherent chunks even in poorly structured documents — ideal for improving answer quality on complex question-answering workloads. `sliding` — fixed-size overlapping windows with no structural awareness. Fast and predictable; best for plain-text or homogeneous content where document structure is absent.", "default": "markdown", "examples": [ "markdown", "semantic", "sliding" ] }, "token_count": { "type": "integer", "title": "Token Count", "description": "Target maximum tokens per chunk.", "default": 800 }, "overlap_tokens": { "type": "integer", "title": "Overlap Tokens", "description": "Number of tokens repeated at the start of each chunk from the end of the previous one, preserving context across chunk boundaries.", "default": 100 }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata", "description": "Optional flat JSON object attached to every chunk produced by this ingestion job. Constraints: (1) must be a flat object — no nested objects or arrays; (2) values must be string, number, boolean, or datetime (null is rejected); (3) maximum 20 fields; (4) string values are trimmed of leading/trailing whitespace and newlines are replaced with spaces. Example: {\"year\": 2024, \"doc_type\": \"policy\", \"is_confidential\": false}", "examples": [ { "doc_type": "policy", "is_confidential": false, "year": 2024 } ] } }, "type": "object", "required": [ "file_ids" ], "title": "VectorDatabaseIngestionRequest" }, "VectorDatabaseIngestionResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "vector_database_id": { "type": "string", "title": "Vector Database Id" }, "status": { "type": "string", "title": "Status" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message" }, "file_ids": { "items": { "type": "string" }, "type": "array", "title": "File Ids" }, "metaflow_run_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Metaflow Run Id" }, "file_records": { "anyOf": [ { "items": { "$ref": "#/components/schemas/VectorDatabaseFileResponse" }, "type": "array" }, { "type": "null" } ], "title": "File Records" } }, "type": "object", "required": [ "id", "vector_database_id", "status", "created_at", "updated_at", "error_message", "file_ids", "metaflow_run_id" ], "title": "VectorDatabaseIngestionResponse" }, "VectorDatabaseList": { "properties": { "object": { "type": "string", "const": "list", "title": "Object" }, "data": { "items": { "$ref": "#/components/schemas/VectorDatabaseResponse" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "object", "data" ], "title": "VectorDatabaseList" }, "VectorDatabaseMarkdownLocation": { "properties": { "line_number_start": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Line Number Start" }, "line_number_end": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Line Number End" }, "char_start": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Char Start" }, "char_end": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Char End" }, "hierarchy": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Hierarchy" }, "page_number": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Page Number" } }, "type": "object", "title": "VectorDatabaseMarkdownLocation" }, "VectorDatabaseMetadataSnapshotGenerateResponse": { "properties": { "vector_database_id": { "type": "string", "title": "Vector Database Id", "description": "ID of the vector database the snapshot describes." }, "keys_captured": { "type": "integer", "title": "Keys Captured", "description": "Number of metadata keys captured in the snapshot." }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "Time the snapshot was generated." } }, "type": "object", "required": [ "vector_database_id", "keys_captured", "created_at" ], "title": "VectorDatabaseMetadataSnapshotGenerateResponse" }, "VectorDatabaseMetadataSnapshotResponse": { "properties": { "vector_database_id": { "type": "string", "title": "Vector Database Id", "description": "ID of the vector database the snapshot describes." }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "Time the current snapshot was generated." }, "keys": { "items": { "$ref": "#/components/schemas/MetadataSnapshotKey" }, "type": "array", "title": "Keys", "description": "Captured metadata keys, each with its inferred type and most common values." } }, "type": "object", "required": [ "vector_database_id", "created_at", "keys" ], "title": "VectorDatabaseMetadataSnapshotResponse" }, "VectorDatabaseMetadataUpdateRequest": { "properties": { "file_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "minItems": 1 }, { "type": "null" } ], "title": "File Ids", "description": "File IDs whose chunks should have their metadata replaced.", "examples": [ [ "file_789", "file_012" ] ] }, "chunk_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "minItems": 1 }, { "type": "null" } ], "title": "Chunk Ids", "description": "Chunk IDs to update metadata on directly.", "examples": [ [ "chunk_789", "chunk_012" ] ] }, "metadata": { "additionalProperties": true, "type": "object", "title": "Metadata", "description": "Key-value pairs to write onto every targeted chunk. Replaces all existing metadata. Constraints: (1) flat object only — no nested objects or arrays; (2) values must be string, number, boolean, or datetime (null is rejected); (3) maximum 20 fields.", "examples": [ { "category": "support_doc", "confidence": "medium", "source": "manual_review" } ] } }, "type": "object", "required": [ "metadata" ], "title": "VectorDatabaseMetadataUpdateRequest", "description": "Request body for overwriting chunk metadata within a vector database.\n\nThis operation is **destructive**: the provided `metadata` object replaces all\nexisting metadata on the targeted chunks. Any previous metadata fields not\nincluded in the new object are permanently removed.\n\nProvide exactly one of `file_ids` or `chunk_ids` to target chunks." }, "VectorDatabaseMetadataUpdateResponse": { "properties": { "metadata": { "additionalProperties": true, "type": "object", "title": "Metadata", "description": "The metadata object that was written to all matching chunks." } }, "type": "object", "required": [ "metadata" ], "title": "VectorDatabaseMetadataUpdateResponse" }, "VectorDatabaseResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "model": { "type": "string", "title": "Model" }, "dimension": { "type": "integer", "title": "Dimension" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "file_count": { "type": "integer", "title": "File Count" }, "size_in_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Size In Bytes" }, "db_type": { "anyOf": [ { "$ref": "#/components/schemas/DBType" }, { "type": "null" } ] } }, "type": "object", "required": [ "id", "name", "model", "dimension", "description", "created_at", "updated_at", "file_count", "db_type" ], "title": "VectorDatabaseResponse" }, "WebSearchEnv": { "properties": { "WEB_SEARCH_TOOL_DESCRIPTION": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Web Search Tool Description" } }, "type": "object", "title": "WebSearchEnv" }, "WebSearchResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "type": { "type": "string", "const": "web_search", "title": "Type", "default": "web_search" }, "user_id": { "type": "string", "title": "User Id" }, "team_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Team Id" }, "status": { "$ref": "#/components/schemas/ToolStatus" }, "version": { "type": "integer", "title": "Version" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" } }, "type": "object", "required": [ "id", "name", "user_id", "team_id", "status", "version", "created_at", "updated_at" ], "title": "WebSearchResponse" }, "WorkflowPhaseResponse": { "properties": { "phase": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phase" } }, "additionalProperties": true, "type": "object", "title": "WorkflowPhaseResponse", "description": "Internal: the Argo workflow phase backing a job.\n\n``phase`` is the raw Argo phase (e.g. Running, Succeeded, Failed, Error) or\n``None`` when the workflow no longer exists / was never started. Not part of\nthe public SDK — used to verify a cancelled job's workflow actually\nterminated." }, "llm_training__agents__tools__schemas__agent_as_tool__AgentAsTool": { "properties": { "name": { "type": "string", "const": "agent_as_tool", "title": "Name", "default": "agent_as_tool" }, "tool_env": { "$ref": "#/components/schemas/ToolEnv", "default": {} }, "id": { "type": "string", "title": "Id" }, "agent_id": { "type": "string", "title": "Agent Id" }, "description": { "type": "string", "title": "Description" } }, "type": "object", "required": [ "agent_id", "description" ], "title": "AgentAsTool" }, "llm_training__agents__tools__schemas__file_search__CreateFileSearch": { "properties": { "name": { "type": "string", "const": "file_search", "title": "Name" }, "tool_env": { "$ref": "#/components/schemas/FileSearchEnv" } }, "type": "object", "required": [ "name", "tool_env" ], "title": "CreateFileSearch", "examples": [ { "name": "file_search", "tool_env": { "document_tool_desc": "Search through uploaded documents", "file_search_index": "my-document-index", "score_threshold": 0.7, "top_k": 10 } } ] }, "llm_training__agents__tools__schemas__file_search__FileSearch": { "properties": { "name": { "type": "string", "const": "file_search", "title": "Name" }, "tool_env": { "$ref": "#/components/schemas/FileSearchEnv" }, "id": { "type": "string", "title": "Id" } }, "type": "object", "required": [ "name", "tool_env" ], "title": "FileSearch" }, "llm_training__agents__tools__schemas__mcp_connector__MCPConnectorTool": { "properties": { "name": { "type": "string", "const": "mcp_connector", "title": "Name" }, "tool_env": { "$ref": "#/components/schemas/MCPConnectorToolEnv" }, "id": { "type": "string", "title": "Id" } }, "type": "object", "required": [ "name", "tool_env" ], "title": "MCPConnectorTool" }, "llm_training__agents__tools__schemas__run_python__CreateRunPython": { "properties": { "name": { "type": "string", "const": "run_python", "title": "Name" }, "tool_env": { "$ref": "#/components/schemas/RunPythonEnv" } }, "type": "object", "required": [ "name", "tool_env" ], "title": "CreateRunPython", "examples": [ { "name": "run_python", "tool_env": { "function_ids": [ "func-123", "func-456" ], "run_python_tool_desc": "Execute Python code for data analysis and calculations" } } ] }, "llm_training__agents__tools__schemas__run_python__RunPython": { "properties": { "name": { "type": "string", "const": "run_python", "title": "Name", "default": "run_python" }, "tool_env": { "$ref": "#/components/schemas/RunPythonEnv" }, "id": { "type": "string", "title": "Id" } }, "type": "object", "required": [ "tool_env" ], "title": "RunPython" }, "llm_training__agents__tools__schemas__web_search__CreateWebSearch": { "properties": { "name": { "type": "string", "const": "web_search", "title": "Name" }, "tool_env": { "$ref": "#/components/schemas/WebSearchEnv" } }, "type": "object", "required": [ "name", "tool_env" ], "title": "CreateWebSearch", "examples": [ { "name": "web_search", "tool_env": { "web_search_tool_description": "Search the web for current information and news" } } ] }, "llm_training__agents__tools__schemas__web_search__WebSearch": { "properties": { "name": { "type": "string", "const": "web_search", "title": "Name" }, "tool_env": { "$ref": "#/components/schemas/WebSearchEnv" }, "id": { "type": "string", "title": "Id" } }, "type": "object", "required": [ "name", "tool_env" ], "title": "WebSearch" }, "llm_training__agents__tools__standalone__schemas__AgentAsTool": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "type": { "type": "string", "const": "agent_as_tool", "title": "Type", "default": "agent_as_tool" }, "config": { "$ref": "#/components/schemas/AgentAsToolConfig" } }, "type": "object", "required": [ "id", "name", "config" ], "title": "AgentAsTool" }, "llm_training__agents__tools__standalone__schemas__CreateFileSearch": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "type": { "type": "string", "const": "file_search", "title": "Type", "default": "file_search" }, "config": { "$ref": "#/components/schemas/FileSearchConfig" } }, "additionalProperties": false, "type": "object", "required": [ "name", "description", "config" ], "title": "CreateFileSearch" }, "llm_training__agents__tools__standalone__schemas__CreateRunPython": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "type": { "type": "string", "const": "run_python", "title": "Type", "default": "run_python" }, "config": { "$ref": "#/components/schemas/RunPythonConfig", "default": {} } }, "additionalProperties": false, "type": "object", "required": [ "name", "description" ], "title": "CreateRunPython" }, "llm_training__agents__tools__standalone__schemas__CreateWebSearch": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "type": { "type": "string", "const": "web_search", "title": "Type", "default": "web_search" }, "config": { "$ref": "#/components/schemas/ToolConfig", "default": {} } }, "additionalProperties": false, "type": "object", "required": [ "name", "description" ], "title": "CreateWebSearch" }, "llm_training__agents__tools__standalone__schemas__FileSearch": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "type": { "type": "string", "const": "file_search", "title": "Type", "default": "file_search" }, "config": { "$ref": "#/components/schemas/FileSearchConfig" } }, "type": "object", "required": [ "id", "name", "config" ], "title": "FileSearch", "description": "Internal schema for File Search tool." }, "llm_training__agents__tools__standalone__schemas__MCPConnectorTool": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "type": { "type": "string", "const": "mcp_connector", "title": "Type", "default": "mcp_connector" }, "config": { "$ref": "#/components/schemas/MCPConnectorToolResponseConfig" } }, "type": "object", "required": [ "id", "name", "config" ], "title": "MCPConnectorTool" }, "llm_training__agents__tools__standalone__schemas__RunPython": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "type": { "type": "string", "const": "run_python", "title": "Type", "default": "run_python" }, "config": { "$ref": "#/components/schemas/RunPythonConfig", "default": {} } }, "type": "object", "required": [ "id", "name" ], "title": "RunPython", "description": "Internal schema for Run Python tool." }, "llm_training__agents__tools__standalone__schemas__WebSearch": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "type": { "type": "string", "const": "web_search", "title": "Type", "default": "web_search" } }, "type": "object", "required": [ "id", "name" ], "title": "WebSearch", "description": "Internal schema for Web Search tool." } }, "securitySchemes": { "APIKeyHeader": { "type": "apiKey", "description": "Your Seekr API key, sent in the Authorization header with no 'Bearer' prefix.", "in": "header", "name": "Authorization" } } }, "servers": [ { "url": "https://flow.seekr.com", "description": "SeekrBuild server base URL" } ] }