Skip to content

Instantly share code, notes, and snippets.

@nicholaschiang

nicholaschiang/openapi.json

Created October 7, 2025 16:09
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save nicholaschiang/625ca4b3c95c70de70af4e9e8c97067d to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save nicholaschiang/625ca4b3c95c70de70af4e9e8c97067d to your computer and use it in GitHub Desktop.
Download ZIP
Raw
openapi.json
{
"openapi": "3.1.0",
"info": {
"title": "Alation AI API",
"description": "Alation's AI APIs",
"version": "11.1.2"
},
"paths": {
"/api/v1/admin/rekey": {
"post": {
"tags": [
"v1",
"v1.admin"
],
"summary": "Rekey",
"description": "Rekey all encrypted data in the database.",
"operationId": "rekey",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
}
}
},
"/api/v1/livez": {
"get": {
"tags": [
"v1",
"v1.status"
],
"summary": "Livez",
"description": "Return a 200 once the service is live.",
"operationId": "livez",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
}
}
},
"/api/v1/readyz": {
"get": {
"tags": [
"v1",
"v1.status"
],
"summary": "Readyz",
"description": "Return a 200 once the service is ready.",
"operationId": "readyz",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
}
}
},
"/api/v1/chats": {
"post": {
"tags": [
"v1",
"v1.chats"
],
"summary": "Create Chat",
"description": "Create a chat.",
"operationId": "create_chat",
"parameters": [
{
"name": "name",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Chat"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"get": {
"tags": [
"v1",
"v1.chats"
],
"summary": "Get Chats",
"description": "Get chats ordered by when they were last updated descending.\n\nThis includes when messages were added to the chat.",
"operationId": "get_chats",
"parameters": [
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "The maximum number of chats to include in the response.",
"default": 100,
"title": "Limit"
},
"description": "The maximum number of chats to include in the response."
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The start index of the chats to include in the response.",
"default": 0,
"title": "Offset"
},
"description": "The start index of the chats to include in the response."
},
{
"name": "created_by",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/CreatedByFilterOption",
"description": "Filter chats by who created them.",
"default": "user"
},
"description": "Filter chats by who created them."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataPage_Chat_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/chats/{chat_id}/messages": {
"get": {
"tags": [
"v1",
"v1.chats"
],
"summary": "Get Chat Messages",
"description": "Get messages for a chat.",
"operationId": "get_chat_messages",
"parameters": [
{
"name": "chat_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Chat Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "The maximum number of messages to include in the response.",
"default": 100,
"title": "Limit"
},
"description": "The maximum number of messages to include in the response."
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The start index of the messages to include in the response.",
"default": 0,
"title": "Offset"
},
"description": "The start index of the messages to include in the response."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataPage_Message_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/chats/default/bi_report_agent/stream": {
"post": {
"tags": [
"v1",
"v1.chats"
],
"summary": "Post Bi Report Agent Message Deprecated",
"description": "This endpoint is deprecated. Use chats/agent/default/bi_report_agent/stream instead.",
"operationId": "post_bi_report_agent_message_deprecated",
"deprecated": true,
"parameters": [
{
"name": "chat_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"description": "The ID of the Chat to use. If not provided, a new Chat will be created.",
"title": "Chat Id"
},
"description": "The ID of the Chat to use. If not provided, a new Chat will be created."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DefaultCatalogSearchAgentPayload",
"description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent."
}
}
}
},
"responses": {
"201": {
"description": "Message sent successfully. Returns an event stream of `Message` objects.",
"content": {
"application/json": {
"schema": {}
},
"text/event-stream": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"204": {
"description": "The message is empty and was ignored."
},
"409": {
"description": "Chat is busy. Returns an event stream of the running chat.",
"content": {
"text/event-stream": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"404": {
"description": "The chat could not be found."
},
"422": {
"description": "The payload is not valid according to the input JSON schema of the agent."
}
}
}
},
"/api/v1/chats/agent/default/bi_report_agent/stream": {
"post": {
"tags": [
"v1",
"v1.chats"
],
"summary": "Post Bi Report Agent Message",
"description": "Post a new message to the chat using the bi_report_agent agent.",
"operationId": "post_bi_report_agent_message",
"parameters": [
{
"name": "chat_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"description": "The ID of the Chat to use. If not provided, a new Chat will be created.",
"title": "Chat Id"
},
"description": "The ID of the Chat to use. If not provided, a new Chat will be created."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DefaultCatalogSearchAgentPayload",
"description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent."
}
}
}
},
"responses": {
"201": {
"description": "Message sent successfully. Returns an event stream of `Message` objects.",
"content": {
"application/json": {
"schema": {}
},
"text/event-stream": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"204": {
"description": "The message is empty and was ignored."
},
"409": {
"description": "Chat is busy. Returns an event stream of the running chat.",
"content": {
"text/event-stream": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"404": {
"description": "The chat could not be found."
},
"422": {
"description": "The payload is not valid according to the input JSON schema of the agent."
}
}
}
},
"/api/v1/chats/default/catalog_search_agent/stream": {
"post": {
"tags": [
"v1",
"v1.chats"
],
"summary": "Post Catalog Search Agent Message Deprecated",
"description": "This endpoint is deprecated. Use chats/agent/default/catalog_search_agent/stream instead.",
"operationId": "post_catalog_search_agent_message_deprecated",
"deprecated": true,
"parameters": [
{
"name": "chat_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"description": "The ID of the Chat to use. If not provided, a new Chat will be created.",
"title": "Chat Id"
},
"description": "The ID of the Chat to use. If not provided, a new Chat will be created."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DefaultCatalogSearchAgentPayload",
"description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent."
}
}
}
},
"responses": {
"201": {
"description": "Message sent successfully. Returns an event stream of `Message` objects.",
"content": {
"application/json": {
"schema": {}
},
"text/event-stream": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"204": {
"description": "The message is empty and was ignored."
},
"409": {
"description": "Chat is busy. Returns an event stream of the running chat.",
"content": {
"text/event-stream": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"404": {
"description": "The chat could not be found."
},
"422": {
"description": "The payload is not valid according to the input JSON schema of the agent."
}
}
}
},
"/api/v1/chats/agent/default/catalog_search_agent/stream": {
"post": {
"tags": [
"v1",
"v1.chats"
],
"summary": "Post Catalog Search Agent Message",
"description": "Post a new message to the chat using the catalog_search_agent agent.",
"operationId": "post_catalog_search_agent_message",
"parameters": [
{
"name": "chat_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"description": "The ID of the Chat to use. If not provided, a new Chat will be created.",
"title": "Chat Id"
},
"description": "The ID of the Chat to use. If not provided, a new Chat will be created."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DefaultCatalogSearchAgentPayload",
"description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent."
}
}
}
},
"responses": {
"201": {
"description": "Message sent successfully. Returns an event stream of `Message` objects.",
"content": {
"application/json": {
"schema": {}
},
"text/event-stream": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"204": {
"description": "The message is empty and was ignored."
},
"409": {
"description": "Chat is busy. Returns an event stream of the running chat.",
"content": {
"text/event-stream": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"404": {
"description": "The chat could not be found."
},
"422": {
"description": "The payload is not valid according to the input JSON schema of the agent."
}
}
}
},
"/api/v1/chats/default/chart_create_agent/stream": {
"post": {
"tags": [
"v1",
"v1.chats"
],
"summary": "Post Chart Create Agent Message Deprecated",
"description": "This endpoint is deprecated. Use chats/agent/default/chart_create_agent/stream instead.",
"operationId": "post_chart_create_agent_message_deprecated",
"deprecated": true,
"parameters": [
{
"name": "chat_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"description": "The ID of the Chat to use. If not provided, a new Chat will be created.",
"title": "Chat Id"
},
"description": "The ID of the Chat to use. If not provided, a new Chat will be created."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DefaultSQLQueryAgentPayload",
"description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent."
}
}
}
},
"responses": {
"201": {
"description": "Message sent successfully. Returns an event stream of `Message` objects.",
"content": {
"application/json": {
"schema": {}
},
"text/event-stream": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"204": {
"description": "The message is empty and was ignored."
},
"409": {
"description": "Chat is busy. Returns an event stream of the running chat.",
"content": {
"text/event-stream": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"404": {
"description": "The chat could not be found."
},
"422": {
"description": "The payload is not valid according to the input JSON schema of the agent."
}
}
}
},
"/api/v1/chats/agent/default/chart_create_agent/stream": {
"post": {
"tags": [
"v1",
"v1.chats"
],
"summary": "Post Chart Create Agent Message",
"description": "Post a new message to the chat using the chart_create_agent agent.",
"operationId": "post_chart_create_agent_message",
"parameters": [
{
"name": "chat_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"description": "The ID of the Chat to use. If not provided, a new Chat will be created.",
"title": "Chat Id"
},
"description": "The ID of the Chat to use. If not provided, a new Chat will be created."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DefaultSQLQueryAgentPayload",
"description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent."
}
}
}
},
"responses": {
"201": {
"description": "Message sent successfully. Returns an event stream of `Message` objects.",
"content": {
"application/json": {
"schema": {}
},
"text/event-stream": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"204": {
"description": "The message is empty and was ignored."
},
"409": {
"description": "Chat is busy. Returns an event stream of the running chat.",
"content": {
"text/event-stream": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"404": {
"description": "The chat could not be found."
},
"422": {
"description": "The payload is not valid according to the input JSON schema of the agent."
}
}
}
},
"/api/v1/chats/default/data_product_query_agent/stream": {
"post": {
"tags": [
"v1",
"v1.chats"
],
"summary": "Post Data Product Query Agent Message Deprecated",
"description": "This endpoint is deprecated. Use chats/agent/default/data_product_query_agent/stream instead.",
"operationId": "post_data_product_query_agent_message_deprecated",
"deprecated": true,
"parameters": [
{
"name": "chat_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"description": "The ID of the Chat to use. If not provided, a new Chat will be created.",
"title": "Chat Id"
},
"description": "The ID of the Chat to use. If not provided, a new Chat will be created."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DefaultDataProductQueryAgentPayload",
"description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent."
}
}
}
},
"responses": {
"201": {
"description": "Message sent successfully. Returns an event stream of `Message` objects.",
"content": {
"application/json": {
"schema": {}
},
"text/event-stream": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"204": {
"description": "The message is empty and was ignored."
},
"409": {
"description": "Chat is busy. Returns an event stream of the running chat.",
"content": {
"text/event-stream": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"404": {
"description": "The chat could not be found."
},
"422": {
"description": "The payload is not valid according to the input JSON schema of the agent."
}
}
}
},
"/api/v1/chats/agent/default/data_product_query_agent/stream": {
"post": {
"tags": [
"v1",
"v1.chats"
],
"summary": "Post Data Product Query Agent Message",
"description": "Post a new message to the chat using the data_product_query_agent agent.",
"operationId": "post_data_product_query_agent_message",
"parameters": [
{
"name": "chat_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"description": "The ID of the Chat to use. If not provided, a new Chat will be created.",
"title": "Chat Id"
},
"description": "The ID of the Chat to use. If not provided, a new Chat will be created."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DefaultDataProductQueryAgentPayload",
"description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent."
}
}
}
},
"responses": {
"201": {
"description": "Message sent successfully. Returns an event stream of `Message` objects.",
"content": {
"application/json": {
"schema": {}
},
"text/event-stream": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"204": {
"description": "The message is empty and was ignored."
},
"409": {
"description": "Chat is busy. Returns an event stream of the running chat.",
"content": {
"text/event-stream": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"404": {
"description": "The chat could not be found."
},
"422": {
"description": "The payload is not valid according to the input JSON schema of the agent."
}
}
}
},
"/api/v1/chats/default/deep_research_agent/stream": {
"post": {
"tags": [
"v1",
"v1.chats"
],
"summary": "Post Deep Research Agent Message Deprecated",
"description": "This endpoint is deprecated. Use chats/agent/default/deep_research_agent/stream instead.",
"operationId": "post_deep_research_agent_message_deprecated",
"deprecated": true,
"parameters": [
{
"name": "chat_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"description": "The ID of the Chat to use. If not provided, a new Chat will be created.",
"title": "Chat Id"
},
"description": "The ID of the Chat to use. If not provided, a new Chat will be created."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DefaultDeepResearchAgentPayload",
"description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent."
}
}
}
},
"responses": {
"201": {
"description": "Message sent successfully. Returns an event stream of `Message` objects.",
"content": {
"application/json": {
"schema": {}
},
"text/event-stream": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"204": {
"description": "The message is empty and was ignored."
},
"409": {
"description": "Chat is busy. Returns an event stream of the running chat.",
"content": {
"text/event-stream": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"404": {
"description": "The chat could not be found."
},
"422": {
"description": "The payload is not valid according to the input JSON schema of the agent."
}
}
}
},
"/api/v1/chats/agent/default/deep_research_agent/stream": {
"post": {
"tags": [
"v1",
"v1.chats"
],
"summary": "Post Deep Research Agent Message",
"description": "Post a new message to the chat using the deep_research_agent agent.",
"operationId": "post_deep_research_agent_message",
"parameters": [
{
"name": "chat_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"description": "The ID of the Chat to use. If not provided, a new Chat will be created.",
"title": "Chat Id"
},
"description": "The ID of the Chat to use. If not provided, a new Chat will be created."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DefaultDeepResearchAgentPayload",
"description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent."
}
}
}
},
"responses": {
"201": {
"description": "Message sent successfully. Returns an event stream of `Message` objects.",
"content": {
"application/json": {
"schema": {}
},
"text/event-stream": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"204": {
"description": "The message is empty and was ignored."
},
"409": {
"description": "Chat is busy. Returns an event stream of the running chat.",
"content": {
"text/event-stream": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"404": {
"description": "The chat could not be found."
},
"422": {
"description": "The payload is not valid according to the input JSON schema of the agent."
}
}
}
},
"/api/v1/chats/default/sql_query_agent/stream": {
"post": {
"tags": [
"v1",
"v1.chats"
],
"summary": "Post Sql Query Agent Message Deprecated",
"description": "This endpoint is deprecated. Use chats/agent/default/sql_query_agent/stream instead.",
"operationId": "post_sql_query_agent_message_deprecated",
"deprecated": true,
"parameters": [
{
"name": "chat_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"description": "The ID of the Chat to use. If not provided, a new Chat will be created.",
"title": "Chat Id"
},
"description": "The ID of the Chat to use. If not provided, a new Chat will be created."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DefaultSQLQueryAgentPayload",
"description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent."
}
}
}
},
"responses": {
"201": {
"description": "Message sent successfully. Returns an event stream of `Message` objects.",
"content": {
"application/json": {
"schema": {}
},
"text/event-stream": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"204": {
"description": "The message is empty and was ignored."
},
"409": {
"description": "Chat is busy. Returns an event stream of the running chat.",
"content": {
"text/event-stream": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"404": {
"description": "The chat could not be found."
},
"422": {
"description": "The payload is not valid according to the input JSON schema of the agent."
}
}
}
},
"/api/v1/chats/agent/default/sql_query_agent/stream": {
"post": {
"tags": [
"v1",
"v1.chats"
],
"summary": "Post Sql Query Agent Message",
"description": "Post a new message to the chat using the sql_query_agent agent.",
"operationId": "post_sql_query_agent_message",
"parameters": [
{
"name": "chat_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"description": "The ID of the Chat to use. If not provided, a new Chat will be created.",
"title": "Chat Id"
},
"description": "The ID of the Chat to use. If not provided, a new Chat will be created."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DefaultSQLQueryAgentPayload",
"description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent."
}
}
}
},
"responses": {
"201": {
"description": "Message sent successfully. Returns an event stream of `Message` objects.",
"content": {
"application/json": {
"schema": {}
},
"text/event-stream": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"204": {
"description": "The message is empty and was ignored."
},
"409": {
"description": "Chat is busy. Returns an event stream of the running chat.",
"content": {
"text/event-stream": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"404": {
"description": "The chat could not be found."
},
"422": {
"description": "The payload is not valid according to the input JSON schema of the agent."
}
}
}
},
"/api/v1/chats/agent/{agent_config_id}/stream": {
"post": {
"tags": [
"v1",
"v1.chats"
],
"summary": "Post Agent Message",
"description": "Send messages to an agent.",
"operationId": "post_agent_message",
"parameters": [
{
"name": "agent_config_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Agent Config Id"
}
},
{
"name": "chat_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"description": "The ID of the Chat to use. If not provided, a new Chat will be created.",
"title": "Chat Id"
},
"description": "The ID of the Chat to use. If not provided, a new Chat will be created."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true,
"description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent.",
"title": "Payload"
}
}
}
},
"responses": {
"201": {
"description": "Message sent successfully. Returns an event stream of `Message` objects.",
"content": {
"application/json": {
"schema": {}
},
"text/event-stream": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"204": {
"description": "The message is empty and was ignored."
},
"409": {
"description": "Chat is busy. Returns an event stream of the running chat.",
"content": {
"text/event-stream": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"404": {
"description": "The chat could not be found."
},
"422": {
"description": "The payload is not valid according to the input JSON schema of the agent."
}
}
}
},
"/api/v1/chats/message": {
"post": {
"tags": [
"v1",
"v1.chats"
],
"summary": "Post Message",
"description": "Post a new message to the chat.",
"operationId": "post_message",
"deprecated": true,
"parameters": [
{
"name": "message",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The message content to be sent to the agent and stored in the chat history.",
"title": "Message"
},
"description": "The message content to be sent to the agent and stored in the chat history."
},
{
"name": "data_product_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"description": "The ID of the data product to use.",
"title": "Data Product Id"
},
"description": "The ID of the data product to use."
},
{
"name": "agent_config_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"description": "The ID of the Agent Config to use.",
"title": "Agent Config Id"
},
"description": "The ID of the Agent Config to use."
},
{
"name": "default_agent_ref",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/DefaultAgentRef"
},
{
"type": "null"
}
],
"description": "Reference string of the default agent to use. Only used if no agent_config_id is provided.",
"title": "Default Agent Ref"
},
"description": "Reference string of the default agent to use. Only used if no agent_config_id is provided."
},
{
"name": "chat_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"description": "The ID of the Chat to use. If not provided, a new Chat will be created.",
"title": "Chat Id"
},
"description": "The ID of the Chat to use. If not provided, a new Chat will be created."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/chats/tool/default/alation_context_tool/stream": {
"post": {
"tags": [
"v1",
"v1.chats"
],
"summary": "Invoke Alation Context Tool",
"description": "Invoke the alation_context_tool directly.",
"operationId": "invoke_alation_context_tool",
"parameters": [
{
"name": "chat_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"description": "The ID of the Chat to use. If not provided, a new Chat will be created.",
"title": "Chat Id"
},
"description": "The ID of the Chat to use. If not provided, a new Chat will be created."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/alation_context_tool_parameters"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/chats/tool/default/bi_report_search_tool/stream": {
"post": {
"tags": [
"v1",
"v1.chats"
],
"summary": "Invoke Bi Report Search Tool",
"description": "Invoke the bi_report_search_tool directly.",
"operationId": "invoke_bi_report_search_tool",
"parameters": [
{
"name": "chat_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"description": "The ID of the Chat to use. If not provided, a new Chat will be created.",
"title": "Chat Id"
},
"description": "The ID of the Chat to use. If not provided, a new Chat will be created."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/bi_report_search_tool_parameters"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/chats/tool/default/bulk_retrieval_tool/stream": {
"post": {
"tags": [
"v1",
"v1.chats"
],
"summary": "Invoke Bulk Retrieval Tool",
"description": "Invoke the bulk_retrieval_tool directly.",
"operationId": "invoke_bulk_retrieval_tool",
"parameters": [
{
"name": "chat_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"description": "The ID of the Chat to use. If not provided, a new Chat will be created.",
"title": "Chat Id"
},
"description": "The ID of the Chat to use. If not provided, a new Chat will be created."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/bulk_retrieval_tool_parameters"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/chats/tool/default/sql_execution_tool/stream": {
"post": {
"tags": [
"v1",
"v1.chats"
],
"summary": "Invoke Sql Execution Tool",
"description": "Invoke the sql_execution_tool directly.",
"operationId": "invoke_sql_execution_tool",
"parameters": [
{
"name": "chat_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"description": "The ID of the Chat to use. If not provided, a new Chat will be created.",
"title": "Chat Id"
},
"description": "The ID of the Chat to use. If not provided, a new Chat will be created."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/sql_execution_tool_parameters"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/chats/tool/default/generate_chart_from_sql_and_code_tool/stream": {
"post": {
"tags": [
"v1",
"v1.chats"
],
"summary": "Invoke Generate Chart From Sql And Code Tool",
"description": "Invoke the generate_chart_from_sql_and_code_tool directly.",
"operationId": "invoke_generate_chart_from_sql_and_code_tool",
"parameters": [
{
"name": "chat_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"description": "The ID of the Chat to use. If not provided, a new Chat will be created.",
"title": "Chat Id"
},
"description": "The ID of the Chat to use. If not provided, a new Chat will be created."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/generate_chart_from_sql_and_code_tool_parameters"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/chats/tool/default/get_data_schema_tool/stream": {
"post": {
"tags": [
"v1",
"v1.chats"
],
"summary": "Invoke Get Data Schema Tool",
"description": "Invoke the get_data_schema_tool directly.",
"operationId": "invoke_get_data_schema_tool",
"parameters": [
{
"name": "chat_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"description": "The ID of the Chat to use. If not provided, a new Chat will be created.",
"title": "Chat Id"
},
"description": "The ID of the Chat to use. If not provided, a new Chat will be created."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/get_data_schema_tool_parameters"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/chats/tool/default/list_data_products_tool/stream": {
"post": {
"tags": [
"v1",
"v1.chats"
],
"summary": "Invoke List Data Products Tool",
"description": "Invoke the list_data_products_tool directly.",
"operationId": "invoke_list_data_products_tool",
"parameters": [
{
"name": "chat_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"description": "The ID of the Chat to use. If not provided, a new Chat will be created.",
"title": "Chat Id"
},
"description": "The ID of the Chat to use. If not provided, a new Chat will be created."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/list_data_products_tool_parameters"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/chats/tool/default/search_catalog_tool/stream": {
"post": {
"tags": [
"v1",
"v1.chats"
],
"summary": "Invoke Search Catalog Tool",
"description": "Invoke the search_catalog_tool directly.",
"operationId": "invoke_search_catalog_tool",
"parameters": [
{
"name": "chat_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"description": "The ID of the Chat to use. If not provided, a new Chat will be created.",
"title": "Chat Id"
},
"description": "The ID of the Chat to use. If not provided, a new Chat will be created."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/search_catalog_tool_parameters"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/chats/tool/default/get_search_filter_fields_tool/stream": {
"post": {
"tags": [
"v1",
"v1.chats"
],
"summary": "Invoke Get Search Filter Fields Tool",
"description": "Invoke the get_search_filter_fields_tool directly.",
"operationId": "invoke_get_search_filter_fields_tool",
"parameters": [
{
"name": "chat_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"description": "The ID of the Chat to use. If not provided, a new Chat will be created.",
"title": "Chat Id"
},
"description": "The ID of the Chat to use. If not provided, a new Chat will be created."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/get_search_filter_fields_tool_parameters"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/chats/tool/default/get_search_filter_values_tool/stream": {
"post": {
"tags": [
"v1",
"v1.chats"
],
"summary": "Invoke Get Search Filter Values Tool",
"description": "Invoke the get_search_filter_values_tool directly.",
"operationId": "invoke_get_search_filter_values_tool",
"parameters": [
{
"name": "chat_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"description": "The ID of the Chat to use. If not provided, a new Chat will be created.",
"title": "Chat Id"
},
"description": "The ID of the Chat to use. If not provided, a new Chat will be created."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/get_search_filter_values_tool_parameters"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/sql_evaluation_set/{data_product_id}": {
"get": {
"tags": [
"v1",
"v1.sql_evaluation"
],
"summary": "Get Sql Evaluation Set",
"description": "Get eval set for a data product.",
"operationId": "get_sql_evaluation_set",
"parameters": [
{
"name": "data_product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Data Product Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SQLEvaluationSet"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"v1",
"v1.sql_evaluation"
],
"summary": "Create Sql Evaluation Cases",
"description": "Create SQL Evaluation Cases.",
"operationId": "create_sql_evaluation_cases",
"parameters": [
{
"name": "data_product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Data Product Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SQLEvaluationCaseCreate"
},
"title": "Eval Case Creates"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SQLEvaluationCase"
},
"title": "Response Create Sql Evaluation Cases Api V1 Sql Evaluation Set Data Product Id Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/sql_evaluation_set/{data_product_id}/csv": {
"post": {
"tags": [
"v1",
"v1.sql_evaluation"
],
"summary": "Create Sql Eval Cases From Csv",
"description": "Create SQL Evaluation Cases from a CSV.\n\nThe CSV requires columns titled \"question\" and \"sql\".",
"operationId": "create_sql_eval_cases_from_csv",
"parameters": [
{
"name": "data_product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Data Product Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_create_sql_eval_cases_from_csv_api_v1_sql_evaluation_set__data_product_id__csv_post"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SQLEvaluationCase"
},
"title": "Response Create Sql Eval Cases From Csv Api V1 Sql Evaluation Set Data Product Id Csv Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/sql_evaluation_set/{data_product_id}/{eval_case_id}": {
"patch": {
"tags": [
"v1",
"v1.sql_evaluation"
],
"summary": "Update Sql Evaluation Case",
"description": "Update SQL Evaluation Case.",
"operationId": "update_sql_evaluation_case",
"parameters": [
{
"name": "data_product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Data Product Id"
}
},
{
"name": "eval_case_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Eval Case Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SQLEvaluationCaseUpdate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SQLEvaluationCase"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"v1",
"v1.sql_evaluation"
],
"summary": "Delete Eval Case",
"description": "Delete a SQL EvaluationCase.",
"operationId": "delete_eval_case",
"parameters": [
{
"name": "data_product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Data Product Id"
}
},
{
"name": "eval_case_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Eval Case Id"
}
}
],
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/run_sql_evaluation/{data_product_id}": {
"post": {
"tags": [
"v1",
"v1.sql_evaluation"
],
"summary": "Run Sql Evaluation",
"description": "Run SQL Evaluation on a Data Product's Eval Set.\n\nOnly a single evaluation run can occur at a time per data product.\nThe agent_config is provided via dependency injection.",
"operationId": "run_sql_evaluation",
"parameters": [
{
"name": "data_product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Data Product Id"
}
},
{
"name": "agent_config_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"description": "The ID of the Agent Config to use.",
"title": "Agent Config Id"
},
"description": "The ID of the Agent Config to use."
},
{
"name": "default_agent_ref",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/DefaultAgentRef"
},
{
"type": "null"
}
],
"description": "Reference string of the default agent to use. Only used if no agent_config_id is provided.",
"title": "Default Agent Ref"
},
"description": "Reference string of the default agent to use. Only used if no agent_config_id is provided."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string",
"title": "Response Run Sql Evaluation Api V1 Run Sql Evaluation Data Product Id Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/sql_evaluation_results/{data_product_id}": {
"get": {
"tags": [
"v1",
"v1.sql_evaluation"
],
"summary": "Get Sql Evaluation Results",
"description": "Get saved results for completed SQL evaluation runs.\n\nResults are sorted by creation time, descending.\nResults include only metadata from the selected evaluation runs.",
"operationId": "get_sql_evaluation_results",
"parameters": [
{
"name": "data_product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Data Product Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": 10,
"title": "Limit"
}
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Offset"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataPage_SQLEvaluationResultMetadata_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/sql_evaluation_results/{data_product_id}/{eval_result_id}": {
"get": {
"tags": [
"v1",
"v1.sql_evaluation"
],
"summary": "Get Sql Evaluation Result",
"description": "Get a detailed report for a SQL Evaluation run.",
"operationId": "get_sql_evaluation_result",
"parameters": [
{
"name": "data_product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Data Product Id"
}
},
{
"name": "eval_result_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Eval Result Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SQLEvaluationResult"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"v1",
"v1.sql_evaluation"
],
"summary": "Delete Sql Evaluation Result",
"description": "Delete a SQL Evaluation Result.",
"operationId": "delete_sql_evaluation_result",
"parameters": [
{
"name": "data_product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Data Product Id"
}
},
{
"name": "eval_result_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Eval Result Id"
}
}
],
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/sql_evaluation_results/{data_product_id}/{eval_result_id}/csv": {
"get": {
"tags": [
"v1",
"v1.sql_evaluation"
],
"summary": "Get Sql Evaluation Result As Csv",
"description": "Download a CSV of the SQL Evaluation run.",
"operationId": "get_sql_evaluation_result_as_csv",
"parameters": [
{
"name": "data_product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Data Product Id"
}
},
{
"name": "eval_result_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Eval Result Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/evaluation_sets/": {
"get": {
"tags": [
"v1",
"v1.evaluation"
],
"summary": "Get Evaluation Sets",
"description": "Get all generic evaluation sets.",
"operationId": "get_evaluation_sets",
"parameters": [
{
"name": "agent_config_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Agent Config Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": 10,
"title": "Limit"
}
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Offset"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataPage_GenericEvaluationSet_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/evaluation_sets/{eval_set_id}": {
"get": {
"tags": [
"v1",
"v1.evaluation"
],
"summary": "Get Evaluation Set",
"description": "Get a generic evaluation set by ID.",
"operationId": "get_evaluation_set",
"parameters": [
{
"name": "eval_set_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Eval Set Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GenericEvaluationSet"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"patch": {
"tags": [
"v1",
"v1.evaluation"
],
"summary": "Update Evaluation Set",
"description": "Update a generic evaluation set.",
"operationId": "update_evaluation_set",
"parameters": [
{
"name": "eval_set_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Eval Set Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GenericEvaluationSetUpdate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GenericEvaluationSet"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"v1",
"v1.evaluation"
],
"summary": "Delete Evaluation Set",
"description": "Delete a generic evaluation set.",
"operationId": "delete_evaluation_set",
"parameters": [
{
"name": "eval_set_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Eval Set Id"
}
}
],
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/evaluation_sets": {
"post": {
"tags": [
"v1",
"v1.evaluation"
],
"summary": "Create Evaluation Set",
"description": "Create a new generic evaluation set.",
"operationId": "create_evaluation_set",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GenericEvaluationSetCreate"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GenericEvaluationSet"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/evaluation_sets/{eval_set_id}/cases": {
"post": {
"tags": [
"v1",
"v1.evaluation"
],
"summary": "Create Evaluation Cases",
"description": "Create generic evaluation cases.",
"operationId": "create_evaluation_cases",
"parameters": [
{
"name": "eval_set_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Eval Set Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GenericEvaluationCaseCreate"
},
"title": "Eval Case Creates"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GenericEvaluationCase"
},
"title": "Response Create Evaluation Cases Api V1 Evaluation Sets Eval Set Id Cases Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/evaluation_sets/{eval_set_id}/cases/json": {
"post": {
"tags": [
"v1",
"v1.evaluation"
],
"summary": "Create Eval Cases From Json",
"description": "Create Evaluation Cases from a JSON file.\n\nThe file should be a list of cases, with keys: \"inputs\" and \"expected_output\".",
"operationId": "create_eval_cases_from_json",
"parameters": [
{
"name": "eval_set_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Eval Set Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_create_eval_cases_from_json_api_v1_evaluation_sets__eval_set_id__cases_json_post"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GenericEvaluationCase"
},
"title": "Response Create Eval Cases From Json Api V1 Evaluation Sets Eval Set Id Cases Json Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/evaluation_cases/{eval_case_id}": {
"patch": {
"tags": [
"v1",
"v1.evaluation"
],
"summary": "Update Evaluation Case",
"description": "Update a generic evaluation case.",
"operationId": "update_evaluation_case",
"parameters": [
{
"name": "eval_case_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Eval Case Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GenericEvaluationCaseUpdate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GenericEvaluationCase"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"v1",
"v1.evaluation"
],
"summary": "Delete Evaluation Case",
"description": "Delete a generic evaluation case.",
"operationId": "delete_evaluation_case",
"parameters": [
{
"name": "eval_case_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Eval Case Id"
}
}
],
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/evaluation_sets/{eval_set_id}/run": {
"post": {
"tags": [
"v1",
"v1.evaluation"
],
"summary": "Run Evaluation",
"description": "Run Generic Evaluation on an Evaluation Set.\n\nOnly a single evaluation run can occur at a time per evaluation set.\nThe agent_config is provided via dependency injection.\n\nArgs:\n db: The database session.\n services: ServiceCollection containing all required services.\n agent_config: AgentConfig to use for the evaluation.\n eval_set: The evaluation set to run.\n background_tasks: FastAPI background tasks to run the evaluation.\n rubric: The evaluation rubric for LLM-as-judge scoring.",
"operationId": "run_evaluation",
"parameters": [
{
"name": "eval_set_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Eval Set Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string",
"title": "Response Run Evaluation Api V1 Evaluation Sets Eval Set Id Run Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/evaluation_sets/{eval_set_id}/results": {
"get": {
"tags": [
"v1",
"v1.evaluation"
],
"summary": "Get Evaluation Results",
"description": "Get saved results for completed generic evaluation runs.\n\nResults are sorted by creation time, descending.\nResults include only metadata from the selected evaluation runs.",
"operationId": "get_evaluation_results",
"parameters": [
{
"name": "eval_set_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Eval Set Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": 10,
"title": "Limit"
}
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Offset"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataPage_GenericEvaluationResultMetadata_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/evaluation_results/{eval_result_id}": {
"get": {
"tags": [
"v1",
"v1.evaluation"
],
"summary": "Get Evaluation Result",
"description": "Get a detailed report for a Generic Evaluation run.",
"operationId": "get_evaluation_result",
"parameters": [
{
"name": "eval_result_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Eval Result Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GenericEvaluationResult"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"v1",
"v1.evaluation"
],
"summary": "Delete Evaluation Result",
"description": "Delete a Generic Evaluation Result.",
"operationId": "delete_evaluation_result",
"parameters": [
{
"name": "eval_result_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Eval Result Id"
}
}
],
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/evaluation_results/{eval_result_id}/csv": {
"get": {
"tags": [
"v1",
"v1.evaluation"
],
"summary": "Get Evaluation Result As Csv",
"description": "Download a CSV of the Generic Evaluation run.",
"operationId": "get_evaluation_result_as_csv",
"parameters": [
{
"name": "eval_result_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Eval Result Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/config/agent": {
"get": {
"tags": [
"v1",
"v1.config"
],
"summary": "Get Agent Configs",
"description": "Get agent configs.",
"operationId": "get_agent_configs",
"parameters": [
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "The maximum number of agent configs to include in the response.",
"default": 100,
"title": "Limit"
},
"description": "The maximum number of agent configs to include in the response."
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The start index of the agent configs to include in the response.",
"default": 0,
"title": "Offset"
},
"description": "The start index of the agent configs to include in the response."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataPage_AgentConfig_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"v1",
"v1.config"
],
"summary": "Create Agent Config",
"description": "Create an agent config.",
"operationId": "create_agent_config",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentConfigCreate"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentConfig"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/config/agent/{agent_config_id}": {
"get": {
"tags": [
"v1",
"v1.config"
],
"summary": "Get Agent Config",
"description": "Get an agent config.",
"operationId": "get_agent_config",
"parameters": [
{
"name": "agent_config_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Agent Config Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentConfig"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"patch": {
"tags": [
"v1",
"v1.config"
],
"summary": "Update Agent Config",
"description": "Update an agent config.",
"operationId": "update_agent_config",
"parameters": [
{
"name": "agent_config_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Agent Config Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentConfigUpdate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentConfig"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"v1",
"v1.config"
],
"summary": "Delete Agent Config",
"description": "Delete an agent config.",
"operationId": "delete_agent_config",
"parameters": [
{
"name": "agent_config_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Agent Config Id"
}
}
],
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/config/agent/default/{default_agent_ref}": {
"get": {
"tags": [
"v1",
"v1.config"
],
"summary": "Get Default Agent Config",
"description": "Get a default agent config.",
"operationId": "get_default_agent_config",
"parameters": [
{
"name": "default_agent_ref",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/DefaultAgentRef",
"description": "The default agent ref."
},
"description": "The default agent ref."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentConfig"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/config/agent/{agent_config_id}/publish_as_tool": {
"post": {
"tags": [
"v1",
"v1.config"
],
"summary": "Publish Agent As Tool",
"description": "Publish an agent as a tool.",
"operationId": "publish_agent_as_tool",
"parameters": [
{
"name": "agent_config_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Agent Config Id"
}
}
],
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ToolConfig"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/config/agent/{agent_config_id}/clone": {
"post": {
"tags": [
"v1",
"v1.config"
],
"summary": "Clone Agent Config",
"description": "Clone an agent config.",
"operationId": "clone_agent_config",
"parameters": [
{
"name": "agent_config_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Agent Config Id"
}
}
],
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentConfig"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/config/agent/{agent_config_id}/clone_deep_research": {
"post": {
"tags": [
"v1",
"v1.config"
],
"summary": "Clone Deep Research Agent Config",
"description": "Clone a deep research agent config.",
"operationId": "clone_deep_research_agent_config",
"parameters": [
{
"name": "agent_config_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Agent Config Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeepResearchPlanSchema"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentConfig"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/config/tool": {
"get": {
"tags": [
"v1",
"v1.config"
],
"summary": "Get Tool Configs",
"description": "Get tool configs.",
"operationId": "get_tool_configs",
"parameters": [
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "The maximum number of tool configs to include in the response.",
"default": 100,
"title": "Limit"
},
"description": "The maximum number of tool configs to include in the response."
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The start index of the tool configs to include in the response.",
"default": 0,
"title": "Offset"
},
"description": "The start index of the tool configs to include in the response."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataPage_ToolConfig_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/config/tool/{tool_config_id}": {
"get": {
"tags": [
"v1",
"v1.config"
],
"summary": "Get Tool Config",
"description": "Get a tool config.",
"operationId": "get_tool_config",
"parameters": [
{
"name": "tool_config_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Tool Config Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ToolConfig"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/v1/config/llm": {
"get": {
"tags": [
"v1",
"v1.config"
],
"summary": "Get Llm Configs",
"description": "Get LLM configs.",
"operationId": "get_llm_configs",
"parameters": [
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "The maximum number of LLM configs to include in the response.",
"default": 100,
"title": "Limit"
},
"description": "The maximum number of LLM configs to include in the response."
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The start index of the LLM configs to include in the response.",
"default": 0,
"title": "Offset"
},
"description": "The start index of the LLM configs to include in the response."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataPage_LLMConfig_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AgentConfig": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "The ID of the agent config."
},
"name": {
"type": "string",
"title": "Name",
"description": "Display name of the agent (e.g., \"SQL Query Agent\")."
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "Optional description of the agent's purpose and capabilities."
},
"prompt": {
"type": "string",
"title": "Prompt",
"description": "System prompt that defines the agent's behavior and instructions.\n\nThis prompt establishes the agent's role, capabilities, and response format.\nCombined with tool descriptions to form the complete context sent to the LLM."
},
"llm_config": {
"$ref": "#/components/schemas/LLMConfig",
"description": "The LLM configuration this agent uses for generating responses."
},
"tool_configs": {
"items": {
"$ref": "#/components/schemas/ToolConfig"
},
"type": "array",
"title": "Tool Configs",
"description": "List of tools available to this agent during conversations.\n\nTools provide the agent with capabilities like SQL execution, schema lookup,\nand catalog search."
},
"bound_tool_args": {
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array",
"title": "Bound Tool Args",
"description": "List of arguments to tools that have been hardcoded.\n\nThe order and length of this list is the same as that of tool_configs. The\ndictionaries in this list contain key-value pairs, where the key is the name\nof a tool argument and the value is what should be hardcoded for that tool.\nIf the dict is empty, then there are no hardcoded values for the tool."
},
"is_default": {
"type": "boolean",
"title": "Is Default",
"description": "Whether this is a system default configuration.\n\nDefault configs are read-only. Users can clone them to create custom configurations."
},
"tool_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Tool Id",
"description": "The ID of the tool that the agent is published as."
},
"user_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "User Id",
"description": "ID of the user who created this configuration (null for system defaults)."
},
"published_status": {
"$ref": "#/components/schemas/PublishedStatus",
"description": "Whether the agent is published (PUBLISHED) or still in draft mode (DRAFT)."
},
"default_ref": {
"anyOf": [
{
"$ref": "#/components/schemas/DefaultAgentRef"
},
{
"type": "null"
}
],
"description": "Reference to the predefined agent (e.g., DefaultAgentRef.SQL_QUERY).\n\nUsed to identify which system default this represents. Only set for default configs."
},
"input_json_schema": {
"additionalProperties": true,
"type": "object",
"title": "Input Json Schema",
"description": "The input schema for the agent.\n\nSpecifies the inputs that the agents require conforming to the JSON schema\nstandard.\nref: https://json-schema.org/\n\nNote that name of parameters are used to inject dependencies into the tools.\nIf a parameter name matches the argument name of a tool, then it will be\ninjected into the tool. It is up to the developer to ensure that the names\nmatch those required by the tools. The names are not validated.\n\nIf the parameters don't match the arguments of the tools, then the LLM may\nstill be able to manually include them in tool calls."
},
"output_json_schema": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Output Json Schema",
"description": "The output schema json for the agent.\n\nSpecifies the output that the agents output conforming to the JSON schema\nstandard.\nref: https://json-schema.org/\n\nIf None, the agent will output a string."
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At",
"description": "The time the config was last updated."
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At",
"description": "The time the config was created."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"id",
"name",
"description",
"prompt",
"llm_config",
"tool_configs",
"bound_tool_args",
"is_default",
"tool_id",
"user_id",
"published_status",
"default_ref",
"input_json_schema",
"updated_at",
"created_at"
],
"title": "AgentConfig",
"description": "Agent configuration response schema.\n\nRepresents a complete agent configuration that combines an LLM, tools, system prompt,\nand input/output schemas into a specialized AI assistant. This is the main entity\nusers interact with for conversations."
},
"AgentConfigCreate": {
"properties": {
"name": {
"type": "string",
"minLength": 2,
"title": "Name",
"description": "The name of the agent."
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "The description of the agent."
},
"prompt": {
"type": "string",
"minLength": 2,
"title": "Prompt",
"description": "The prompt for the agent."
},
"llm_config_id": {
"type": "string",
"format": "uuid",
"title": "Llm Config Id",
"description": "The ID of the LLM config associated with the agent."
},
"tool_config_ids": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"title": "Tool Config Ids",
"description": "The IDs of the tool configs associated with the agent."
},
"bound_tool_args": {
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array",
"title": "Bound Tool Args",
"description": "List of arguments to tools that have been hardcoded.\n\nThe order and length of this list is the same as that of tool_configs. The\ndictionaries in this list contain key-value pairs, where the key is the name\nof a tool argument and the value is what should be hardcoded for that tool.\nIf the dict is empty, then there are no hardcoded values for the tool."
},
"input_json_schema": {
"additionalProperties": true,
"type": "object",
"title": "Input Json Schema",
"description": "The input schema for the agent.\n\nWARNING: This field will be required in the future.\n\nSpecifies the inputs that the agents require conforming to the JSON schema\nstandard.\nref: https://json-schema.org/\n\nNote that name of parameters are used to inject dependencies into the tools.\nIf a parameter name matches the argument name of a tool, then it will be\ninjected into the tool. It is up to the developer to ensure that the names\nmatch those required by the tools. The names are not validated.\n\nIf the parameters don't match the arguments of the tools, then the LLM may\nstill be able to manually include them in tool calls."
},
"output_json_schema": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Output Json Schema",
"description": "The output schema for the agent.\n\nSpecifies the output that the agents output conforming to the JSON schema\nstandard.\nref: https://json-schema.org/\n\nIf None, the agent will output a string."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name",
"description",
"prompt",
"llm_config_id",
"tool_config_ids"
],
"title": "AgentConfigCreate",
"description": "Schema for creating an agent config."
},
"AgentConfigUpdate": {
"properties": {
"name": {
"anyOf": [
{
"type": "string",
"minLength": 2
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name of the agent."
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "The description of the agent."
},
"prompt": {
"anyOf": [
{
"type": "string",
"minLength": 2
},
{
"type": "null"
}
],
"title": "Prompt",
"description": "The prompt for the agent."
},
"llm_config_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Llm Config Id",
"description": "The ID of the LLM config associated with the agent."
},
"tool_config_ids": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Tool Config Ids",
"description": "The IDs of the tool configs associated with the agent.\n\nMust be provided if bound_tool_args are provided."
},
"bound_tool_args": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Bound Tool Args",
"description": "List of arguments to tools that have been hardcoded.\n\nThe order and length of this list is the same as that of tool_configs. The\ndictionaries in this list contain key-value pairs, where the key is the name\nof a tool argument and the value is what should be hardcoded for that tool.\nIf the dict is empty, then there are no hardcoded values for the tool.\n\nMust be provided if tool_config_ids are provided."
},
"published_status": {
"anyOf": [
{
"$ref": "#/components/schemas/PublishedStatus"
},
{
"type": "null"
}
],
"description": "The published status of the agent."
},
"tool_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Tool Id",
"description": "The ID of the tool that the agent is published as ."
},
"input_json_schema": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Input Json Schema",
"description": "The input schema for the agent.\n\nSpecifies the inputs that the agents require conforming to the JSON schema\nstandard.\nref: https://json-schema.org/\n\nNote that name of parameters are used to inject dependencies into the tools.\nIf a parameter name matches the argument name of a tool, then it will be\ninjected into the tool. It is up to the developer to ensure that the names\nmatch those required by the tools. The names are not validated.\n\nIf the parameters don't match the arguments of the tools, then the LLM may\nstill be able to manually include them in tool calls."
},
"output_json_schema": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Output Json Schema",
"description": "The output schema for the agent.\n\nSpecifies the output that the agents output conforming to the JSON schema\nstandard.\nref: https://json-schema.org/\n\nIf None, the agent will output a string."
}
},
"additionalProperties": false,
"type": "object",
"title": "AgentConfigUpdate",
"description": "Schema for updating an agent config."
},
"AudioUrl": {
"properties": {
"url": {
"type": "string",
"title": "Url",
"description": "The URL of the audio file."
},
"identifier": {
"type": "string",
"title": "Identifier"
},
"force_download": {
"type": "boolean",
"title": "Force Download",
"default": false
},
"vendor_metadata": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Vendor Metadata"
},
"kind": {
"type": "string",
"const": "audio-url",
"title": "Kind",
"description": "Type identifier, this is available on all parts as a discriminator.",
"default": "audio-url"
},
"media_type": {
"type": "string",
"title": "Media Type",
"description": "Return the media type of the file, based on the URL or the provided `media_type`.",
"readOnly": true
}
},
"type": "object",
"required": [
"url",
"identifier",
"media_type"
],
"title": "AudioUrl",
"description": "A URL to an audio file."
},
"BinaryContent": {
"properties": {
"data": {
"type": "string",
"format": "binary",
"title": "Data",
"description": "The binary data."
},
"media_type": {
"anyOf": [
{
"type": "string",
"enum": [
"audio/wav",
"audio/mpeg",
"audio/ogg",
"audio/flac",
"audio/aiff",
"audio/aac"
]
},
{
"type": "string",
"enum": [
"image/jpeg",
"image/png",
"image/gif",
"image/webp"
]
},
{
"type": "string",
"enum": [
"application/pdf",
"text/plain",
"text/csv",
"application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
"text/html",
"text/markdown",
"application/vnd.ms-excel"
]
},
{
"type": "string"
}
],
"title": "Media Type",
"description": "The media type of the binary data."
},
"identifier": {
"type": "string",
"title": "Identifier",
"description": "Identifier for the binary content, such as a unique ID.\nThis identifier can be provided to the model in a message to allow it to refer to this file in a tool call argument,\nand the tool can look up the file in question by iterating over the message history and finding the matching `BinaryContent`.\n\nThis identifier is only automatically passed to the model when the `BinaryContent` is returned by a tool.\nIf you're passing the `BinaryContent` as a user message, it's up to you to include a separate text part with the identifier,\ne.g. \"This is file <identifier>:\" preceding the `BinaryContent`."
},
"vendor_metadata": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Vendor Metadata",
"description": "Vendor-specific metadata for the file.\n\nSupported by:\n- `GoogleModel`: `BinaryContent.vendor_metadata` is used as `video_metadata`: https://ai.google.dev/gemini-api/docs/video-understanding#customize-video-processing\n- `OpenAIChatModel`, `OpenAIResponsesModel`: `BinaryContent.vendor_metadata['detail']` is used as `detail` setting for images"
},
"kind": {
"type": "string",
"const": "binary",
"title": "Kind",
"description": "Type identifier, this is available on all parts as a discriminator.",
"default": "binary"
}
},
"type": "object",
"required": [
"data",
"media_type",
"identifier"
],
"title": "BinaryContent",
"description": "Binary content, e.g. an audio or image file."
},
"Body_create_eval_cases_from_json_api_v1_evaluation_sets__eval_set_id__cases_json_post": {
"properties": {
"json_file": {
"type": "string",
"format": "binary",
"title": "Json File"
}
},
"type": "object",
"required": [
"json_file"
],
"title": "Body_create_eval_cases_from_json_api_v1_evaluation_sets__eval_set_id__cases_json_post"
},
"Body_create_sql_eval_cases_from_csv_api_v1_sql_evaluation_set__data_product_id__csv_post": {
"properties": {
"csv_file": {
"type": "string",
"format": "binary",
"title": "Csv File"
}
},
"type": "object",
"required": [
"csv_file"
],
"title": "Body_create_sql_eval_cases_from_csv_api_v1_sql_evaluation_set__data_product_id__csv_post"
},
"BuiltinToolCallPart": {
"properties": {
"tool_name": {
"type": "string",
"title": "Tool Name"
},
"args": {
"anyOf": [
{
"type": "string"
},
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Args"
},
"tool_call_id": {
"type": "string",
"title": "Tool Call Id"
},
"provider_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Provider Name",
"description": "The name of the provider that generated the response.\n\nBuilt-in tool calls are only sent back to the same provider."
},
"part_kind": {
"type": "string",
"const": "builtin-tool-call",
"title": "Part Kind",
"description": "Part type identifier, this is available on all parts as a discriminator.",
"default": "builtin-tool-call"
}
},
"type": "object",
"required": [
"tool_name"
],
"title": "BuiltinToolCallPart",
"description": "A tool call to a built-in tool."
},
"BuiltinToolReturnPart": {
"properties": {
"tool_name": {
"type": "string",
"title": "Tool Name"
},
"content": {
"title": "Content"
},
"tool_call_id": {
"type": "string",
"title": "Tool Call Id"
},
"metadata": {
"title": "Metadata"
},
"timestamp": {
"type": "string",
"format": "date-time",
"title": "Timestamp"
},
"provider_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Provider Name",
"description": "The name of the provider that generated the response."
},
"part_kind": {
"type": "string",
"const": "builtin-tool-return",
"title": "Part Kind",
"description": "Part type identifier, this is available on all parts as a discriminator.",
"default": "builtin-tool-return"
}
},
"type": "object",
"required": [
"tool_name",
"content"
],
"title": "BuiltinToolReturnPart",
"description": "A tool return message from a built-in tool."
},
"Chat": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "The ID of the chat."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "Optional display name for the chat."
},
"is_running": {
"type": "boolean",
"title": "Is Running",
"description": "Whether the chat is currently running an agent. Chats that are running will reject new messages.",
"default": false
}
},
"additionalProperties": false,
"type": "object",
"required": [
"id"
],
"title": "Chat",
"description": "Chat response schema.\n\nRepresents a conversation session between a user and an agent. Contains multiple\nmessages that form the conversation history. Each chat is scoped to a tenant."
},
"CreatedByFilterOption": {
"type": "string",
"enum": [
"user",
"all"
],
"title": "CreatedByFilterOption",
"description": "Filter options for getting chats."
},
"DataPage_AgentConfig_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AgentConfig"
},
"type": "array",
"title": "Data",
"description": "List of data objects."
},
"total": {
"type": "integer",
"minimum": 0.0,
"title": "Total",
"description": "Total number of data objects available."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"data",
"total"
],
"title": "DataPage[AgentConfig]"
},
"DataPage_Chat_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Chat"
},
"type": "array",
"title": "Data",
"description": "List of data objects."
},
"total": {
"type": "integer",
"minimum": 0.0,
"title": "Total",
"description": "Total number of data objects available."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"data",
"total"
],
"title": "DataPage[Chat]"
},
"DataPage_GenericEvaluationResultMetadata_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/GenericEvaluationResultMetadata"
},
"type": "array",
"title": "Data",
"description": "List of data objects."
},
"total": {
"type": "integer",
"minimum": 0.0,
"title": "Total",
"description": "Total number of data objects available."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"data",
"total"
],
"title": "DataPage[GenericEvaluationResultMetadata]"
},
"DataPage_GenericEvaluationSet_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/GenericEvaluationSet"
},
"type": "array",
"title": "Data",
"description": "List of data objects."
},
"total": {
"type": "integer",
"minimum": 0.0,
"title": "Total",
"description": "Total number of data objects available."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"data",
"total"
],
"title": "DataPage[GenericEvaluationSet]"
},
"DataPage_LLMConfig_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/LLMConfig"
},
"type": "array",
"title": "Data",
"description": "List of data objects."
},
"total": {
"type": "integer",
"minimum": 0.0,
"title": "Total",
"description": "Total number of data objects available."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"data",
"total"
],
"title": "DataPage[LLMConfig]"
},
"DataPage_Message_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Message"
},
"type": "array",
"title": "Data",
"description": "List of data objects."
},
"total": {
"type": "integer",
"minimum": 0.0,
"title": "Total",
"description": "Total number of data objects available."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"data",
"total"
],
"title": "DataPage[Message]"
},
"DataPage_SQLEvaluationResultMetadata_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/SQLEvaluationResultMetadata"
},
"type": "array",
"title": "Data",
"description": "List of data objects."
},
"total": {
"type": "integer",
"minimum": 0.0,
"title": "Total",
"description": "Total number of data objects available."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"data",
"total"
],
"title": "DataPage[SQLEvaluationResultMetadata]"
},
"DataPage_ToolConfig_": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ToolConfig"
},
"type": "array",
"title": "Data",
"description": "List of data objects."
},
"total": {
"type": "integer",
"minimum": 0.0,
"title": "Total",
"description": "Total number of data objects available."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"data",
"total"
],
"title": "DataPage[ToolConfig]"
},
"DeepResearchPlanSchema": {
"properties": {
"plan_title": {
"type": "string",
"title": "Plan Title",
"description": "The title of the research plan. This is used to identify the plan."
},
"plan_steps": {
"items": {
"$ref": "#/components/schemas/ResearchStep"
},
"type": "array",
"title": "Plan Steps",
"description": "The research plan as a list of main goals with distinct analytics questions to answer for each goal."
},
"plan_goal": {
"type": "string",
"title": "Plan Goal",
"description": "The main research goal. This is used to help generate the final summary.",
"default": ""
}
},
"additionalProperties": false,
"type": "object",
"required": [
"plan_title",
"plan_steps"
],
"title": "DeepResearchPlanSchema",
"description": "Schema for the deep research plan."
},
"DefaultAgentRef": {
"type": "string",
"enum": [
"sql_query_agent",
"bi_report_agent",
"catalog_search_agent",
"chart_create_agent",
"deep_research_agent",
"data_product_query_agent"
],
"title": "DefaultAgentRef",
"description": "Names of default agents hardcoded into alation AI."
},
"DefaultCatalogSearchAgentPayload": {
"properties": {
"message": {
"type": "string",
"minLength": 1,
"title": "Message",
"description": "The message to send to the agent."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"message"
],
"title": "DefaultCatalogSearchAgentPayload",
"description": "The input schema for the default catalog search agent."
},
"DefaultDataProductQueryAgentPayload": {
"properties": {
"message": {
"type": "string",
"minLength": 1,
"title": "Message",
"description": "The message to send to the agent."
},
"data_product_id": {
"type": "string",
"minLength": 1,
"title": "Data Product Id",
"description": "The ID of the data product to use."
},
"auth_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Auth Id",
"description": "The ID of the authentication credentials to use for the query."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"message",
"data_product_id"
],
"title": "DefaultDataProductQueryAgentPayload",
"description": "The input schema for the default data product query agent."
},
"DefaultDeepResearchAgentPayload": {
"properties": {
"message": {
"type": "string",
"minLength": 1,
"title": "Message",
"description": "The message to send to the agent."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"message"
],
"title": "DefaultDeepResearchAgentPayload",
"description": "Input schema for the default deep research agent."
},
"DefaultLLMRef": {
"type": "string",
"enum": [
"openai:o3",
"openai:gpt-4o",
"openai:gpt-4.1",
"openai:gpt-5-2025-08-07",
"openai:gpt-5-2025-08-07:low_reasoning",
"bedrock_us-west-2:anthropic.claude-3-5-sonnet-20240620-v1:0",
"bedrock_us-east-1:anthropic.claude-3-5-sonnet-20240620-v1:0",
"bedrock_eu-west-1:anthropic.claude-3-sonnet-20240229-v1:0",
"bedrock_eu-central-1:anthropic.claude-3-5-sonnet-20240620-v1:0",
"bedrock_ca-central-1:anthropic.claude-3-sonnet-20240229-v1:0",
"bedrock_ap-southeast-2:anthropic.claude-3-5-sonnet-20241022-v2:0",
"bedrock_ap-southeast-1:anthropic.claude-3-5-sonnet-20240620-v1:0",
"bedrock_ap-northeast-1:anthropic.claude-3-5-sonnet-20240620-v1:0",
"test"
],
"title": "DefaultLLMRef",
"description": "Names of default LLMs hardcoded into alation AI.\n\nThe syntax is <provider_name>:<model_name>, which matches Pydantic AI's syntax.\n\nref: https://ai.pydantic.dev/api/models/base/#pydantic_ai.models.KnownModelName"
},
"DefaultSQLQueryAgentPayload": {
"properties": {
"message": {
"type": "string",
"minLength": 1,
"title": "Message",
"description": "The message to send to the agent."
},
"data_product_id": {
"type": "string",
"minLength": 1,
"title": "Data Product Id",
"description": "The ID of the data product to use."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"message",
"data_product_id"
],
"title": "DefaultSQLQueryAgentPayload",
"description": "The input schema for the default SQL query agent."
},
"DefaultToolRef": {
"type": "string",
"enum": [
"alation_context_tool",
"bulk_retrieval_tool",
"sql_execution_tool",
"get_data_schema_tool",
"generate_chart_from_sql_and_code_tool",
"get_search_filter_fields_tool",
"get_search_filter_values_tool",
"search_catalog_tool",
"bi_report_search_tool",
"list_data_products_tool"
],
"title": "DefaultToolRef",
"description": "Names of default tools hardcoded into alation AI."
},
"DefaultToolScorerRef": {
"type": "string",
"enum": [
"llm_judge_scorer",
"sql_execution_scorer",
"chart_generation_scorer"
],
"title": "DefaultToolScorerRef",
"description": "Names of default tool scorers hardcoded into alation AI."
},
"DocumentUrl": {
"properties": {
"url": {
"type": "string",
"title": "Url",
"description": "The URL of the document."
},
"identifier": {
"type": "string",
"title": "Identifier"
},
"force_download": {
"type": "boolean",
"title": "Force Download",
"default": false
},
"vendor_metadata": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Vendor Metadata"
},
"kind": {
"type": "string",
"const": "document-url",
"title": "Kind",
"description": "Type identifier, this is available on all parts as a discriminator.",
"default": "document-url"
},
"media_type": {
"type": "string",
"title": "Media Type",
"description": "Return the media type of the file, based on the URL or the provided `media_type`.",
"readOnly": true
}
},
"type": "object",
"required": [
"url",
"identifier",
"media_type"
],
"title": "DocumentUrl",
"description": "The URL of the document."
},
"ErrorDetails": {
"properties": {
"type": {
"type": "string",
"title": "Type",
"description": "The type of error that occurred, this is an identifier designed for\nprogrammatic use that will change rarely or never.\n\n`type` is unique for each error message, and can hence be used as an identifier to build custom error messages."
},
"loc": {
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"type": "array",
"title": "Loc",
"description": "Tuple of strings and ints identifying where in the schema the error occurred."
},
"msg": {
"type": "string",
"title": "Msg",
"description": "A human readable error message."
},
"input": {
"title": "Input",
"description": "The input data at this `loc` that caused the error."
},
"ctx": {
"additionalProperties": true,
"type": "object",
"title": "Ctx",
"description": "Values which are required to render the error message, and could hence be useful in rendering custom error messages.\nAlso useful for passing custom error data forward."
},
"url": {
"type": "string",
"title": "Url",
"description": "The documentation URL giving information about the error. No URL is available if\na [`PydanticCustomError`][pydantic_core.PydanticCustomError] is used."
}
},
"type": "object",
"required": [
"type",
"loc",
"msg",
"input"
],
"title": "ErrorDetails"
},
"EvaluationResult_Union_int__float__": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"value": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"title": "Value"
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reason"
},
"source": {
"$ref": "#/components/schemas/EvaluatorSpec"
}
},
"type": "object",
"required": [
"name",
"value",
"reason",
"source"
],
"title": "EvaluationResult"
},
"EvaluationResult_bool_": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"value": {
"type": "boolean",
"title": "Value"
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reason"
},
"source": {
"$ref": "#/components/schemas/EvaluatorSpec"
}
},
"type": "object",
"required": [
"name",
"value",
"reason",
"source"
],
"title": "EvaluationResult"
},
"EvaluationResult_str_": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"value": {
"type": "string",
"title": "Value"
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reason"
},
"source": {
"$ref": "#/components/schemas/EvaluatorSpec"
}
},
"type": "object",
"required": [
"name",
"value",
"reason",
"source"
],
"title": "EvaluationResult"
},
"EvaluationRunStatus": {
"type": "string",
"enum": [
"RUNNING",
"CANCELLED",
"ERROR",
"COMPLETED"
],
"title": "EvaluationRunStatus",
"description": "Evaluation Status for an Evaluation Run."
},
"EvaluatorFailure": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"error_message": {
"type": "string",
"title": "Error Message"
},
"error_stacktrace": {
"type": "string",
"title": "Error Stacktrace"
},
"source": {
"$ref": "#/components/schemas/EvaluatorSpec"
}
},
"type": "object",
"required": [
"name",
"error_message",
"error_stacktrace",
"source"
],
"title": "EvaluatorFailure"
},
"EvaluatorSpec": {},
"FilePart": {
"properties": {
"content": {
"$ref": "#/components/schemas/BinaryContent",
"description": "The file content of the response."
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id",
"description": "The identifier of the file part."
},
"provider_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Provider Name",
"description": "The name of the provider that generated the response.\n "
},
"part_kind": {
"type": "string",
"const": "file",
"title": "Part Kind",
"description": "Part type identifier, this is available on all parts as a discriminator.",
"default": "file"
}
},
"type": "object",
"required": [
"content"
],
"title": "FilePart",
"description": "A file response from a model."
},
"Filter": {
"properties": {
"filter_id": {
"type": "integer",
"title": "Filter Id"
},
"filter_values": {
"items": {
"type": "string"
},
"type": "array",
"title": "Filter Values"
}
},
"type": "object",
"required": [
"filter_id",
"filter_values"
],
"title": "Filter",
"description": "Filter model for search queries."
},
"GenericEvaluationCase": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "The ID of the Generic Evaluation Case."
},
"eval_set_id": {
"type": "string",
"format": "uuid",
"title": "Eval Set Id",
"description": "The Evaluation Set this Evaluation Case belongs to."
},
"inputs": {
"$ref": "#/components/schemas/JsonValue-Output",
"description": "The inputs for the Generic Evaluation Case as JSON."
},
"expected_output": {
"$ref": "#/components/schemas/JsonValue-Output",
"description": "The expected outputs for the Generic Evaluation Case as JSON."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"id",
"eval_set_id",
"inputs",
"expected_output"
],
"title": "GenericEvaluationCase",
"description": "Generic Evaluation Case Schema."
},
"GenericEvaluationCaseCreate": {
"properties": {
"inputs": {
"$ref": "#/components/schemas/JsonValue-Input",
"description": "The inputs for the Generic Evaluation Case as JSON."
},
"expected_output": {
"$ref": "#/components/schemas/JsonValue-Input",
"description": "The expected output for the Generic Evaluation Case as JSON."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"inputs",
"expected_output"
],
"title": "GenericEvaluationCaseCreate",
"description": "Generic Evaluation Case Create Schema."
},
"GenericEvaluationCaseUpdate": {
"properties": {
"inputs": {
"anyOf": [
{
"$ref": "#/components/schemas/JsonValue-Input"
},
{
"type": "null"
}
],
"description": "The new inputs for the Generic Evaluation Case. None means no update."
},
"expected_output": {
"anyOf": [
{
"$ref": "#/components/schemas/JsonValue-Input"
},
{
"type": "null"
}
],
"description": "New expected output for the Generic Evaluation Case. None means no update."
}
},
"additionalProperties": false,
"type": "object",
"title": "GenericEvaluationCaseUpdate",
"description": "Generic Evaluation Case Update Schema."
},
"GenericEvaluationReport": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"cases": {
"items": {
"$ref": "#/components/schemas/ReportCase_TypeVar_TypeVar_TypeVar_"
},
"type": "array",
"title": "Cases"
},
"failures": {
"items": {
"$ref": "#/components/schemas/ReportCaseFailure_TypeVar_TypeVar_TypeVar_"
},
"type": "array",
"title": "Failures"
},
"trace_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Trace Id"
},
"span_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Span Id"
}
},
"type": "object",
"required": [
"name",
"cases"
],
"title": "GenericEvaluationReport"
},
"GenericEvaluationResult": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "The ID of the Result."
},
"eval_set_id": {
"type": "string",
"format": "uuid",
"title": "Eval Set Id",
"description": "The Evaluation Set ID this Result applies to."
},
"eval_set_name": {
"type": "string",
"title": "Eval Set Name",
"description": "The Evaluation Set name this Result applies to."
},
"eval_set_hash": {
"type": "string",
"title": "Eval Set Hash",
"description": "The hash of the Evaluation Set at the time of evaluation."
},
"agent_config_id": {
"type": "string",
"format": "uuid",
"title": "Agent Config Id",
"description": "The ID of the Agent Config used to generate the Result."
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At",
"description": "When the Result was created."
},
"num_cases": {
"type": "integer",
"title": "Num Cases",
"description": "The number of eval cases in the Result."
},
"run_status": {
"$ref": "#/components/schemas/EvaluationRunStatus",
"description": "The evaluation run status."
},
"llm_name": {
"type": "string",
"title": "Llm Name",
"description": "The name of the LLM used to generate the Result."
},
"eval_score": {
"anyOf": [
{
"$ref": "#/components/schemas/GenericEvaluationScore"
},
{
"type": "null"
}
],
"description": "The overall score of the Result, if the run completed successfully."
},
"evaluation_report": {
"anyOf": [
{
"$ref": "#/components/schemas/GenericEvaluationReport"
},
{
"type": "null"
}
],
"description": "The evaluated Generic Result formatted as a Pydantic Eval Report, if the run completed successfully."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"id",
"eval_set_id",
"eval_set_name",
"eval_set_hash",
"agent_config_id",
"created_at",
"num_cases",
"run_status",
"llm_name"
],
"title": "GenericEvaluationResult",
"description": "Generic Evaluation Result Schema."
},
"GenericEvaluationResultMetadata": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "The ID of the Result."
},
"eval_set_id": {
"type": "string",
"format": "uuid",
"title": "Eval Set Id",
"description": "The Evaluation Set ID this Result applies to."
},
"eval_set_name": {
"type": "string",
"title": "Eval Set Name",
"description": "The Evaluation Set name this Result applies to."
},
"eval_set_hash": {
"type": "string",
"title": "Eval Set Hash",
"description": "The hash of the Evaluation Set at the time of evaluation."
},
"agent_config_id": {
"type": "string",
"format": "uuid",
"title": "Agent Config Id",
"description": "The ID of the Agent Config used to generate the Result."
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At",
"description": "When the Result was created."
},
"num_cases": {
"type": "integer",
"title": "Num Cases",
"description": "The number of eval cases in the Result."
},
"run_status": {
"$ref": "#/components/schemas/EvaluationRunStatus",
"description": "The evaluation run status."
},
"llm_name": {
"type": "string",
"title": "Llm Name",
"description": "The name of the LLM used to generate the Result."
},
"eval_score": {
"anyOf": [
{
"$ref": "#/components/schemas/GenericEvaluationScore"
},
{
"type": "null"
}
],
"description": "The overall score of the Result, if the run completed successfully."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"id",
"eval_set_id",
"eval_set_name",
"eval_set_hash",
"agent_config_id",
"created_at",
"num_cases",
"run_status",
"llm_name"
],
"title": "GenericEvaluationResultMetadata",
"description": "Generic Evaluation Result Schema."
},
"GenericEvaluationScore": {
"properties": {
"scores": {
"additionalProperties": {
"type": "number"
},
"type": "object",
"title": "Scores",
"description": "The scores by metric name."
},
"avg_case_duration_s": {
"type": "number",
"title": "Avg Case Duration S",
"description": "The average duration per case, in seconds, to complete evaluation.",
"default": 0.0
}
},
"additionalProperties": false,
"type": "object",
"required": [
"scores"
],
"title": "GenericEvaluationScore",
"description": "Generic Evaluation Score Schema."
},
"GenericEvaluationSet": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "The ID of the Generic Evaluation Set."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the Generic Evaluation Set."
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "Description of the evaluation set."
},
"agent_config_id": {
"type": "string",
"format": "uuid",
"title": "Agent Config Id",
"description": "The ID of the agent config used to generate results."
},
"rubric": {
"type": "string",
"title": "Rubric",
"description": "The rubric for evaluating generated to expected outputs."
},
"cases": {
"items": {
"$ref": "#/components/schemas/GenericEvaluationCase"
},
"type": "array",
"title": "Cases",
"description": "The list of `GenericEvaluationCase` objects."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"id",
"name",
"agent_config_id",
"rubric",
"cases"
],
"title": "GenericEvaluationSet",
"description": "Generic Evaluation Set Schema."
},
"GenericEvaluationSetCreate": {
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "The name of the Generic Evaluation Set."
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "Description of the evaluation set."
},
"agent_config_id": {
"type": "string",
"format": "uuid",
"title": "Agent Config Id",
"description": "The ID of the Agent Config this evaluation set applies to."
},
"rubric": {
"type": "string",
"title": "Rubric",
"description": "The rubric to use for judging outputs for a task.",
"default": "Your task is to decide if a submitted answer is correct. Follow these rules strictly:\n1. If an expected output is provided:\n - The answer must include all exact values (numbers, strings, keywords) from the expected output.\n - Small differences in formatting, phrasing, or case are acceptable if the meaning is unchanged.\n - If values are missing, altered, or incorrect, the score is 0.\n - Otherwise, the score is 1.\n2. If no expected output is provided:\n - Score 1 if the answer completely and correctly fulfills the input question/task.\n - Score 0 if it is incomplete, incorrect, or irrelevant.\nReturn only a single score: 1 (correct) or 0 (incorrect).\n"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name",
"agent_config_id"
],
"title": "GenericEvaluationSetCreate",
"description": "Generic Evaluation Set Create Schema."
},
"GenericEvaluationSetUpdate": {
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The new name. None means no update."
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "The new description. None means no update."
},
"rubric": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Rubric",
"description": "The new rubric. None means no update."
}
},
"additionalProperties": false,
"type": "object",
"title": "GenericEvaluationSetUpdate",
"description": "Generic Evaluation Set Update Schema."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"ImageUrl": {
"properties": {
"url": {
"type": "string",
"title": "Url",
"description": "The URL of the image."
},
"identifier": {
"type": "string",
"title": "Identifier"
},
"force_download": {
"type": "boolean",
"title": "Force Download",
"default": false
},
"vendor_metadata": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Vendor Metadata"
},
"kind": {
"type": "string",
"const": "image-url",
"title": "Kind",
"description": "Type identifier, this is available on all parts as a discriminator.",
"default": "image-url"
},
"media_type": {
"type": "string",
"title": "Media Type",
"description": "Return the media type of the file, based on the URL or the provided `media_type`.",
"readOnly": true
}
},
"type": "object",
"required": [
"url",
"identifier",
"media_type"
],
"title": "ImageUrl",
"description": "A URL to an image."
},
"JsonValue-Input": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"items": {
"$ref": "#/components/schemas/JsonValue-Input"
},
"type": "array"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/JsonValue-Input"
},
"type": "object"
},
{
"type": "null"
}
]
},
"JsonValue-Output": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"items": {
"$ref": "#/components/schemas/JsonValue-Output"
},
"type": "array"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/JsonValue-Output"
},
"type": "object"
},
{
"type": "null"
}
]
},
"LLMConfig": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "The ID of the LLM config."
},
"name": {
"type": "string",
"title": "Name",
"description": "User-defined display name for the LLM (e.g., \"My Custom GPT-5\")."
},
"is_default": {
"type": "boolean",
"title": "Is Default",
"description": "Whether this is a system default configuration.\n\nDefault configs are read-only. Users can clone them to create custom configurations."
},
"user_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "User Id",
"description": "ID of the user who created this configuration (null for system defaults)."
},
"provider": {
"$ref": "#/components/schemas/LLMProvider",
"description": "The LLM provider hosting this model (e.g. OPENAI, BEDROCK)."
},
"default_ref": {
"anyOf": [
{
"$ref": "#/components/schemas/DefaultLLMRef"
},
{
"type": "null"
}
],
"description": "Reference to the predefined model (e.g., DefaultLLMRef.OPENAI_GPT_5).\n\nOnly set for default configs."
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At",
"description": "Timestamp when this configuration was last modified."
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At",
"description": "Timestamp when this configuration was created."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"id",
"name",
"is_default",
"user_id",
"provider",
"default_ref",
"updated_at",
"created_at"
],
"title": "LLMConfig",
"description": "LLM configuration response schema.\n\nUsed to connect to an LLM that can be used by agents."
},
"LLMProvider": {
"type": "string",
"enum": [
"openai",
"anthropic",
"bedrock_us-west-2",
"bedrock_us-east-1",
"bedrock_eu-west-1",
"bedrock_eu-central-1",
"bedrock_ca-central-1",
"bedrock_ap-southeast-1",
"bedrock_ap-southeast-2",
"bedrock_ap-northeast-1"
],
"title": "LLMProvider",
"description": "Provider of the model."
},
"Message": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "The ID of the message."
},
"chat_id": {
"type": "string",
"format": "uuid",
"title": "Chat Id",
"description": "The ID of the chat this message belongs to."
},
"model_message": {
"oneOf": [
{
"$ref": "#/components/schemas/ModelRequest"
},
{
"$ref": "#/components/schemas/ModelResponse"
}
],
"title": "Model Message",
"description": "The pydantic-ai ModelMessage containing message content and metadata.",
"discriminator": {
"propertyName": "kind",
"mapping": {
"request": "#/components/schemas/ModelRequest",
"response": "#/components/schemas/ModelResponse"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At",
"description": "The timestamp when the message was created."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"id",
"chat_id",
"model_message"
],
"title": "Message",
"description": "Message response schema.\n\nRepresents a single message in a chat conversation. Uses pydantic-ai's ModelMessage\nformat to store the complete conversation history including user prompts, assistant\nresponses, tool calls, and tool returns."
},
"ModelRequest": {
"properties": {
"parts": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/SystemPromptPart"
},
{
"$ref": "#/components/schemas/UserPromptPart"
},
{
"$ref": "#/components/schemas/ToolReturnPart"
},
{
"$ref": "#/components/schemas/RetryPromptPart"
}
],
"discriminator": {
"propertyName": "part_kind",
"mapping": {
"retry-prompt": "#/components/schemas/RetryPromptPart",
"system-prompt": "#/components/schemas/SystemPromptPart",
"tool-return": "#/components/schemas/ToolReturnPart",
"user-prompt": "#/components/schemas/UserPromptPart"
}
}
},
"type": "array",
"title": "Parts",
"description": "The parts of the user message."
},
"instructions": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Instructions",
"description": "The instructions for the model."
},
"kind": {
"type": "string",
"const": "request",
"title": "Kind",
"description": "Message type identifier, this is available on all parts as a discriminator.",
"default": "request"
}
},
"type": "object",
"required": [
"parts"
],
"title": "ModelRequest",
"description": "A request generated by Pydantic AI and sent to a model, e.g. a message from the Pydantic AI app to the model."
},
"ModelResponse": {
"properties": {
"parts": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/TextPart"
},
{
"$ref": "#/components/schemas/ToolCallPart"
},
{
"$ref": "#/components/schemas/BuiltinToolCallPart"
},
{
"$ref": "#/components/schemas/BuiltinToolReturnPart"
},
{
"$ref": "#/components/schemas/ThinkingPart"
},
{
"$ref": "#/components/schemas/FilePart"
}
],
"discriminator": {
"propertyName": "part_kind",
"mapping": {
"builtin-tool-call": "#/components/schemas/BuiltinToolCallPart",
"builtin-tool-return": "#/components/schemas/BuiltinToolReturnPart",
"file": "#/components/schemas/FilePart",
"text": "#/components/schemas/TextPart",
"thinking": "#/components/schemas/ThinkingPart",
"tool-call": "#/components/schemas/ToolCallPart"
}
}
},
"type": "array",
"title": "Parts",
"description": "The parts of the model message."
},
"usage": {
"$ref": "#/components/schemas/RequestUsage",
"description": "Usage information for the request.\n\nThis has a default to make tests easier, and to support loading old messages where usage will be missing."
},
"model_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Model Name",
"description": "The name of the model that generated the response."
},
"timestamp": {
"type": "string",
"format": "date-time",
"title": "Timestamp",
"description": "The timestamp of the response.\n\nIf the model provides a timestamp in the response (as OpenAI does) that will be used."
},
"kind": {
"type": "string",
"const": "response",
"title": "Kind",
"description": "Message type identifier, this is available on all parts as a discriminator.",
"default": "response"
},
"provider_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Provider Name",
"description": "The name of the LLM provider that generated the response."
},
"provider_details": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Provider Details",
"description": "Additional provider-specific details in a serializable format.\n\nThis allows storing selected vendor-specific data that isn't mapped to standard ModelResponse fields.\nFor OpenAI models, this may include 'logprobs', 'finish_reason', etc."
},
"provider_response_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Provider Response Id",
"description": "request ID as specified by the model provider. This can be used to track the specific request to the model."
},
"finish_reason": {
"anyOf": [
{
"type": "string",
"enum": [
"stop",
"length",
"content_filter",
"tool_call",
"error"
]
},
{
"type": "null"
}
],
"title": "Finish Reason",
"description": "Reason the model finished generating the response, normalized to OpenTelemetry values."
}
},
"type": "object",
"required": [
"parts"
],
"title": "ModelResponse",
"description": "A response from a model, e.g. a message from the model to the Pydantic AI app."
},
"ObjectType": {
"type": "string",
"enum": [
"table",
"procedure",
"function",
"api_resource",
"api_resource_field",
"api_resource_folder",
"article",
"bi_field",
"catalog_set",
"column",
"dataflow",
"datasource",
"doc_schema",
"docstore_collection",
"docstore_folder",
"domain",
"execution_result",
"file",
"filesystem",
"glossary",
"glossary_term",
"glossary_v3",
"group",
"query_or_statement",
"report_collection",
"report_datasource",
"report_object",
"report_source",
"schema",
"tag",
"thread",
"user",
"value"
],
"title": "ObjectType",
"description": "Object types supported by the search API."
},
"PublishedStatus": {
"type": "string",
"enum": [
"draft",
"published"
],
"title": "PublishedStatus",
"description": "Published status of an agent."
},
"ReportCaseFailure_TypeVar_TypeVar_TypeVar_": {
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "The name of the [case][pydantic_evals.Case]."
},
"inputs": {
"title": "Inputs",
"description": "The inputs to the task, from [`Case.inputs`][pydantic_evals.Case.inputs]."
},
"metadata": {
"anyOf": [
{},
{
"type": "null"
}
],
"title": "Metadata",
"description": "Any metadata associated with the case, from [`Case.metadata`][pydantic_evals.Case.metadata]."
},
"expected_output": {
"anyOf": [
{},
{
"type": "null"
}
],
"title": "Expected Output",
"description": "The expected output of the task, from [`Case.expected_output`][pydantic_evals.Case.expected_output]."
},
"error_message": {
"type": "string",
"title": "Error Message",
"description": "The message of the exception that caused the failure."
},
"error_stacktrace": {
"type": "string",
"title": "Error Stacktrace",
"description": "The stacktrace of the exception that caused the failure."
},
"trace_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Trace Id",
"description": "The trace ID of the case span."
},
"span_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Span Id",
"description": "The span ID of the case span."
}
},
"type": "object",
"required": [
"name",
"inputs",
"metadata",
"expected_output",
"error_message",
"error_stacktrace"
],
"title": "ReportCaseFailure"
},
"ReportCase_TypeVar_TypeVar_TypeVar_": {
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "The name of the [case][pydantic_evals.Case]."
},
"inputs": {
"title": "Inputs",
"description": "The inputs to the task, from [`Case.inputs`][pydantic_evals.Case.inputs]."
},
"metadata": {
"anyOf": [
{},
{
"type": "null"
}
],
"title": "Metadata",
"description": "Any metadata associated with the case, from [`Case.metadata`][pydantic_evals.Case.metadata]."
},
"expected_output": {
"anyOf": [
{},
{
"type": "null"
}
],
"title": "Expected Output",
"description": "The expected output of the task, from [`Case.expected_output`][pydantic_evals.Case.expected_output]."
},
"output": {
"title": "Output",
"description": "The output of the task execution."
},
"metrics": {
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
}
]
},
"type": "object",
"title": "Metrics"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"title": "Attributes"
},
"scores": {
"additionalProperties": {
"$ref": "#/components/schemas/EvaluationResult_Union_int__float__"
},
"type": "object",
"title": "Scores"
},
"labels": {
"additionalProperties": {
"$ref": "#/components/schemas/EvaluationResult_str_"
},
"type": "object",
"title": "Labels"
},
"assertions": {
"additionalProperties": {
"$ref": "#/components/schemas/EvaluationResult_bool_"
},
"type": "object",
"title": "Assertions"
},
"task_duration": {
"type": "number",
"title": "Task Duration"
},
"total_duration": {
"type": "number",
"title": "Total Duration"
},
"trace_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Trace Id",
"description": "The trace ID of the case span."
},
"span_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Span Id",
"description": "The span ID of the case span."
},
"evaluator_failures": {
"items": {
"$ref": "#/components/schemas/EvaluatorFailure"
},
"type": "array",
"title": "Evaluator Failures"
}
},
"type": "object",
"required": [
"name",
"inputs",
"metadata",
"expected_output",
"output",
"metrics",
"attributes",
"scores",
"labels",
"assertions",
"task_duration",
"total_duration"
],
"title": "ReportCase"
},
"RequestUsage": {
"properties": {
"input_tokens": {
"type": "integer",
"title": "Input Tokens",
"default": 0
},
"cache_write_tokens": {
"type": "integer",
"title": "Cache Write Tokens",
"default": 0
},
"cache_read_tokens": {
"type": "integer",
"title": "Cache Read Tokens",
"default": 0
},
"output_tokens": {
"type": "integer",
"title": "Output Tokens",
"default": 0
},
"input_audio_tokens": {
"type": "integer",
"title": "Input Audio Tokens",
"default": 0
},
"cache_audio_read_tokens": {
"type": "integer",
"title": "Cache Audio Read Tokens",
"default": 0
},
"output_audio_tokens": {
"type": "integer",
"title": "Output Audio Tokens",
"default": 0
},
"details": {
"additionalProperties": {
"type": "integer"
},
"type": "object",
"title": "Details"
}
},
"type": "object",
"title": "RequestUsage"
},
"ResearchStep": {
"properties": {
"section_header": {
"type": "string",
"title": "Section Header",
"description": "The main goal for this research step as a high level header to present to the user."
},
"instructions": {
"items": {
"type": "string"
},
"type": "array",
"title": "Instructions",
"description": "The list of analytics questions for the research step."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"section_header",
"instructions"
],
"title": "ResearchStep",
"description": "A single step in a deep research plan with a header and list of instructions."
},
"RetryPromptPart": {
"properties": {
"content": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ErrorDetails"
},
"type": "array"
},
{
"type": "string"
}
],
"title": "Content",
"description": "Details of why and how the model should retry.\n\nIf the retry was triggered by a [`ValidationError`][pydantic_core.ValidationError], this will be a list of\nerror details."
},
"tool_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Tool Name",
"description": "The name of the tool that was called, if any."
},
"tool_call_id": {
"type": "string",
"title": "Tool Call Id",
"description": "The tool call identifier, this is used by some models including OpenAI.\n\nIn case the tool call id is not provided by the model, Pydantic AI will generate a random one."
},
"timestamp": {
"type": "string",
"format": "date-time",
"title": "Timestamp",
"description": "The timestamp, when the retry was triggered."
},
"part_kind": {
"type": "string",
"const": "retry-prompt",
"title": "Part Kind",
"description": "Part type identifier, this is available on all parts as a discriminator.",
"default": "retry-prompt"
}
},
"type": "object",
"required": [
"content"
],
"title": "RetryPromptPart",
"description": "A message back to a model asking it to try again.\n\nThis can be sent for a number of reasons:\n\n* Pydantic validation of tool arguments failed, here content is derived from a Pydantic\n [`ValidationError`][pydantic_core.ValidationError]\n* a tool raised a [`ModelRetry`][pydantic_ai.exceptions.ModelRetry] exception\n* no tool was found for the tool name\n* the model returned plain text when a structured response was expected\n* Pydantic validation of a structured response failed, here content is derived from a Pydantic\n [`ValidationError`][pydantic_core.ValidationError]\n* an output validator raised a [`ModelRetry`][pydantic_ai.exceptions.ModelRetry] exception"
},
"SQLEvaluationCase": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "The ID of the SQL Evaluation Case."
},
"eval_set_id": {
"type": "string",
"format": "uuid",
"title": "Eval Set Id",
"description": "The Evaluation Set this Evaluation Case belongs to."
},
"question": {
"type": "string",
"title": "Question",
"description": "The text input for the SQL Evaluation Case."
},
"sql": {
"type": "string",
"title": "Sql",
"description": "The expected SQLs for the SQL Evaluation Case. Multiple queries may be provided, separated by ';'."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"id",
"eval_set_id",
"question",
"sql"
],
"title": "SQLEvaluationCase",
"description": "SQL Evaluation Case Schema."
},
"SQLEvaluationCaseCreate": {
"properties": {
"question": {
"type": "string",
"title": "Question",
"description": "The input question or task for the SQL Query Agent."
},
"sql": {
"type": "string",
"title": "Sql",
"description": "The expected SQLs which address the question/task. Multiple queries may be provided, separated by ';'."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"question",
"sql"
],
"title": "SQLEvaluationCaseCreate",
"description": "SQL Evaluation Case Create Schema."
},
"SQLEvaluationCaseUpdate": {
"properties": {
"question": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Question",
"description": "The new input question or task for the SQL Query Agent. None means no update."
},
"sql": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Sql",
"description": "The new expected SQLs which address the questions/tasks. None means no update. Multiple queries may be provided, separated by ';'."
}
},
"additionalProperties": false,
"type": "object",
"title": "SQLEvaluationCaseUpdate",
"description": "SQL Evaluation Case Update Schema."
},
"SQLEvaluationReport": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"cases": {
"items": {
"$ref": "#/components/schemas/ReportCase_TypeVar_TypeVar_TypeVar_"
},
"type": "array",
"title": "Cases"
},
"failures": {
"items": {
"$ref": "#/components/schemas/ReportCaseFailure_TypeVar_TypeVar_TypeVar_"
},
"type": "array",
"title": "Failures"
},
"trace_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Trace Id"
},
"span_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Span Id"
}
},
"type": "object",
"required": [
"name",
"cases"
],
"title": "SQLEvaluationReport"
},
"SQLEvaluationResult": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "The ID of the Result."
},
"data_product_id": {
"type": "string",
"title": "Data Product Id",
"description": "The Data Product ID this Result applies to."
},
"data_product": {
"additionalProperties": true,
"type": "object",
"title": "Data Product",
"description": "The Data Product at the time of evaluation."
},
"data_product_hash": {
"type": "string",
"title": "Data Product Hash",
"description": "The hash of the Data Product at the time of evaluation."
},
"eval_set_hash": {
"type": "string",
"title": "Eval Set Hash",
"description": "The hash of the Evaluation Set at the time of evaluation."
},
"agent_config_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Agent Config Id",
"description": "The ID of the Agent Config used to generate the Result."
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At",
"description": "When the Result was created."
},
"num_cases": {
"type": "integer",
"title": "Num Cases",
"description": "The number of eval cases in the Result."
},
"run_status": {
"$ref": "#/components/schemas/EvaluationRunStatus",
"description": "The evaluation run status."
},
"llm_name": {
"type": "string",
"title": "Llm Name",
"description": "The name of the LLM used to generate the Result."
},
"eval_score": {
"anyOf": [
{
"$ref": "#/components/schemas/SQLEvaluationScore"
},
{
"type": "null"
}
],
"description": "The overall score of the Result, if the run completed successfully."
},
"evaluation_report": {
"anyOf": [
{
"$ref": "#/components/schemas/SQLEvaluationReport"
},
{
"type": "null"
}
],
"description": "The evaluated Text-To-SQL Result formatted as a Pydantic Eval Report, if the run completed successfully."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"id",
"data_product_id",
"data_product",
"data_product_hash",
"eval_set_hash",
"agent_config_id",
"created_at",
"num_cases",
"run_status",
"llm_name"
],
"title": "SQLEvaluationResult",
"description": "SQL Evaluation Result Schema."
},
"SQLEvaluationResultMetadata": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "The ID of the Result."
},
"data_product_id": {
"type": "string",
"title": "Data Product Id",
"description": "The Data Product ID this Result applies to."
},
"data_product": {
"additionalProperties": true,
"type": "object",
"title": "Data Product",
"description": "The Data Product at the time of evaluation."
},
"data_product_hash": {
"type": "string",
"title": "Data Product Hash",
"description": "The hash of the Data Product at the time of evaluation."
},
"eval_set_hash": {
"type": "string",
"title": "Eval Set Hash",
"description": "The hash of the Evaluation Set at the time of evaluation."
},
"agent_config_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Agent Config Id",
"description": "The ID of the Agent Config used to generate the Result."
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At",
"description": "When the Result was created."
},
"num_cases": {
"type": "integer",
"title": "Num Cases",
"description": "The number of eval cases in the Result."
},
"run_status": {
"$ref": "#/components/schemas/EvaluationRunStatus",
"description": "The evaluation run status."
},
"llm_name": {
"type": "string",
"title": "Llm Name",
"description": "The name of the LLM used to generate the Result."
},
"eval_score": {
"anyOf": [
{
"$ref": "#/components/schemas/SQLEvaluationScore"
},
{
"type": "null"
}
],
"description": "The overall score of the Result, if the run completed successfully."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"id",
"data_product_id",
"data_product",
"data_product_hash",
"eval_set_hash",
"agent_config_id",
"created_at",
"num_cases",
"run_status",
"llm_name"
],
"title": "SQLEvaluationResultMetadata",
"description": "SQL Evaluation Result Schema."
},
"SQLEvaluationScore": {
"properties": {
"num_valid_cases": {
"type": "integer",
"title": "Num Valid Cases",
"description": "The number of cases with valid reference SQL."
},
"execution_accuracy_num_correct": {
"type": "integer",
"title": "Execution Accuracy Num Correct",
"description": "The number of cases with correct execution accuracy."
},
"llm_judge_accuracy_num_correct": {
"type": "integer",
"title": "Llm Judge Accuracy Num Correct",
"description": "The number of cases which an LLM judge deemed correct."
},
"execution_accuracy": {
"type": "number",
"title": "Execution Accuracy",
"description": "The average execution accuracy of the SQL Cases."
},
"llm_judge_accuracy": {
"type": "number",
"title": "Llm Judge Accuracy",
"description": "The average LLM judge accuracy of the SQL Cases."
},
"avg_case_task_duration_s": {
"type": "number",
"title": "Avg Case Task Duration S",
"description": "The average duration per case, in seconds, to complete the agent task."
},
"avg_case_duration_s": {
"type": "number",
"title": "Avg Case Duration S",
"description": "The average duration per case, in seconds, to complete evaluation."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"num_valid_cases",
"execution_accuracy_num_correct",
"llm_judge_accuracy_num_correct",
"execution_accuracy",
"llm_judge_accuracy"
],
"title": "SQLEvaluationScore",
"description": "SQL Evaluation Score Schema."
},
"SQLEvaluationSet": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "The ID of the SQL Evaluation Set."
},
"data_product_id": {
"type": "string",
"title": "Data Product Id",
"description": "The Data Product ID this Evaluation Set applies to."
},
"cases": {
"items": {
"$ref": "#/components/schemas/SQLEvaluationCase"
},
"type": "array",
"title": "Cases",
"description": "The list of `SQLEvaluationCase` objects."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"id",
"data_product_id",
"cases"
],
"title": "SQLEvaluationSet",
"description": "SQL Evaluation Schema."
},
"SystemPromptPart": {
"properties": {
"content": {
"type": "string",
"title": "Content",
"description": "The content of the prompt."
},
"timestamp": {
"type": "string",
"format": "date-time",
"title": "Timestamp",
"description": "The timestamp of the prompt."
},
"dynamic_ref": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dynamic Ref",
"description": "The ref of the dynamic system prompt function that generated this part.\n\nOnly set if system prompt is dynamic, see [`system_prompt`][pydantic_ai.Agent.system_prompt] for more information."
},
"part_kind": {
"type": "string",
"const": "system-prompt",
"title": "Part Kind",
"description": "Part type identifier, this is available on all parts as a discriminator.",
"default": "system-prompt"
}
},
"type": "object",
"required": [
"content"
],
"title": "SystemPromptPart",
"description": "A system prompt, generally written by the application developer.\n\nThis gives the model context and guidance on how to respond."
},
"TextPart": {
"properties": {
"content": {
"type": "string",
"title": "Content",
"description": "The text content of the response."
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id",
"description": "An optional identifier of the text part."
},
"part_kind": {
"type": "string",
"const": "text",
"title": "Part Kind",
"description": "Part type identifier, this is available on all parts as a discriminator.",
"default": "text"
}
},
"type": "object",
"required": [
"content"
],
"title": "TextPart",
"description": "A plain text response from a model."
},
"ThinkingPart": {
"properties": {
"content": {
"type": "string",
"title": "Content",
"description": "The thinking content of the response."
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id",
"description": "The identifier of the thinking part."
},
"signature": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Signature",
"description": "The signature of the thinking.\n\nSupported by:\n\n* Anthropic (corresponds to the `signature` field)\n* Bedrock (corresponds to the `signature` field)\n* Google (corresponds to the `thought_signature` field)\n* OpenAI (corresponds to the `encrypted_content` field)"
},
"provider_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Provider Name",
"description": "The name of the provider that generated the response.\n\nSignatures are only sent back to the same provider."
},
"part_kind": {
"type": "string",
"const": "thinking",
"title": "Part Kind",
"description": "Part type identifier, this is available on all parts as a discriminator.",
"default": "thinking"
}
},
"type": "object",
"required": [
"content"
],
"title": "ThinkingPart",
"description": "A thinking response from a model."
},
"ToolCallPart": {
"properties": {
"tool_name": {
"type": "string",
"title": "Tool Name"
},
"args": {
"anyOf": [
{
"type": "string"
},
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Args"
},
"tool_call_id": {
"type": "string",
"title": "Tool Call Id"
},
"part_kind": {
"type": "string",
"const": "tool-call",
"title": "Part Kind",
"description": "Part type identifier, this is available on all parts as a discriminator.",
"default": "tool-call"
}
},
"type": "object",
"required": [
"tool_name"
],
"title": "ToolCallPart",
"description": "A tool call from a model."
},
"ToolConfig": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "The ID of the tool config."
},
"name": {
"type": "string",
"title": "Name",
"description": "Display name of the tool (e.g., \"SQL Execution Tool\")."
},
"description": {
"type": "string",
"title": "Description",
"description": "Description of the tool's functionality.\n\nThis description is included in agent prompts to help the LLM understand\nwhen and how to use this tool effectively."
},
"is_default": {
"type": "boolean",
"title": "Is Default",
"description": "Whether this is a system default configuration.\n\nDefault configs are read-only. Users can clone them to create custom configurations."
},
"user_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "User Id",
"description": "ID of the user who created this configuration (null for system defaults)."
},
"default_ref": {
"anyOf": [
{
"$ref": "#/components/schemas/DefaultToolRef"
},
{
"type": "null"
}
],
"description": "Reference to the predefined tool (e.g., DefaultToolRef.SQL_EXECUTION).\n\nOnly set for default configs."
},
"agent_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Agent Id",
"description": "When agent_id is present, this is a tool that runs that agent."
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At",
"description": "Timestamp when this configuration was last modified."
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At",
"description": "Timestamp when this configuration was created."
},
"scorer_ref": {
"$ref": "#/components/schemas/DefaultToolScorerRef",
"description": "Reference to the Tool Scorer to use when using tool-based evaluation."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"id",
"name",
"description",
"is_default",
"user_id",
"default_ref",
"agent_id",
"updated_at",
"created_at",
"scorer_ref"
],
"title": "ToolConfig",
"description": "Tool configuration response schema.\n\nRepresents a tool that agents can use during conversations. Contains the\nname and description that help the LLM understand when to use this tool."
},
"ToolReturnPart": {
"properties": {
"tool_name": {
"type": "string",
"title": "Tool Name"
},
"content": {
"title": "Content"
},
"tool_call_id": {
"type": "string",
"title": "Tool Call Id"
},
"metadata": {
"title": "Metadata"
},
"timestamp": {
"type": "string",
"format": "date-time",
"title": "Timestamp"
},
"part_kind": {
"type": "string",
"const": "tool-return",
"title": "Part Kind",
"description": "Part type identifier, this is available on all parts as a discriminator.",
"default": "tool-return"
}
},
"type": "object",
"required": [
"tool_name",
"content"
],
"title": "ToolReturnPart",
"description": "A tool return message, this encodes the result of running a tool."
},
"UserPromptPart": {
"properties": {
"content": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/ImageUrl"
},
{
"$ref": "#/components/schemas/AudioUrl"
},
{
"$ref": "#/components/schemas/DocumentUrl"
},
{
"$ref": "#/components/schemas/VideoUrl"
},
{
"$ref": "#/components/schemas/BinaryContent"
}
]
},
"type": "array"
}
],
"title": "Content",
"description": "The content of the prompt."
},
"timestamp": {
"type": "string",
"format": "date-time",
"title": "Timestamp",
"description": "The timestamp of the prompt."
},
"part_kind": {
"type": "string",
"const": "user-prompt",
"title": "Part Kind",
"description": "Part type identifier, this is available on all parts as a discriminator.",
"default": "user-prompt"
}
},
"type": "object",
"required": [
"content"
],
"title": "UserPromptPart",
"description": "A user prompt, generally written by the end user.\n\nContent comes from the `user_prompt` parameter of [`Agent.run`][pydantic_ai.agent.AbstractAgent.run],\n[`Agent.run_sync`][pydantic_ai.agent.AbstractAgent.run_sync], and [`Agent.run_stream`][pydantic_ai.agent.AbstractAgent.run_stream]."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"VideoUrl": {
"properties": {
"url": {
"type": "string",
"title": "Url",
"description": "The URL of the video."
},
"identifier": {
"type": "string",
"title": "Identifier"
},
"force_download": {
"type": "boolean",
"title": "Force Download",
"default": false
},
"vendor_metadata": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Vendor Metadata"
},
"kind": {
"type": "string",
"const": "video-url",
"title": "Kind",
"description": "Type identifier, this is available on all parts as a discriminator.",
"default": "video-url"
},
"media_type": {
"type": "string",
"title": "Media Type",
"description": "Return the media type of the file, based on the URL or the provided `media_type`.",
"readOnly": true
}
},
"type": "object",
"required": [
"url",
"identifier",
"media_type"
],
"title": "VideoUrl",
"description": "A URL to a video."
},
"alation_context_tool_parameters": {
"properties": {
"question": {
"type": "string",
"title": "Question"
},
"signature": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Signature"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"question"
],
"title": "alation_context_tool_parameters"
},
"bi_report_search_tool_parameters": {
"properties": {
"search_term": {
"type": "string",
"title": "Search Term"
},
"filters": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Filter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Filters"
},
"limit": {
"type": "integer",
"title": "Limit",
"default": 20
}
},
"additionalProperties": false,
"type": "object",
"required": [
"search_term"
],
"title": "bi_report_search_tool_parameters"
},
"bulk_retrieval_tool_parameters": {
"properties": {
"signature": {
"additionalProperties": true,
"type": "object",
"title": "Signature"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"signature"
],
"title": "bulk_retrieval_tool_parameters"
},
"generate_chart_from_sql_and_code_tool_parameters": {
"properties": {
"data_product_id": {
"type": "string",
"title": "Data Product Id"
},
"sql": {
"type": "string",
"title": "Sql"
},
"chart_code_snippet": {
"type": "string",
"title": "Chart Code Snippet"
},
"image_title": {
"type": "string",
"title": "Image Title"
},
"auth_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Auth Id"
},
"allow_fallback_auth": {
"type": "boolean",
"title": "Allow Fallback Auth",
"default": false,
"deprecated": true
}
},
"additionalProperties": false,
"type": "object",
"required": [
"data_product_id",
"sql",
"chart_code_snippet",
"image_title"
],
"title": "generate_chart_from_sql_and_code_tool_parameters"
},
"get_data_schema_tool_parameters": {
"properties": {
"data_product_id": {
"type": "string",
"title": "Data Product Id"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"data_product_id"
],
"title": "get_data_schema_tool_parameters"
},
"get_search_filter_fields_tool_parameters": {
"properties": {
"search_term": {
"type": "string",
"title": "Search Term"
},
"limit": {
"type": "integer",
"title": "Limit",
"default": 10
}
},
"additionalProperties": false,
"type": "object",
"required": [
"search_term"
],
"title": "get_search_filter_fields_tool_parameters"
},
"get_search_filter_values_tool_parameters": {
"properties": {
"field_id": {
"type": "integer",
"title": "Field Id"
},
"search_term": {
"type": "string",
"title": "Search Term"
},
"limit": {
"type": "integer",
"title": "Limit",
"default": 10
}
},
"additionalProperties": false,
"type": "object",
"required": [
"field_id",
"search_term"
],
"title": "get_search_filter_values_tool_parameters"
},
"list_data_products_tool_parameters": {
"properties": {
"search_term": {
"type": "string",
"title": "Search Term"
},
"limit": {
"type": "integer",
"title": "Limit",
"default": 5
},
"marketplace_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Marketplace Id"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"search_term"
],
"title": "list_data_products_tool_parameters"
},
"search_catalog_tool_parameters": {
"properties": {
"search_term": {
"type": "string",
"title": "Search Term"
},
"object_types": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ObjectType"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Object Types"
},
"filters": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Filter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Filters"
},
"limit": {
"type": "integer",
"title": "Limit",
"default": 20
}
},
"additionalProperties": false,
"type": "object",
"required": [
"search_term"
],
"title": "search_catalog_tool_parameters"
},
"sql_execution_tool_parameters": {
"properties": {
"data_product_id": {
"type": "string",
"title": "Data Product Id"
},
"sql": {
"type": "string",
"title": "Sql"
},
"result_table_name": {
"type": "string",
"title": "Result Table Name"
},
"auth_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Auth Id"
},
"allow_fallback_auth": {
"type": "boolean",
"title": "Allow Fallback Auth",
"default": false,
"deprecated": true
}
},
"additionalProperties": false,
"type": "object",
"required": [
"data_product_id",
"sql",
"result_table_name"
],
"title": "sql_execution_tool_parameters"
}
}
},
"tags": [
{
"name": "v1",
"description": "All of the v1 APIs"
},
{
"name": "v1.admin",
"description": "Admin operations for a tenant."
},
{
"name": "v1.chats",
"description": "Operations with chats."
},
{
"name": "v1.config",
"description": "Operations with configurations for tools/agents."
},
{
"name": "v1.evaluation",
"description": "Operations with evaluations."
},
{
"name": "v1.sql_evaluation",
"description": "Operations with SQL evaluations."
},
{
"name": "v1.status",
"description": "Operations about the health of the service itself."
}
],
"servers": [
{
"url": "{protocol}://{base-url}",
"variables": {
"base-url": {
"default": "alation_domain",
"description": "Alation BASE_URL setting for this instance."
},
"protocol": {
"default": "https",
"enum": [
"http",
"https"
]
}
}
}
]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment