diff --git a/fern/apis/api/openapi.json b/fern/apis/api/openapi.json index 260d27ff0..5fae8079c 100644 --- a/fern/apis/api/openapi.json +++ b/fern/apis/api/openapi.json @@ -3689,6 +3689,10 @@ "$ref": "#/components/schemas/FunctionTool", "title": "FunctionTool" }, + { + "$ref": "#/components/schemas/KnowledgeBaseTool", + "title": "KnowledgeBaseTool" + }, { "$ref": "#/components/schemas/GhlTool", "title": "GhlTool" @@ -3774,6 +3778,7 @@ "dtmf": "#/components/schemas/DtmfTool", "endCall": "#/components/schemas/EndCallTool", "function": "#/components/schemas/FunctionTool", + "knowledgeBase": "#/components/schemas/KnowledgeBaseTool", "transferCall": "#/components/schemas/TransferCallTool", "handoff": "#/components/schemas/HandoffTool", "bash": "#/components/schemas/BashTool", @@ -3933,6 +3938,10 @@ "$ref": "#/components/schemas/FunctionTool", "title": "FunctionTool" }, + { + "$ref": "#/components/schemas/KnowledgeBaseTool", + "title": "KnowledgeBaseTool" + }, { "$ref": "#/components/schemas/GhlTool", "title": "GhlTool" @@ -4018,6 +4027,7 @@ "dtmf": "#/components/schemas/DtmfTool", "endCall": "#/components/schemas/EndCallTool", "function": "#/components/schemas/FunctionTool", + "knowledgeBase": "#/components/schemas/KnowledgeBaseTool", "transferCall": "#/components/schemas/TransferCallTool", "handoff": "#/components/schemas/HandoffTool", "bash": "#/components/schemas/BashTool", @@ -4097,6 +4107,10 @@ "$ref": "#/components/schemas/FunctionTool", "title": "FunctionTool" }, + { + "$ref": "#/components/schemas/KnowledgeBaseTool", + "title": "KnowledgeBaseTool" + }, { "$ref": "#/components/schemas/GhlTool", "title": "GhlTool" @@ -4182,6 +4196,7 @@ "dtmf": "#/components/schemas/DtmfTool", "endCall": "#/components/schemas/EndCallTool", "function": "#/components/schemas/FunctionTool", + "knowledgeBase": "#/components/schemas/KnowledgeBaseTool", "transferCall": "#/components/schemas/TransferCallTool", "handoff": "#/components/schemas/HandoffTool", "bash": "#/components/schemas/BashTool", @@ -4257,6 +4272,10 @@ "$ref": "#/components/schemas/UpdateFunctionToolDTO", "title": "FunctionTool" }, + { + "$ref": "#/components/schemas/UpdateKnowledgeBaseToolDTO", + "title": "KnowledgeBaseTool" + }, { "$ref": "#/components/schemas/UpdateTransferCallToolDTO", "title": "TransferCallTool" @@ -4337,6 +4356,7 @@ "dtmf": "#/components/schemas/UpdateDtmfToolDTO", "endCall": "#/components/schemas/UpdateEndCallToolDTO", "function": "#/components/schemas/UpdateFunctionToolDTO", + "knowledgeBase": "#/components/schemas/UpdateKnowledgeBaseToolDTO", "transferCall": "#/components/schemas/UpdateTransferCallToolDTO", "handoff": "#/components/schemas/UpdateHandoffToolDTO", "bash": "#/components/schemas/UpdateBashToolDTO", @@ -4388,6 +4408,10 @@ "$ref": "#/components/schemas/FunctionTool", "title": "FunctionTool" }, + { + "$ref": "#/components/schemas/KnowledgeBaseTool", + "title": "KnowledgeBaseTool" + }, { "$ref": "#/components/schemas/GhlTool", "title": "GhlTool" @@ -4473,6 +4497,7 @@ "dtmf": "#/components/schemas/DtmfTool", "endCall": "#/components/schemas/EndCallTool", "function": "#/components/schemas/FunctionTool", + "knowledgeBase": "#/components/schemas/KnowledgeBaseTool", "transferCall": "#/components/schemas/TransferCallTool", "handoff": "#/components/schemas/HandoffTool", "bash": "#/components/schemas/BashTool", @@ -4549,6 +4574,10 @@ "$ref": "#/components/schemas/FunctionTool", "title": "FunctionTool" }, + { + "$ref": "#/components/schemas/KnowledgeBaseTool", + "title": "KnowledgeBaseTool" + }, { "$ref": "#/components/schemas/GhlTool", "title": "GhlTool" @@ -4634,6 +4663,7 @@ "dtmf": "#/components/schemas/DtmfTool", "endCall": "#/components/schemas/EndCallTool", "function": "#/components/schemas/FunctionTool", + "knowledgeBase": "#/components/schemas/KnowledgeBaseTool", "transferCall": "#/components/schemas/TransferCallTool", "handoff": "#/components/schemas/HandoffTool", "bash": "#/components/schemas/BashTool", @@ -4876,6 +4906,383 @@ ] } }, + "/v2/knowledge-base": { + "post": { + "operationId": "KnowledgeBaseV2Controller_create", + "summary": "Create a Knowledge Base V2", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateKnowledgeBaseV2DTO" + } + } + } + }, + "responses": { + "201": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/KnowledgeBaseV2" + } + } + } + } + }, + "tags": [ + "Knowledge Bases V2" + ], + "security": [ + { + "bearer": [] + } + ] + }, + "get": { + "operationId": "KnowledgeBaseV2Controller_findAll", + "summary": "List Knowledge Bases V2", + "parameters": [ + { + "name": "limit", + "required": false, + "in": "query", + "schema": { + "minimum": 0, + "maximum": 1000, + "type": "number" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/KnowledgeBaseV2" + } + } + } + } + } + }, + "tags": [ + "Knowledge Bases V2" + ], + "security": [ + { + "bearer": [] + } + ] + } + }, + "/v2/knowledge-base/{id}/file": { + "get": { + "operationId": "KnowledgeBaseV2Controller_filesGet", + "summary": "List files in a Knowledge Base V2", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "description": "The unique identifier for the resource.", + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/KnowledgeBaseV2File" + } + } + } + } + } + }, + "tags": [ + "Knowledge Bases V2" + ], + "security": [ + { + "bearer": [] + } + ] + }, + "post": { + "operationId": "KnowledgeBaseV2Controller_fileAttach", + "summary": "Attach and ingest a file", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "description": "The unique identifier for the resource.", + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AttachKnowledgeBaseV2FileDTO" + } + } + } + }, + "responses": { + "201": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/KnowledgeBaseV2File" + } + } + } + } + }, + "tags": [ + "Knowledge Bases V2" + ], + "security": [ + { + "bearer": [] + } + ] + } + }, + "/v2/knowledge-base/{id}/file/{fileId}": { + "delete": { + "operationId": "KnowledgeBaseV2Controller_fileDetach", + "summary": "Detach a file", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "description": "The unique identifier for the resource.", + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "name": "fileId", + "required": true, + "in": "path", + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/KnowledgeBaseV2File" + } + } + } + } + }, + "tags": [ + "Knowledge Bases V2" + ], + "security": [ + { + "bearer": [] + } + ] + } + }, + "/v2/knowledge-base/{id}/file/{fileId}/retry": { + "post": { + "operationId": "KnowledgeBaseV2Controller_fileRetry", + "summary": "Retry indexing a failed file", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "description": "The unique identifier for the resource.", + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "name": "fileId", + "required": true, + "in": "path", + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "201": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/KnowledgeBaseV2File" + } + } + } + } + }, + "tags": [ + "Knowledge Bases V2" + ], + "security": [ + { + "bearer": [] + } + ] + } + }, + "/v2/knowledge-base/{id}": { + "patch": { + "operationId": "KnowledgeBaseV2Controller_update", + "summary": "Update a Knowledge Base V2", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "description": "The unique identifier for the resource.", + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateKnowledgeBaseV2DTO" + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/KnowledgeBaseV2" + } + } + } + } + }, + "tags": [ + "Knowledge Bases V2" + ], + "security": [ + { + "bearer": [] + } + ] + }, + "get": { + "operationId": "KnowledgeBaseV2Controller_findOne", + "summary": "Get a Knowledge Base V2", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "description": "The unique identifier for the resource.", + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/KnowledgeBaseV2WithFiles" + } + } + } + } + }, + "tags": [ + "Knowledge Bases V2" + ], + "security": [ + { + "bearer": [] + } + ] + }, + "delete": { + "operationId": "KnowledgeBaseV2Controller_remove", + "summary": "Delete a Knowledge Base V2", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "description": "The unique identifier for the resource.", + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/KnowledgeBaseV2" + } + } + } + } + }, + "tags": [ + "Knowledge Bases V2" + ], + "security": [ + { + "bearer": [] + } + ] + } + }, "/structured-output": { "get": { "operationId": "StructuredOutputController_findAll", @@ -5282,26 +5689,7 @@ "post": { "operationId": "PersonalityController_create", "summary": "Create Personality", - "parameters": [ - { - "name": "x-client-source", - "required": false, - "in": "header", - "description": "Identifies the product surface making the request", - "schema": { - "type": "string" - } - }, - { - "name": "x-simulation-entry-point", - "required": false, - "in": "header", - "description": "Identifies the dashboard simulation flow", - "schema": { - "type": "string" - } - } - ], + "parameters": [], "requestBody": { "required": true, "content": { @@ -5541,24 +5929,6 @@ "format": "uuid", "type": "string" } - }, - { - "name": "x-client-source", - "required": false, - "in": "header", - "description": "Identifies the product surface making the request", - "schema": { - "type": "string" - } - }, - { - "name": "x-simulation-entry-point", - "required": false, - "in": "header", - "description": "Identifies the dashboard simulation flow", - "schema": { - "type": "string" - } } ], "requestBody": { @@ -5605,24 +5975,6 @@ "format": "uuid", "type": "string" } - }, - { - "name": "x-client-source", - "required": false, - "in": "header", - "description": "Identifies the product surface making the request", - "schema": { - "type": "string" - } - }, - { - "name": "x-simulation-entry-point", - "required": false, - "in": "header", - "description": "Identifies the dashboard simulation flow", - "schema": { - "type": "string" - } } ], "responses": { @@ -5651,26 +6003,7 @@ "post": { "operationId": "ScenarioController_create", "summary": "Create Scenario", - "parameters": [ - { - "name": "x-client-source", - "required": false, - "in": "header", - "description": "Identifies the product surface making the request", - "schema": { - "type": "string" - } - }, - { - "name": "x-simulation-entry-point", - "required": false, - "in": "header", - "description": "Identifies the dashboard simulation flow", - "schema": { - "type": "string" - } - } - ], + "parameters": [], "requestBody": { "required": true, "content": { @@ -5932,24 +6265,6 @@ "format": "uuid", "type": "string" } - }, - { - "name": "x-client-source", - "required": false, - "in": "header", - "description": "Identifies the product surface making the request", - "schema": { - "type": "string" - } - }, - { - "name": "x-simulation-entry-point", - "required": false, - "in": "header", - "description": "Identifies the dashboard simulation flow", - "schema": { - "type": "string" - } } ], "requestBody": { @@ -5996,24 +6311,6 @@ "format": "uuid", "type": "string" } - }, - { - "name": "x-client-source", - "required": false, - "in": "header", - "description": "Identifies the product surface making the request", - "schema": { - "type": "string" - } - }, - { - "name": "x-simulation-entry-point", - "required": false, - "in": "header", - "description": "Identifies the dashboard simulation flow", - "schema": { - "type": "string" - } } ], "responses": { @@ -6051,24 +6348,6 @@ "schema": { "type": "string" } - }, - { - "name": "x-client-source", - "required": false, - "in": "header", - "description": "Identifies the product surface making the request", - "schema": { - "type": "string" - } - }, - { - "name": "x-simulation-entry-point", - "required": false, - "in": "header", - "description": "Identifies the dashboard simulation flow", - "schema": { - "type": "string" - } } ], "requestBody": { @@ -6378,24 +6657,6 @@ "format": "uuid", "type": "string" } - }, - { - "name": "x-client-source", - "required": false, - "in": "header", - "description": "Identifies the product surface making the request", - "schema": { - "type": "string" - } - }, - { - "name": "x-simulation-entry-point", - "required": false, - "in": "header", - "description": "Identifies the dashboard simulation flow", - "schema": { - "type": "string" - } } ], "responses": { @@ -6773,26 +7034,7 @@ "post": { "operationId": "SimulationSuiteController_create", "summary": "Create Simulation Suite", - "parameters": [ - { - "name": "x-client-source", - "required": false, - "in": "header", - "description": "Identifies the product surface making the request", - "schema": { - "type": "string" - } - }, - { - "name": "x-simulation-entry-point", - "required": false, - "in": "header", - "description": "Identifies the dashboard simulation flow", - "schema": { - "type": "string" - } - } - ], + "parameters": [], "requestBody": { "required": true, "content": { @@ -7041,24 +7283,6 @@ "format": "uuid", "type": "string" } - }, - { - "name": "x-client-source", - "required": false, - "in": "header", - "description": "Identifies the product surface making the request", - "schema": { - "type": "string" - } - }, - { - "name": "x-simulation-entry-point", - "required": false, - "in": "header", - "description": "Identifies the dashboard simulation flow", - "schema": { - "type": "string" - } } ], "requestBody": { @@ -7105,24 +7329,6 @@ "format": "uuid", "type": "string" } - }, - { - "name": "x-client-source", - "required": false, - "in": "header", - "description": "Identifies the product surface making the request", - "schema": { - "type": "string" - } - }, - { - "name": "x-simulation-entry-point", - "required": false, - "in": "header", - "description": "Identifies the dashboard simulation flow", - "schema": { - "type": "string" - } } ], "responses": { @@ -7152,26 +7358,7 @@ "operationId": "SimulationGenerateController_generate", "summary": "Generate Scenarios with AI", "description": "Uses AI to analyze an assistant or squad configuration and generate test scenarios", - "parameters": [ - { - "name": "x-client-source", - "required": false, - "in": "header", - "description": "Identifies the product surface making the request", - "schema": { - "type": "string" - } - }, - { - "name": "x-simulation-entry-point", - "required": false, - "in": "header", - "description": "Identifies the dashboard simulation flow", - "schema": { - "type": "string" - } - } - ], + "parameters": [], "requestBody": { "required": true, "content": { @@ -7208,26 +7395,7 @@ "post": { "operationId": "SimulationController_create", "summary": "Create Simulation", - "parameters": [ - { - "name": "x-client-source", - "required": false, - "in": "header", - "description": "Identifies the product surface making the request", - "schema": { - "type": "string" - } - }, - { - "name": "x-simulation-entry-point", - "required": false, - "in": "header", - "description": "Identifies the dashboard simulation flow", - "schema": { - "type": "string" - } - } - ], + "parameters": [], "requestBody": { "required": true, "content": { @@ -7489,24 +7657,6 @@ "format": "uuid", "type": "string" } - }, - { - "name": "x-client-source", - "required": false, - "in": "header", - "description": "Identifies the product surface making the request", - "schema": { - "type": "string" - } - }, - { - "name": "x-simulation-entry-point", - "required": false, - "in": "header", - "description": "Identifies the dashboard simulation flow", - "schema": { - "type": "string" - } } ], "requestBody": { @@ -7553,24 +7703,6 @@ "format": "uuid", "type": "string" } - }, - { - "name": "x-client-source", - "required": false, - "in": "header", - "description": "Identifies the product surface making the request", - "schema": { - "type": "string" - } - }, - { - "name": "x-simulation-entry-point", - "required": false, - "in": "header", - "description": "Identifies the dashboard simulation flow", - "schema": { - "type": "string" - } } ], "responses": { @@ -10095,12 +10227,79 @@ "description": "Use VAD to assist with endpointing decisions from the transcriber.\nWhen enabled, transcriber endpointing will be buffered if VAD detects the user is still speaking, preventing premature turn-taking.\nWhen disabled, transcriber endpointing will be used immediately regardless of VAD state, allowing for quicker but more aggressive turn-taking.\nNote: Only used if startSpeakingPlan.smartEndpointingPlan is not set.\n\n@default true", "example": true }, + "mode": { + "type": "string", + "description": "This is the transcription mode used by the `universal-3-5-pro` speech model. Only applies to the `universal-3-5-pro` speech model.\n\n@default 'balanced'", + "enum": [ + "max_accuracy", + "min_latency", + "balanced" + ] + }, + "prompt": { + "type": "string", + "description": "This is a prompt that provides additional context to the transcription model. Only applies to the `universal-3-5-pro` speech model.", + "maxLength": 1750 + }, + "agentContext": { + "type": "string", + "description": "This is context about the voice agent that guides the transcription model. Only applies to the `universal-3-5-pro` speech model.", + "maxLength": 1750 + }, + "languageCodes": { + "type": "array", + "description": "These are language codes used to steer automatic language detection. Only applies to the `universal-3-5-pro` speech model.", + "enum": [ + "en", + "es", + "fr", + "de", + "it", + "pt", + "tr", + "nl", + "sv", + "no", + "da", + "fi", + "hi", + "vi", + "ar", + "he", + "ja", + "zh" + ], + "items": { + "type": "string", + "enum": [ + "en", + "es", + "fr", + "de", + "it", + "pt", + "tr", + "nl", + "sv", + "no", + "da", + "fi", + "hi", + "vi", + "ar", + "he", + "ja", + "zh" + ] + } + }, "speechModel": { "type": "string", - "description": "This is the speech model used for the streaming session.\nNote: Keyterms prompting is not supported with multilingual streaming.\n@default 'universal-streaming-english'", + "description": "This is the speech model used for the streaming session.\nKeyterms prompting is supported on universal-streaming-english and universal-3-5-pro.\nuniversal-3-5-pro is AssemblyAI's most accurate voice-agent model.\n@default 'universal-streaming-english'", "enum": [ "universal-streaming-english", - "universal-streaming-multilingual" + "universal-streaming-multilingual", + "universal-3-5-pro" ] }, "realtimeUrl": { @@ -10116,7 +10315,7 @@ } }, "keytermsPrompt": { - "description": "Keyterms prompting improves recognition accuracy for specific words and phrases.\nCan include up to 100 keyterms, each up to 50 characters.\nCosts an additional $0.04/hour when enabled.", + "description": "Keyterms prompting improves recognition accuracy for specific words and phrases.\nCan include up to 100 keyterms, each up to 50 characters.\nCosts an additional $0.04/hour on universal-streaming-english and is included at no extra cost on universal-3-5-pro.", "type": "array", "items": { "type": "string", @@ -13274,12 +13473,79 @@ "description": "Use VAD to assist with endpointing decisions from the transcriber.\nWhen enabled, transcriber endpointing will be buffered if VAD detects the user is still speaking, preventing premature turn-taking.\nWhen disabled, transcriber endpointing will be used immediately regardless of VAD state, allowing for quicker but more aggressive turn-taking.\nNote: Only used if startSpeakingPlan.smartEndpointingPlan is not set.\n\n@default true", "example": true }, + "mode": { + "type": "string", + "description": "This is the transcription mode used by the `universal-3-5-pro` speech model. Only applies to the `universal-3-5-pro` speech model.\n\n@default 'balanced'", + "enum": [ + "max_accuracy", + "min_latency", + "balanced" + ] + }, + "prompt": { + "type": "string", + "description": "This is a prompt that provides additional context to the transcription model. Only applies to the `universal-3-5-pro` speech model.", + "maxLength": 1750 + }, + "agentContext": { + "type": "string", + "description": "This is context about the voice agent that guides the transcription model. Only applies to the `universal-3-5-pro` speech model.", + "maxLength": 1750 + }, + "languageCodes": { + "type": "array", + "description": "These are language codes used to steer automatic language detection. Only applies to the `universal-3-5-pro` speech model.", + "enum": [ + "en", + "es", + "fr", + "de", + "it", + "pt", + "tr", + "nl", + "sv", + "no", + "da", + "fi", + "hi", + "vi", + "ar", + "he", + "ja", + "zh" + ], + "items": { + "type": "string", + "enum": [ + "en", + "es", + "fr", + "de", + "it", + "pt", + "tr", + "nl", + "sv", + "no", + "da", + "fi", + "hi", + "vi", + "ar", + "he", + "ja", + "zh" + ] + } + }, "speechModel": { "type": "string", - "description": "This is the speech model used for the streaming session.\nNote: Keyterms prompting is not supported with multilingual streaming.\n@default 'universal-streaming-english'", + "description": "This is the speech model used for the streaming session.\nKeyterms prompting is supported on universal-streaming-english and universal-3-5-pro.\nuniversal-3-5-pro is AssemblyAI's most accurate voice-agent model.\n@default 'universal-streaming-english'", "enum": [ "universal-streaming-english", - "universal-streaming-multilingual" + "universal-streaming-multilingual", + "universal-3-5-pro" ] }, "realtimeUrl": { @@ -13295,7 +13561,7 @@ } }, "keytermsPrompt": { - "description": "Keyterms prompting improves recognition accuracy for specific words and phrases.\nCan include up to 100 keyterms, each up to 50 characters.\nCosts an additional $0.04/hour when enabled.", + "description": "Keyterms prompting improves recognition accuracy for specific words and phrases.\nCan include up to 100 keyterms, each up to 50 characters.\nCosts an additional $0.04/hour on universal-streaming-english and is included at no extra cost on universal-3-5-pro.", "type": "array", "items": { "type": "string", @@ -43969,6 +44235,10 @@ "example": true, "default": true }, + "callToken": { + "type": "string", + "description": "This is the meeting token the web client should join the call with.\nWhen video recording is enabled, joining with this token starts the cloud\nrecording automatically server-side, which is more reliable than the\nclient starting it after joining. Set by the server; only present when\nvideo recording is enabled." + }, "callUrl": { "type": "string", "description": "This is the URL of the web call." @@ -51916,6 +52186,123 @@ "updatedAt" ] }, + "KnowledgeBaseToolFunction": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.", + "maxLength": 64, + "pattern": "/^[a-zA-Z0-9_-]{1,64}$/" + }, + "strict": { + "type": "boolean", + "description": "This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false", + "default": false + }, + "description": { + "type": "string", + "description": "This is the description of what the function does, used by the AI to choose when and how to call the function." + }, + "parameters": { + "description": "These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAIFunctionParameters" + } + ] + } + }, + "required": [ + "name", + "description", + "parameters" + ] + }, + "KnowledgeBaseTool": { + "type": "object", + "properties": { + "latestVersion": { + "type": "string", + "nullable": true + }, + "messages": { + "type": "array", + "description": "Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/ToolMessageStart", + "title": "ToolMessageStart" + }, + { + "$ref": "#/components/schemas/ToolMessageComplete", + "title": "ToolMessageComplete" + }, + { + "$ref": "#/components/schemas/ToolMessageFailed", + "title": "ToolMessageFailed" + }, + { + "$ref": "#/components/schemas/ToolMessageDelayed", + "title": "ToolMessageDelayed" + } + ] + } + }, + "type": { + "type": "string", + "enum": [ + "knowledgeBase" + ], + "description": "A Vapi-hosted knowledge base retrieval tool." + }, + "knowledgeBaseId": { + "type": "string", + "nullable": true, + "format": "uuid", + "description": "The knowledge base this tool searches. At most one search tool references a knowledge base. Deleting the base also deletes its generated tool; null references are retained only for backward compatibility and are inert." + }, + "function": { + "$ref": "#/components/schemas/KnowledgeBaseToolFunction" + }, + "id": { + "type": "string", + "description": "This is the unique identifier for the tool." + }, + "orgId": { + "type": "string", + "description": "This is the unique identifier for the organization that this tool belongs to." + }, + "createdAt": { + "type": "string", + "description": "This is the ISO 8601 date-time string of when the tool was created.", + "format": "date-time" + }, + "updatedAt": { + "type": "string", + "description": "This is the ISO 8601 date-time string of when the tool was last updated.", + "format": "date-time" + }, + "rejectionPlan": { + "description": "This is the plan to reject a tool call based on the conversation state.\n\n// Example 1: Reject endCall if user didn't say goodbye\n```json\n{\n conditions: [{\n type: 'regex',\n regex: '(?i)\\\\b(bye|goodbye|farewell|see you later|take care)\\\\b',\n target: { position: -1, role: 'user' },\n negate: true // Reject if pattern does NOT match\n }]\n}\n```\n\n// Example 2: Reject transfer if user is actually asking a question\n```json\n{\n conditions: [{\n type: 'regex',\n regex: '\\\\?',\n target: { position: -1, role: 'user' }\n }]\n}\n```\n\n// Example 3: Reject transfer if user didn't mention transfer recently\n```json\n{\n conditions: [{\n type: 'liquid',\n liquid: `{% assign recentMessages = messages | last: 5 %}\n{% assign userMessages = recentMessages | where: 'role', 'user' %}\n{% assign mentioned = false %}\n{% for msg in userMessages %}\n {% if msg.content contains 'transfer' or msg.content contains 'connect' or msg.content contains 'speak to' %}\n {% assign mentioned = true %}\n {% break %}\n {% endif %}\n{% endfor %}\n{% if mentioned %}\n false\n{% else %}\n true\n{% endif %}`\n }]\n}\n```\n\n// Example 4: Reject endCall if the bot is looping and trying to exit\n```json\n{\n conditions: [{\n type: 'liquid',\n liquid: `{% assign recentMessages = messages | last: 6 %}\n{% assign userMessages = recentMessages | where: 'role', 'user' | reverse %}\n{% if userMessages.size < 3 %}\n false\n{% else %}\n {% assign msg1 = userMessages[0].content | downcase %}\n {% assign msg2 = userMessages[1].content | downcase %}\n {% assign msg3 = userMessages[2].content | downcase %}\n {% comment %} Check for repetitive messages {% endcomment %}\n {% if msg1 == msg2 or msg1 == msg3 or msg2 == msg3 %}\n true\n {% comment %} Check for common loop phrases {% endcomment %}\n {% elsif msg1 contains 'cool thanks' or msg2 contains 'cool thanks' or msg3 contains 'cool thanks' %}\n true\n {% elsif msg1 contains 'okay thanks' or msg2 contains 'okay thanks' or msg3 contains 'okay thanks' %}\n true\n {% elsif msg1 contains 'got it' or msg2 contains 'got it' or msg3 contains 'got it' %}\n true\n {% else %}\n false\n {% endif %}\n{% endif %}`\n }]\n}\n```", + "allOf": [ + { + "$ref": "#/components/schemas/ToolRejectionPlan" + } + ] + } + }, + "required": [ + "type", + "knowledgeBaseId", + "function", + "id", + "orgId", + "createdAt", + "updatedAt" + ] + }, "GhlTool": { "type": "object", "properties": { @@ -54542,14 +54929,58 @@ "type": { "type": "string", "enum": [ - "dtmf" + "dtmf" + ], + "description": "The type of tool. \"dtmf\" for DTMF tool." + }, + "sipInfoDtmfEnabled": { + "type": "boolean", + "description": "This enables sending DTMF tones via SIP INFO messages instead of RFC 2833 (RTP events). When enabled, DTMF digits will be sent using the SIP INFO method, which can be more reliable in some network configurations. Only relevant when using the `vapi.sip` transport.", + "default": false + }, + "rejectionPlan": { + "description": "This is the plan to reject a tool call based on the conversation state.\n\n// Example 1: Reject endCall if user didn't say goodbye\n```json\n{\n conditions: [{\n type: 'regex',\n regex: '(?i)\\\\b(bye|goodbye|farewell|see you later|take care)\\\\b',\n target: { position: -1, role: 'user' },\n negate: true // Reject if pattern does NOT match\n }]\n}\n```\n\n// Example 2: Reject transfer if user is actually asking a question\n```json\n{\n conditions: [{\n type: 'regex',\n regex: '\\\\?',\n target: { position: -1, role: 'user' }\n }]\n}\n```\n\n// Example 3: Reject transfer if user didn't mention transfer recently\n```json\n{\n conditions: [{\n type: 'liquid',\n liquid: `{% assign recentMessages = messages | last: 5 %}\n{% assign userMessages = recentMessages | where: 'role', 'user' %}\n{% assign mentioned = false %}\n{% for msg in userMessages %}\n {% if msg.content contains 'transfer' or msg.content contains 'connect' or msg.content contains 'speak to' %}\n {% assign mentioned = true %}\n {% break %}\n {% endif %}\n{% endfor %}\n{% if mentioned %}\n false\n{% else %}\n true\n{% endif %}`\n }]\n}\n```\n\n// Example 4: Reject endCall if the bot is looping and trying to exit\n```json\n{\n conditions: [{\n type: 'liquid',\n liquid: `{% assign recentMessages = messages | last: 6 %}\n{% assign userMessages = recentMessages | where: 'role', 'user' | reverse %}\n{% if userMessages.size < 3 %}\n false\n{% else %}\n {% assign msg1 = userMessages[0].content | downcase %}\n {% assign msg2 = userMessages[1].content | downcase %}\n {% assign msg3 = userMessages[2].content | downcase %}\n {% comment %} Check for repetitive messages {% endcomment %}\n {% if msg1 == msg2 or msg1 == msg3 or msg2 == msg3 %}\n true\n {% comment %} Check for common loop phrases {% endcomment %}\n {% elsif msg1 contains 'cool thanks' or msg2 contains 'cool thanks' or msg3 contains 'cool thanks' %}\n true\n {% elsif msg1 contains 'okay thanks' or msg2 contains 'okay thanks' or msg3 contains 'okay thanks' %}\n true\n {% elsif msg1 contains 'got it' or msg2 contains 'got it' or msg3 contains 'got it' %}\n true\n {% else %}\n false\n {% endif %}\n{% endif %}`\n }]\n}\n```", + "allOf": [ + { + "$ref": "#/components/schemas/ToolRejectionPlan" + } + ] + } + } + }, + "UpdateEndCallToolDTO": { + "type": "object", + "properties": { + "messages": { + "type": "array", + "description": "Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/ToolMessageStart", + "title": "ToolMessageStart" + }, + { + "$ref": "#/components/schemas/ToolMessageComplete", + "title": "ToolMessageComplete" + }, + { + "$ref": "#/components/schemas/ToolMessageFailed", + "title": "ToolMessageFailed" + }, + { + "$ref": "#/components/schemas/ToolMessageDelayed", + "title": "ToolMessageDelayed" + } + ] + } + }, + "type": { + "type": "string", + "enum": [ + "endCall" ], - "description": "The type of tool. \"dtmf\" for DTMF tool." - }, - "sipInfoDtmfEnabled": { - "type": "boolean", - "description": "This enables sending DTMF tones via SIP INFO messages instead of RFC 2833 (RTP events). When enabled, DTMF digits will be sent using the SIP INFO method, which can be more reliable in some network configurations. Only relevant when using the `vapi.sip` transport.", - "default": false + "description": "The type of tool. \"endCall\" for End Call tool." }, "rejectionPlan": { "description": "This is the plan to reject a tool call based on the conversation state.\n\n// Example 1: Reject endCall if user didn't say goodbye\n```json\n{\n conditions: [{\n type: 'regex',\n regex: '(?i)\\\\b(bye|goodbye|farewell|see you later|take care)\\\\b',\n target: { position: -1, role: 'user' },\n negate: true // Reject if pattern does NOT match\n }]\n}\n```\n\n// Example 2: Reject transfer if user is actually asking a question\n```json\n{\n conditions: [{\n type: 'regex',\n regex: '\\\\?',\n target: { position: -1, role: 'user' }\n }]\n}\n```\n\n// Example 3: Reject transfer if user didn't mention transfer recently\n```json\n{\n conditions: [{\n type: 'liquid',\n liquid: `{% assign recentMessages = messages | last: 5 %}\n{% assign userMessages = recentMessages | where: 'role', 'user' %}\n{% assign mentioned = false %}\n{% for msg in userMessages %}\n {% if msg.content contains 'transfer' or msg.content contains 'connect' or msg.content contains 'speak to' %}\n {% assign mentioned = true %}\n {% break %}\n {% endif %}\n{% endfor %}\n{% if mentioned %}\n false\n{% else %}\n true\n{% endif %}`\n }]\n}\n```\n\n// Example 4: Reject endCall if the bot is looping and trying to exit\n```json\n{\n conditions: [{\n type: 'liquid',\n liquid: `{% assign recentMessages = messages | last: 6 %}\n{% assign userMessages = recentMessages | where: 'role', 'user' | reverse %}\n{% if userMessages.size < 3 %}\n false\n{% else %}\n {% assign msg1 = userMessages[0].content | downcase %}\n {% assign msg2 = userMessages[1].content | downcase %}\n {% assign msg3 = userMessages[2].content | downcase %}\n {% comment %} Check for repetitive messages {% endcomment %}\n {% if msg1 == msg2 or msg1 == msg3 or msg2 == msg3 %}\n true\n {% comment %} Check for common loop phrases {% endcomment %}\n {% elsif msg1 contains 'cool thanks' or msg2 contains 'cool thanks' or msg3 contains 'cool thanks' %}\n true\n {% elsif msg1 contains 'okay thanks' or msg2 contains 'okay thanks' or msg3 contains 'okay thanks' %}\n true\n {% elsif msg1 contains 'got it' or msg2 contains 'got it' or msg3 contains 'got it' %}\n true\n {% else %}\n false\n {% endif %}\n{% endif %}`\n }]\n}\n```", @@ -54561,7 +54992,7 @@ } } }, - "UpdateEndCallToolDTO": { + "UpdateFunctionToolDTO": { "type": "object", "properties": { "messages": { @@ -54591,9 +55022,37 @@ "type": { "type": "string", "enum": [ - "endCall" + "function" ], - "description": "The type of tool. \"endCall\" for End Call tool." + "description": "The type of tool. \"function\" for Function tool." + }, + "async": { + "type": "boolean", + "example": false, + "description": "This determines if the tool is async.\n\n If async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\n If sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\n Defaults to synchronous (`false`)." + }, + "server": { + "description": "\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.", + "allOf": [ + { + "$ref": "#/components/schemas/Server" + } + ] + }, + "variableExtractionPlan": { + "description": "Plan to extract variables from the tool response", + "allOf": [ + { + "$ref": "#/components/schemas/VariableExtractionPlan" + } + ] + }, + "parameters": { + "description": "Static key-value pairs merged into the request body. Values support Liquid templates.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ToolParameter" + } }, "rejectionPlan": { "description": "This is the plan to reject a tool call based on the conversation state.\n\n// Example 1: Reject endCall if user didn't say goodbye\n```json\n{\n conditions: [{\n type: 'regex',\n regex: '(?i)\\\\b(bye|goodbye|farewell|see you later|take care)\\\\b',\n target: { position: -1, role: 'user' },\n negate: true // Reject if pattern does NOT match\n }]\n}\n```\n\n// Example 2: Reject transfer if user is actually asking a question\n```json\n{\n conditions: [{\n type: 'regex',\n regex: '\\\\?',\n target: { position: -1, role: 'user' }\n }]\n}\n```\n\n// Example 3: Reject transfer if user didn't mention transfer recently\n```json\n{\n conditions: [{\n type: 'liquid',\n liquid: `{% assign recentMessages = messages | last: 5 %}\n{% assign userMessages = recentMessages | where: 'role', 'user' %}\n{% assign mentioned = false %}\n{% for msg in userMessages %}\n {% if msg.content contains 'transfer' or msg.content contains 'connect' or msg.content contains 'speak to' %}\n {% assign mentioned = true %}\n {% break %}\n {% endif %}\n{% endfor %}\n{% if mentioned %}\n false\n{% else %}\n true\n{% endif %}`\n }]\n}\n```\n\n// Example 4: Reject endCall if the bot is looping and trying to exit\n```json\n{\n conditions: [{\n type: 'liquid',\n liquid: `{% assign recentMessages = messages | last: 6 %}\n{% assign userMessages = recentMessages | where: 'role', 'user' | reverse %}\n{% if userMessages.size < 3 %}\n false\n{% else %}\n {% assign msg1 = userMessages[0].content | downcase %}\n {% assign msg2 = userMessages[1].content | downcase %}\n {% assign msg3 = userMessages[2].content | downcase %}\n {% comment %} Check for repetitive messages {% endcomment %}\n {% if msg1 == msg2 or msg1 == msg3 or msg2 == msg3 %}\n true\n {% comment %} Check for common loop phrases {% endcomment %}\n {% elsif msg1 contains 'cool thanks' or msg2 contains 'cool thanks' or msg3 contains 'cool thanks' %}\n true\n {% elsif msg1 contains 'okay thanks' or msg2 contains 'okay thanks' or msg3 contains 'okay thanks' %}\n true\n {% elsif msg1 contains 'got it' or msg2 contains 'got it' or msg3 contains 'got it' %}\n true\n {% else %}\n false\n {% endif %}\n{% endif %}`\n }]\n}\n```", @@ -54602,10 +55061,18 @@ "$ref": "#/components/schemas/ToolRejectionPlan" } ] + }, + "function": { + "description": "This is the function definition of the tool.", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAIFunction" + } + ] } } }, - "UpdateFunctionToolDTO": { + "UpdateKnowledgeBaseToolDTO": { "type": "object", "properties": { "messages": { @@ -54635,37 +55102,18 @@ "type": { "type": "string", "enum": [ - "function" + "knowledgeBase" ], - "description": "The type of tool. \"function\" for Function tool." - }, - "async": { - "type": "boolean", - "example": false, - "description": "This determines if the tool is async.\n\n If async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\n If sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\n Defaults to synchronous (`false`)." - }, - "server": { - "description": "\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.", - "allOf": [ - { - "$ref": "#/components/schemas/Server" - } - ] + "description": "A Vapi-hosted knowledge base retrieval tool." }, - "variableExtractionPlan": { - "description": "Plan to extract variables from the tool response", - "allOf": [ - { - "$ref": "#/components/schemas/VariableExtractionPlan" - } - ] + "knowledgeBaseId": { + "type": "string", + "nullable": true, + "format": "uuid", + "description": "The knowledge base this tool searches. At most one search tool references a knowledge base. Deleting the base also deletes its generated tool; null references are retained only for backward compatibility and are inert." }, - "parameters": { - "description": "Static key-value pairs merged into the request body. Values support Liquid templates.", - "type": "array", - "items": { - "$ref": "#/components/schemas/ToolParameter" - } + "function": { + "$ref": "#/components/schemas/KnowledgeBaseToolFunction" }, "rejectionPlan": { "description": "This is the plan to reject a tool call based on the conversation state.\n\n// Example 1: Reject endCall if user didn't say goodbye\n```json\n{\n conditions: [{\n type: 'regex',\n regex: '(?i)\\\\b(bye|goodbye|farewell|see you later|take care)\\\\b',\n target: { position: -1, role: 'user' },\n negate: true // Reject if pattern does NOT match\n }]\n}\n```\n\n// Example 2: Reject transfer if user is actually asking a question\n```json\n{\n conditions: [{\n type: 'regex',\n regex: '\\\\?',\n target: { position: -1, role: 'user' }\n }]\n}\n```\n\n// Example 3: Reject transfer if user didn't mention transfer recently\n```json\n{\n conditions: [{\n type: 'liquid',\n liquid: `{% assign recentMessages = messages | last: 5 %}\n{% assign userMessages = recentMessages | where: 'role', 'user' %}\n{% assign mentioned = false %}\n{% for msg in userMessages %}\n {% if msg.content contains 'transfer' or msg.content contains 'connect' or msg.content contains 'speak to' %}\n {% assign mentioned = true %}\n {% break %}\n {% endif %}\n{% endfor %}\n{% if mentioned %}\n false\n{% else %}\n true\n{% endif %}`\n }]\n}\n```\n\n// Example 4: Reject endCall if the bot is looping and trying to exit\n```json\n{\n conditions: [{\n type: 'liquid',\n liquid: `{% assign recentMessages = messages | last: 6 %}\n{% assign userMessages = recentMessages | where: 'role', 'user' | reverse %}\n{% if userMessages.size < 3 %}\n false\n{% else %}\n {% assign msg1 = userMessages[0].content | downcase %}\n {% assign msg2 = userMessages[1].content | downcase %}\n {% assign msg3 = userMessages[2].content | downcase %}\n {% comment %} Check for repetitive messages {% endcomment %}\n {% if msg1 == msg2 or msg1 == msg3 or msg2 == msg3 %}\n true\n {% comment %} Check for common loop phrases {% endcomment %}\n {% elsif msg1 contains 'cool thanks' or msg2 contains 'cool thanks' or msg3 contains 'cool thanks' %}\n true\n {% elsif msg1 contains 'okay thanks' or msg2 contains 'okay thanks' or msg3 contains 'okay thanks' %}\n true\n {% elsif msg1 contains 'got it' or msg2 contains 'got it' or msg3 contains 'got it' %}\n true\n {% else %}\n false\n {% endif %}\n{% endif %}`\n }]\n}\n```", @@ -54674,14 +55122,6 @@ "$ref": "#/components/schemas/ToolRejectionPlan" } ] - }, - "function": { - "description": "This is the function definition of the tool.", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAIFunction" - } - ] } } }, @@ -56101,6 +56541,7 @@ "enum": [ "dtmf", "endCall", + "knowledgeBase", "transferCall", "transferCancel", "transferSuccessful", @@ -56380,6 +56821,7 @@ "enum": [ "dtmf", "endCall", + "knowledgeBase", "transferCall", "transferCancel", "transferSuccessful", @@ -56624,6 +57066,7 @@ "enum": [ "dtmf", "endCall", + "knowledgeBase", "transferCall", "transferCancel", "transferSuccessful", @@ -56948,8 +57391,22 @@ "properties": { "file": { "type": "string", - "description": "This is the File you want to upload for use with the Knowledge Base.", + "description": "The file to upload.", "format": "binary" + }, + "purpose": { + "type": "string", + "description": "Optional product flow that owns the uploaded file.", + "enum": [ + "assistant", + "composer-attachment", + "knowledge-base-v2" + ] + }, + "metadata": { + "type": "string", + "description": "Optional JSON-encoded metadata for multipart uploads.", + "maxLength": 4096 } }, "required": [ @@ -57102,6 +57559,182 @@ } } }, + "CreateKnowledgeBaseV2DTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + "description": { + "type": "string", + "nullable": true, + "maxLength": 1000 + } + }, + "required": [ + "name" + ] + }, + "KnowledgeBaseV2": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + "description": { + "type": "string", + "nullable": true, + "maxLength": 1000 + }, + "id": { + "type": "string" + }, + "orgId": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time" + }, + "updatedAt": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "id", + "orgId", + "createdAt", + "updatedAt" + ] + }, + "KnowledgeBaseV2File": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "knowledgeBaseV2Id": { + "type": "string" + }, + "fileId": { + "type": "string" + }, + "fileName": { + "type": "string" + }, + "mimetype": { + "type": "string" + }, + "bytes": { + "type": "number" + }, + "status": { + "type": "string", + "enum": [ + "indexing", + "ready", + "failed" + ] + }, + "createdAt": { + "type": "string", + "format": "date-time" + }, + "updatedAt": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "knowledgeBaseV2Id", + "fileId", + "status", + "createdAt", + "updatedAt" + ] + }, + "AttachKnowledgeBaseV2FileDTO": { + "type": "object", + "properties": { + "fileId": { + "type": "string" + } + }, + "required": [ + "fileId" + ] + }, + "UpdateKnowledgeBaseV2DTO": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + "description": { + "type": "string", + "nullable": true, + "maxLength": 1000 + } + } + }, + "KnowledgeBaseV2WithFiles": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + "description": { + "type": "string", + "nullable": true, + "maxLength": 1000 + }, + "id": { + "type": "string" + }, + "orgId": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time" + }, + "updatedAt": { + "type": "string", + "format": "date-time" + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/KnowledgeBaseV2File" + } + }, + "toolId": { + "type": "string", + "nullable": true, + "description": "Id of the tool that searches this knowledge base (at most one per base; provisioned on creation). Attach it to an assistant via model.toolIds. Null when the base has no search tool yet." + } + }, + "required": [ + "name", + "id", + "orgId", + "createdAt", + "updatedAt", + "files", + "toolId" + ] + }, "StructuredOutputRunResult": { "type": "object", "properties": {