{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "#/components/schemas/ServerMessageKnowledgeBaseRequest", "title": "ServerMessageKnowledgeBaseRequest", "type": "object", "properties": { "phoneNumber": { "description": "This is the phone number that the message is associated with.", "oneOf": [ { "$ref": "#/components/schemas/CreateByoPhoneNumberDTO", "title": "ByoPhoneNumber" }, { "$ref": "#/components/schemas/CreateTwilioPhoneNumberDTO", "title": "TwilioPhoneNumber" }, { "$ref": "#/components/schemas/CreateVonagePhoneNumberDTO", "title": "VonagePhoneNumber" }, { "$ref": "#/components/schemas/CreateVapiPhoneNumberDTO", "title": "VapiPhoneNumber" }, { "$ref": "#/components/schemas/CreateTelnyxPhoneNumberDTO", "title": "TelnyxPhoneNumber" } ] }, "type": { "type": "string", "description": "This is the type of the message. \"knowledge-base-request\" is sent to request knowledge base documents. To enable, use `assistant.knowledgeBase.provider=custom-knowledge-base`.", "enum": [ "knowledge-base-request" ] }, "messages": { "type": "array", "description": "These are the messages that are going to be sent to the `model` right after the `knowledge-base-request` webhook completes.", "items": { "oneOf": [ { "$ref": "#/components/schemas/UserMessage", "title": "UserMessage" }, { "$ref": "#/components/schemas/SystemMessage", "title": "SystemMessage" }, { "$ref": "#/components/schemas/BotMessage", "title": "BotMessage" }, { "$ref": "#/components/schemas/ToolCallMessage", "title": "ToolCallMessage" }, { "$ref": "#/components/schemas/ToolCallResultMessage", "title": "ToolCallResultMessage" } ] } }, "messagesOpenAIFormatted": { "description": "This is just `messages` formatted for OpenAI.", "type": "array", "items": { "$ref": "#/components/schemas/OpenAIMessage" } }, "timestamp": { "type": "number", "description": "This is the timestamp of the message." }, "artifact": { "description": "This is a live version of the `call.artifact`.\n\nThis matches what is stored on `call.artifact` after the call.", "allOf": [ { "$ref": "#/components/schemas/Artifact" } ] }, "assistant": { "description": "This is the assistant that the message is associated with.", "allOf": [ { "$ref": "#/components/schemas/CreateAssistantDTO" } ] }, "customer": { "description": "This is the customer that the message is associated with.", "allOf": [ { "$ref": "#/components/schemas/CreateCustomerDTO" } ] }, "call": { "description": "This is the call that the message is associated with.", "allOf": [ { "$ref": "#/components/schemas/Call" } ] }, "chat": { "description": "This is the chat object.", "allOf": [ { "$ref": "#/components/schemas/Chat" } ] } }, "required": [ "type", "messagesOpenAIFormatted" ] }