Allows loading from an advanced documents source.
This is similar to an upload source, but requires setting example queries
for each document. When a similar query is issued, the document will be
returned in its entirety.
Show child attributes
Response
200 - application/json
A source of documents for building a corpus. A source defines where documents
are pulled from.
Allows loading from an advanced documents source.
This is similar to an upload source, but requires setting example queries
for each document. When a similar query is issued, the document will be
returned in its entirety.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Ultravox Docs","colors":{"primary":"#5E92FF","light":"#FBFBFB","dark":"#5E92FF"},"logo":{"light":"https://mintcdn.com/fixie-ff99b187/cH2M6xBt2fvtSCh3/images/UV%20Logo%20Horizontal%20Black.svg?fit=max\u0026auto=format\u0026n=cH2M6xBt2fvtSCh3\u0026q=85\u0026s=5eccb0a0c1b64983c2047f655e60aceb","dark":"https://mintcdn.com/fixie-ff99b187/cH2M6xBt2fvtSCh3/images/UV%20Logo%20Horizontal%20White.svg?fit=max\u0026auto=format\u0026n=cH2M6xBt2fvtSCh3\u0026q=85\u0026s=18734dbcb147cdb1bcfd5349f4c0f2dd"},"favicon":"https://mintcdn.com/fixie-ff99b187/cH2M6xBt2fvtSCh3/favicon.svg?fit=max\u0026auto=format\u0026n=cH2M6xBt2fvtSCh3\u0026q=85\u0026s=ff1442c06ee968ef7f32ce37590ca6a6","api":{"openapi":"https://api.ultravox.ai/api/schema/","playground":{"display":"interactive"},"mdx":{"auth":{"method":"key","name":"X-API-Key"},"server":"https://api.ultravox.ai/api/"}},"background":{"decoration":"grid"},"navbar":{"links":[{"href":"https://discord.gg/62X253zeWB","label":"Community"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.ultravox.ai?utm_source=docs"}},"footer":{"socials":{"discord":"https://discord.gg/62X253zeWB","github":"https://github.com/fixie-ai/ultravox","x":"https://x.com/fixieai"}},"fonts":{"heading":{"family":"Inter"},"body":{"family":"Inter"}},"integrations":{"gtm":{"tagId":"GTM-NC5RGFMZ"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"fixie-ff99b187","hasAudioNarration":false,"actualSubdomain":"fixie-ff99b187","customDomains":["docs.ultravox.ai"],"gitSource":{"type":"github","owner":"fixie-ai","repo":"ultradox","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aeab08069fda1238797efff","collectionId":"ac033230-01a2-4df8-ba11-3df790aa37a0","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aeab08069fda1238797efff"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aed45ec40440ff6e43c51bd","clientVersion":"0.0.4074","searchFilterCounts":[{"language":"default","tag":"API Reference","count":107},{"language":"default","tag":"Documentation","count":62},{"language":"default","tag":"Telephony","count":27},{"language":"default","tag":"Tools","count":22},{"language":"default","tag":"Calls, Messages, Stages","count":18},{"language":"default","tag":"Getting Started","count":16},{"language":"default","tag":"Corpora, Query, Sources","count":15},{"language":"default","tag":"Agents","count":14},{"language":"default","tag":"Voices","count":11},{"language":"default","tag":"Webhooks","count":10}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"a{color:#005e99;text-decoration:none;transition:color 0.2s ease-in-out}a:hover{color:#7cc8ec}dark a{color:#7cc8ec}.dark a:hover{color:#0077be}"}],"page":{"pagePath":"api-reference/corpora/corpora-sources-patch","slug":"/api-reference/corpora/corpora-sources-patch","pageMetadata":{"openapi":"patch /api/corpora/{corpus_id}/sources/{source_id}","title":"Update Corpus Source","description":"Updates the specified source","href":"/api-reference/corpora/corpora-sources-patch"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Updates the specified source\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components};return _jsx(_components.p,{children:`Allows partial updates to the source.`})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"patch /api/corpora/{corpus_id}/sources/{source_id}","title":"Update Corpus Source","description":"Updates the specified source","href":"/api-reference/corpora/corpora-sources-patch"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"corpora_sources_partial_update","parameters":["a637e2a7-5145-4b34-b261-5a31ddd6addf","d4e061fd-9f72-4a93-afc6-1bdef55b5e12"],"tags":["corpora"],"requestBody":"17cbbd2f-a1ea-4b41-8f80-2710853d7a0c","security":["274fe39f-e0ad-43ad-bde2-acb0d4b6192a"],"responses":{"200":"a8d14f69-db76-40c9-b7ac-9b5636d03b2a"},"method":"patch","type":"path","servers":["0bcd1a41-6f91-4ff8-b293-25208d233574"],"path":"/api/corpora/{corpus_id}/sources/{source_id}","baseUrlOptions":["https://api.ultravox.ai"],"title":"","description":"Updates the specified source","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"a637e2a7-5145-4b34-b261-5a31ddd6addf":{"in":"path","name":"corpus_id","schema":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"},"required":true},"d4e061fd-9f72-4a93-afc6-1bdef55b5e12":{"in":"path","name":"source_id","schema":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"},"required":true}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"corpusId":{"type":"string","description":"The id of this source's corpus.","uniqueKey":"corpusId","typeLabel":"string"},"sourceId":{"type":"string","description":"The unique ID of this source.","uniqueKey":"sourceId","typeLabel":"string"},"created":{"type":"string","description":"When this source was created.","format":"date-time","uniqueKey":"created","typeLabel":"string\u003cdate-time>"},"name":{"type":"string","description":"The name of this source.","uniqueKey":"name","typeLabel":"string"},"description":{"type":"string","description":"A description of this source.","uniqueKey":"description","typeLabel":"string"},"stats":{"type":"object","description":"The current stats for this source.","properties":{"status":{"enum":["SOURCE_STATUS_UNSPECIFIED","SOURCE_STATUS_INITIALIZING","SOURCE_STATUS_READY","SOURCE_STATUS_UPDATING"],"type":"string","description":"The current status of this source, indicating whether it affects queries.","format":"enum","uniqueKey":"stats.status","typeLabel":"enum\u003cstring>"},"lastUpdated":{"type":"string","description":"When this source last finished contributing contents to its corpus.","format":"date-time","uniqueKey":"stats.lastUpdated","typeLabel":"string\u003cdate-time>"},"numDocs":{"type":"integer","description":"The number of documents in this source. This includes both loaded documents\n and derived documents.","format":"int32","uniqueKey":"stats.numDocs","typeLabel":"integer\u003cint32>"}},"uniqueKey":"stats","typeLabel":"object"},"loadSpec":{"type":"object","description":"DEPRECATED. Prefer setting crawl instead. If either crawl or upload is set, this field will be ignored.","properties":{"maxDocuments":{"type":"integer","description":"The maximum number of documents to ingest.","format":"int32","uniqueKey":"loadSpec.maxDocuments","typeLabel":"integer\u003cint32>"},"maxDocumentBytes":{"type":"integer","description":"The maximum size of an individual document in bytes.","format":"int32","uniqueKey":"loadSpec.maxDocumentBytes","typeLabel":"integer\u003cint32>"},"relevantDocumentTypes":{"type":"object","description":"The types of documents to keep. Any documents surfaced during loading\n that don't match this filter will be discarded. If not set, Ultravox will\n choose a default that includes types known to provide real value.","properties":{"include":{"type":"object","description":"Mime types must be in this set to be kept.","properties":{"mimeTypes":{"type":"array","items":{"type":"string","uniqueKey":"loadSpec.relevantDocumentTypes.include.mimeTypes.items.[INDEX]","typeLabel":"string"},"description":"The mime types in this set.","uniqueKey":"loadSpec.relevantDocumentTypes.include.mimeTypes","typeLabel":"string[]"}},"uniqueKey":"loadSpec.relevantDocumentTypes.include","typeLabel":"object"},"exclude":{"type":"object","description":"Mime types must not be in this set to be kept.","properties":{"mimeTypes":{"type":"array","items":{"type":"string","uniqueKey":"loadSpec.relevantDocumentTypes.exclude.mimeTypes.items.[INDEX]","typeLabel":"string"},"description":"The mime types in this set.","uniqueKey":"loadSpec.relevantDocumentTypes.exclude.mimeTypes","typeLabel":"string[]"}},"uniqueKey":"loadSpec.relevantDocumentTypes.exclude","typeLabel":"object"}},"uniqueKey":"loadSpec.relevantDocumentTypes","typeLabel":"object"},"startUrls":{"type":"array","items":{"type":"string","uniqueKey":"loadSpec.startUrls.items.[INDEX]","typeLabel":"string"},"description":"The list of start URLs for crawling. If max_depth is 1, only these URLs will\n be fetched. Otherwise, links from these urls will be followed up to the\n max_depth.","uniqueKey":"loadSpec.startUrls","typeLabel":"string[]"},"maxDepth":{"type":"integer","description":"The maximum depth of links to traverse. Use 1 to only fetch the startUrls,\n 2 to fetch the startUrls and documents directly linked from them, 3 to\n additionally fetch documents linked from those (excluding anything already\n seen), etc.","format":"int32","uniqueKey":"loadSpec.maxDepth","typeLabel":"integer\u003cint32>"}},"uniqueKey":"loadSpec","typeLabel":"object"},"crawl":{"type":"object","description":"Allows loading documents by crawling the web.","properties":{"maxDocuments":{"type":"integer","description":"The maximum number of documents to ingest.","format":"int32","uniqueKey":"crawl.maxDocuments","typeLabel":"integer\u003cint32>"},"maxDocumentBytes":{"type":"integer","description":"The maximum size of an individual document in bytes.","format":"int32","uniqueKey":"crawl.maxDocumentBytes","typeLabel":"integer\u003cint32>"},"relevantDocumentTypes":{"type":"object","description":"The types of documents to keep. Any documents surfaced during loading\n that don't match this filter will be discarded. If not set, Ultravox will\n choose a default that includes types known to provide real value.","properties":{"include":{"type":"object","description":"Mime types must be in this set to be kept.","properties":{"mimeTypes":{"type":"array","items":{"type":"string","uniqueKey":"crawl.relevantDocumentTypes.include.mimeTypes.items.[INDEX]","typeLabel":"string"},"description":"The mime types in this set.","uniqueKey":"crawl.relevantDocumentTypes.include.mimeTypes","typeLabel":"string[]"}},"uniqueKey":"crawl.relevantDocumentTypes.include","typeLabel":"object"},"exclude":{"type":"object","description":"Mime types must not be in this set to be kept.","properties":{"mimeTypes":{"type":"array","items":{"type":"string","uniqueKey":"crawl.relevantDocumentTypes.exclude.mimeTypes.items.[INDEX]","typeLabel":"string"},"description":"The mime types in this set.","uniqueKey":"crawl.relevantDocumentTypes.exclude.mimeTypes","typeLabel":"string[]"}},"uniqueKey":"crawl.relevantDocumentTypes.exclude","typeLabel":"object"}},"uniqueKey":"crawl.relevantDocumentTypes","typeLabel":"object"},"startUrls":{"type":"array","items":{"type":"string","uniqueKey":"crawl.startUrls.items.[INDEX]","typeLabel":"string"},"description":"The list of start URLs for crawling. If max_depth is 1, only these URLs will\n be fetched. Otherwise, links from these urls will be followed up to the\n max_depth.","uniqueKey":"crawl.startUrls","typeLabel":"string[]"},"maxDepth":{"type":"integer","description":"The maximum depth of links to traverse. Use 1 to only fetch the startUrls,\n 2 to fetch the startUrls and documents directly linked from them, 3 to\n additionally fetch documents linked from those (excluding anything already\n seen), etc.","format":"int32","uniqueKey":"crawl.maxDepth","typeLabel":"integer\u003cint32>"}},"uniqueKey":"crawl","typeLabel":"object"},"upload":{"type":"object","description":"Allows loading from a uploaded document.","properties":{"documentIds":{"type":"array","items":{"type":"string","uniqueKey":"upload.documentIds.items.[INDEX]","typeLabel":"string"},"description":"The IDs of uploaded documents. These documents must\n have been previously uploaded using the document upload API.","uniqueKey":"upload.documentIds","typeLabel":"string[]"}},"uniqueKey":"upload","typeLabel":"object"},"advanced":{"type":"object","description":"Allows loading from an advanced documents source.\n This is similar to an upload source, but requires setting example queries\n for each document. When a similar query is issued, the document will be\n returned in its entirety.","properties":{"documents":{"type":"array","items":{"type":"object","properties":{"documentId":{"type":"string","description":"The unique ID of the document.","uniqueKey":"advanced.documents.items.[INDEX].documentId","typeLabel":"string"},"exampleQueries":{"type":"array","items":{"type":"string","uniqueKey":"advanced.documents.items.[INDEX].exampleQueries.items.[INDEX]","typeLabel":"string"},"description":"Example queries for this document. These queries will be embedded\n instead of the document content.\n Up to 10 queries may be provided for a document. Each query must be\n non-empty after stripping whitespace, and at most 400 characters.","uniqueKey":"advanced.documents.items.[INDEX].exampleQueries","typeLabel":"string[]"}},"description":"Details about a single document. The document will be treated as\n a single chunk and only the provided example queries will be embedded.\n On query, matching vectors return the full document content.","uniqueKey":"advanced.documents.items.[INDEX]","typeLabel":"object"},"description":"The list of documents to include in this source.","uniqueKey":"advanced.documents","typeLabel":"object[]"}},"uniqueKey":"advanced","typeLabel":"object"}},"description":"A source of documents for building a corpus. A source defines where documents\n are pulled from.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"corpusId":"\u003cstring>","sourceId":"\u003cstring>","created":"2023-11-07T05:31:56Z","name":"\u003cstring>","description":"\u003cstring>","stats":{"lastUpdated":"2023-11-07T05:31:56Z","numDocs":123},"loadSpec":{"maxDocuments":123,"maxDocumentBytes":123,"relevantDocumentTypes":{"include":{"mimeTypes":["\u003cstring>"]},"exclude":{"mimeTypes":["\u003cstring>"]}},"startUrls":["\u003cstring>"],"maxDepth":123},"crawl":{"maxDocuments":123,"maxDocumentBytes":123,"relevantDocumentTypes":{"include":{"mimeTypes":["\u003cstring>"]},"exclude":{"mimeTypes":["\u003cstring>"]}},"startUrls":["\u003cstring>"],"maxDepth":123},"upload":{"documentIds":["\u003cstring>"]},"advanced":{"documents":[{"documentId":"\u003cstring>","exampleQueries":["\u003cstring>"]}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"a8d14f69-db76-40c9-b7ac-9b5636d03b2a":{"content":{"application/json":{"schema":{"type":"object","properties":{"corpusId":{"type":"string","description":"The id of this source's corpus.","uniqueKey":"corpusId","typeLabel":"string"},"sourceId":{"type":"string","description":"The unique ID of this source.","uniqueKey":"sourceId","typeLabel":"string"},"created":{"type":"string","description":"When this source was created.","format":"date-time","uniqueKey":"created","typeLabel":"string\u003cdate-time>"},"name":{"type":"string","description":"The name of this source.","uniqueKey":"name","typeLabel":"string"},"description":{"type":"string","description":"A description of this source.","uniqueKey":"description","typeLabel":"string"},"stats":{"type":"object","description":"The current stats for this source.","properties":{"status":{"enum":["SOURCE_STATUS_UNSPECIFIED","SOURCE_STATUS_INITIALIZING","SOURCE_STATUS_READY","SOURCE_STATUS_UPDATING"],"type":"string","description":"The current status of this source, indicating whether it affects queries.","format":"enum","uniqueKey":"stats.status","typeLabel":"enum\u003cstring>"},"lastUpdated":{"type":"string","description":"When this source last finished contributing contents to its corpus.","format":"date-time","uniqueKey":"stats.lastUpdated","typeLabel":"string\u003cdate-time>"},"numDocs":{"type":"integer","description":"The number of documents in this source. This includes both loaded documents\n and derived documents.","format":"int32","uniqueKey":"stats.numDocs","typeLabel":"integer\u003cint32>"}},"uniqueKey":"stats","typeLabel":"object"},"loadSpec":{"type":"object","description":"DEPRECATED. Prefer setting crawl instead. If either crawl or upload is set, this field will be ignored.","properties":{"maxDocuments":{"type":"integer","description":"The maximum number of documents to ingest.","format":"int32","uniqueKey":"loadSpec.maxDocuments","typeLabel":"integer\u003cint32>"},"maxDocumentBytes":{"type":"integer","description":"The maximum size of an individual document in bytes.","format":"int32","uniqueKey":"loadSpec.maxDocumentBytes","typeLabel":"integer\u003cint32>"},"relevantDocumentTypes":{"type":"object","description":"The types of documents to keep. Any documents surfaced during loading\n that don't match this filter will be discarded. If not set, Ultravox will\n choose a default that includes types known to provide real value.","properties":{"include":{"type":"object","description":"Mime types must be in this set to be kept.","properties":{"mimeTypes":{"type":"array","items":{"type":"string","uniqueKey":"loadSpec.relevantDocumentTypes.include.mimeTypes.items.[INDEX]","typeLabel":"string"},"description":"The mime types in this set.","uniqueKey":"loadSpec.relevantDocumentTypes.include.mimeTypes","typeLabel":"string[]"}},"uniqueKey":"loadSpec.relevantDocumentTypes.include","typeLabel":"object"},"exclude":{"type":"object","description":"Mime types must not be in this set to be kept.","properties":{"mimeTypes":{"type":"array","items":{"type":"string","uniqueKey":"loadSpec.relevantDocumentTypes.exclude.mimeTypes.items.[INDEX]","typeLabel":"string"},"description":"The mime types in this set.","uniqueKey":"loadSpec.relevantDocumentTypes.exclude.mimeTypes","typeLabel":"string[]"}},"uniqueKey":"loadSpec.relevantDocumentTypes.exclude","typeLabel":"object"}},"uniqueKey":"loadSpec.relevantDocumentTypes","typeLabel":"object"},"startUrls":{"type":"array","items":{"type":"string","uniqueKey":"loadSpec.startUrls.items.[INDEX]","typeLabel":"string"},"description":"The list of start URLs for crawling. If max_depth is 1, only these URLs will\n be fetched. Otherwise, links from these urls will be followed up to the\n max_depth.","uniqueKey":"loadSpec.startUrls","typeLabel":"string[]"},"maxDepth":{"type":"integer","description":"The maximum depth of links to traverse. Use 1 to only fetch the startUrls,\n 2 to fetch the startUrls and documents directly linked from them, 3 to\n additionally fetch documents linked from those (excluding anything already\n seen), etc.","format":"int32","uniqueKey":"loadSpec.maxDepth","typeLabel":"integer\u003cint32>"}},"uniqueKey":"loadSpec","typeLabel":"object"},"crawl":{"type":"object","description":"Allows loading documents by crawling the web.","properties":{"maxDocuments":{"type":"integer","description":"The maximum number of documents to ingest.","format":"int32","uniqueKey":"crawl.maxDocuments","typeLabel":"integer\u003cint32>"},"maxDocumentBytes":{"type":"integer","description":"The maximum size of an individual document in bytes.","format":"int32","uniqueKey":"crawl.maxDocumentBytes","typeLabel":"integer\u003cint32>"},"relevantDocumentTypes":{"type":"object","description":"The types of documents to keep. Any documents surfaced during loading\n that don't match this filter will be discarded. If not set, Ultravox will\n choose a default that includes types known to provide real value.","properties":{"include":{"type":"object","description":"Mime types must be in this set to be kept.","properties":{"mimeTypes":{"type":"array","items":{"type":"string","uniqueKey":"crawl.relevantDocumentTypes.include.mimeTypes.items.[INDEX]","typeLabel":"string"},"description":"The mime types in this set.","uniqueKey":"crawl.relevantDocumentTypes.include.mimeTypes","typeLabel":"string[]"}},"uniqueKey":"crawl.relevantDocumentTypes.include","typeLabel":"object"},"exclude":{"type":"object","description":"Mime types must not be in this set to be kept.","properties":{"mimeTypes":{"type":"array","items":{"type":"string","uniqueKey":"crawl.relevantDocumentTypes.exclude.mimeTypes.items.[INDEX]","typeLabel":"string"},"description":"The mime types in this set.","uniqueKey":"crawl.relevantDocumentTypes.exclude.mimeTypes","typeLabel":"string[]"}},"uniqueKey":"crawl.relevantDocumentTypes.exclude","typeLabel":"object"}},"uniqueKey":"crawl.relevantDocumentTypes","typeLabel":"object"},"startUrls":{"type":"array","items":{"type":"string","uniqueKey":"crawl.startUrls.items.[INDEX]","typeLabel":"string"},"description":"The list of start URLs for crawling. If max_depth is 1, only these URLs will\n be fetched. Otherwise, links from these urls will be followed up to the\n max_depth.","uniqueKey":"crawl.startUrls","typeLabel":"string[]"},"maxDepth":{"type":"integer","description":"The maximum depth of links to traverse. Use 1 to only fetch the startUrls,\n 2 to fetch the startUrls and documents directly linked from them, 3 to\n additionally fetch documents linked from those (excluding anything already\n seen), etc.","format":"int32","uniqueKey":"crawl.maxDepth","typeLabel":"integer\u003cint32>"}},"uniqueKey":"crawl","typeLabel":"object"},"upload":{"type":"object","description":"Allows loading from a uploaded document.","properties":{"documentIds":{"type":"array","items":{"type":"string","uniqueKey":"upload.documentIds.items.[INDEX]","typeLabel":"string"},"description":"The IDs of uploaded documents. These documents must\n have been previously uploaded using the document upload API.","uniqueKey":"upload.documentIds","typeLabel":"string[]"}},"uniqueKey":"upload","typeLabel":"object"},"advanced":{"type":"object","description":"Allows loading from an advanced documents source.\n This is similar to an upload source, but requires setting example queries\n for each document. When a similar query is issued, the document will be\n returned in its entirety.","properties":{"documents":{"type":"array","items":{"type":"object","properties":{"documentId":{"type":"string","description":"The unique ID of the document.","uniqueKey":"advanced.documents.items.[INDEX].documentId","typeLabel":"string"},"exampleQueries":{"type":"array","items":{"type":"string","uniqueKey":"advanced.documents.items.[INDEX].exampleQueries.items.[INDEX]","typeLabel":"string"},"description":"Example queries for this document. These queries will be embedded\n instead of the document content.\n Up to 10 queries may be provided for a document. Each query must be\n non-empty after stripping whitespace, and at most 400 characters.","uniqueKey":"advanced.documents.items.[INDEX].exampleQueries","typeLabel":"string[]"}},"description":"Details about a single document. The document will be treated as\n a single chunk and only the provided example queries will be embedded.\n On query, matching vectors return the full document content.","uniqueKey":"advanced.documents.items.[INDEX]","typeLabel":"object"},"description":"The list of documents to include in this source.","uniqueKey":"advanced.documents","typeLabel":"object[]"}},"uniqueKey":"advanced","typeLabel":"object"}},"description":"A source of documents for building a corpus. A source defines where documents\n are pulled from.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"corpusId":"\u003cstring>","sourceId":"\u003cstring>","created":"2023-11-07T05:31:56Z","name":"\u003cstring>","description":"\u003cstring>","stats":{"status":"SOURCE_STATUS_UNSPECIFIED","lastUpdated":"2023-11-07T05:31:56Z","numDocs":123},"loadSpec":{"maxDocuments":123,"maxDocumentBytes":123,"relevantDocumentTypes":{"include":{"mimeTypes":["\u003cstring>"]},"exclude":{"mimeTypes":["\u003cstring>"]}},"startUrls":["\u003cstring>"],"maxDepth":123},"crawl":{"maxDocuments":123,"maxDocumentBytes":123,"relevantDocumentTypes":{"include":{"mimeTypes":["\u003cstring>"]},"exclude":{"mimeTypes":["\u003cstring>"]}},"startUrls":["\u003cstring>"],"maxDepth":123},"upload":{"documentIds":["\u003cstring>"]},"advanced":{"documents":[{"documentId":"\u003cstring>","exampleQueries":["\u003cstring>"]}]}}}},"exampleType":"generated"}},"description":"","exampleType":"generated"}},"security":{"274fe39f-e0ad-43ad-bde2-acb0d4b6192a":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key","scopes":[],"schemeName":"apiKeyAuth"}}},"servers":{"0bcd1a41-6f91-4ff8-b293-25208d233574":{"url":"https://api.ultravox.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key","scopes":[],"schemeName":"apiKeyAuth"},"schema":{"title":"X-API-Key","type":"string","description":"API key","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKeyAuth","name":"X-API-Key"}],"title":"apiKeyAuth"}]},"originalFileLocation":"https://api.ultravox.ai/api/schema/"},"subdomain":"fixie-ff99b187","siteName":"Ultravox Docs","title":"Update Corpus Source - Ultravox Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-27T19:44:04.132Z","originalFileLocation":"api-reference/corpora/corpora-sources-patch.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Updates the specified source\">\u003cmeta data-mint-head name=\"application-name\" content=\"Ultravox Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/fixie-ff99b187/RC4kJskBQjAqkbwk/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/fixie-ff99b187/RC4kJskBQjAqkbwk/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/fixie-ff99b187/RC4kJskBQjAqkbwk/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/fixie-ff99b187/RC4kJskBQjAqkbwk/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/fixie-ff99b187/RC4kJskBQjAqkbwk/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/fixie-ff99b187/RC4kJskBQjAqkbwk/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/fixie-ff99b187/RC4kJskBQjAqkbwk/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/fixie-ff99b187/RC4kJskBQjAqkbwk/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/fixie-ff99b187/RC4kJskBQjAqkbwk/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update Corpus Source - Ultravox Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Updates the specified source\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Ultravox Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.ultravox.ai/api-reference/corpora/corpora-sources-patch\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://fixie-ff99b187.mintlify.site/_mintlify/api/og/v2?division=Corpora%2C+Query%2C+Sources\u0026amp;title=Update+Corpus+Source\u0026amp;description=Updates+the+specified+source\u0026amp;theme=bc87cc7f9d3a0dd67baea503\u0026amp;signature=9349bcb091eeb383d2b56c8f904d9c4417df2e396d0aed352964afaa4bc288c8\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update Corpus Source - Ultravox Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Updates the specified source\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://fixie-ff99b187.mintlify.site/_mintlify/api/og/v2?division=Corpora%2C+Query%2C+Sources\u0026amp;title=Update+Corpus+Source\u0026amp;description=Updates+the+specified+source\u0026amp;theme=bc87cc7f9d3a0dd67baea503\u0026amp;signature=9349bcb091eeb383d2b56c8f904d9c4417df2e396d0aed352964afaa4bc288c8\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/fixie-ff99b187/RC4kJskBQjAqkbwk/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Ultravox Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5E92FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.ultravox.ai/api-reference/corpora/corpora-sources-patch\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/corpora/corpora-sources-patch.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.ultravox.ai/#organization\",\"name\":\"Ultravox Docs\",\"url\":\"https://docs.ultravox.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/fixie-ff99b187/cH2M6xBt2fvtSCh3/images/UV%20Logo%20Horizontal%20Black.svg?fit=max\u0026auto=format\u0026n=cH2M6xBt2fvtSCh3\u0026q=85\u0026s=5eccb0a0c1b64983c2047f655e60aceb\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.ultravox.ai#website\",\"name\":\"Ultravox Docs\",\"url\":\"https://docs.ultravox.ai\",\"publisher\":{\"@id\":\"https://docs.ultravox.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.ultravox.ai/api-reference/corpora/corpora-sources-patch#webpage\",\"url\":\"https://docs.ultravox.ai/api-reference/corpora/corpora-sources-patch\",\"name\":\"Update Corpus Source\",\"description\":\"Updates the specified source\",\"dateModified\":\"2026-01-27T19:44:04.132Z\",\"isPartOf\":{\"@id\":\"https://docs.ultravox.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.ultravox.ai/api-reference/corpora/corpora-sources-patch#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.ultravox.ai/api-reference/corpora/corpora-sources-patch#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Corpora, Query, Sources\",\"item\":\"https://docs.ultravox.ai/api-reference/corpora/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update Corpus Source\",\"item\":\"https://docs.ultravox.ai/api-reference/corpora/corpora-sources-patch\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.ultravox.ai/api-reference/corpora/corpora-sources-patch#apireference\",\"headline\":\"Update Corpus Source\",\"name\":\"Update Corpus Source\",\"description\":\"Updates the specified source\",\"url\":\"https://docs.ultravox.ai/api-reference/corpora/corpora-sources-patch\",\"mainEntityOfPage\":{\"@id\":\"https://docs.ultravox.ai/api-reference/corpora/corpora-sources-patch#webpage\"},\"dateModified\":\"2026-01-27T19:44:04.132Z\",\"publisher\":{\"@id\":\"https://docs.ultravox.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.ultravox.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Ultravox Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Ultravox Docs","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/overview"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"Ultravox REST API Overview","href":"/api-reference/introduction"}]},{"group":"Accounts","pages":[{"openapi":"get /api/accounts/me","title":"Get Account","href":"/api-reference/accounts/accounts-me-get"},{"openapi":"get /api/accounts/me/usage/calls","title":"Get Call Usage","href":"/api-reference/accounts/accounts-me-usage-calls-get"},{"openapi":"get /api/accounts/me/usage/concurrency","title":"Get Concurrency Usage","href":"/api-reference/accounts/accounts-me-usage-concurrency-get"},{"openapi":"patch /api/accounts/me/tts_api_keys","title":"Set TTS API keys","href":"/api-reference/accounts/accounts-me-tts-api-keys-partial-update"},{"openapi":"get /api/accounts/me/tts_api_keys","title":"Get Account TTS API Keys","href":"/api-reference/accounts/accounts-me-tts-api-keys-retrieve"}]},{"group":"Agents","pages":[{"openapi":"get /api/agents","title":"List Agents","href":"/api-reference/agents/agents-list"},{"openapi":"post /api/agents","title":"Create Agent","href":"/api-reference/agents/agents-post"},{"openapi":"get /api/agents/{agent_id}","title":"Get Agent","href":"/api-reference/agents/agents-get"},{"openapi":"patch /api/agents/{agent_id}","title":"Update Agent","href":"/api-reference/agents/agents-patch"},{"openapi":"delete /api/agents/{agent_id}","title":"Delete Agent","href":"/api-reference/agents/agents-delete"},{"openapi":"get /api/agents/{agent_id}/calls","title":"List Agent Calls","href":"/api-reference/agents/agents-calls-list"},{"openapi":"post /api/agents/{agent_id}/calls","title":"Create Agent Call","href":"/api-reference/agents/agents-calls-post"},{"group":"Scheduled Call Batches","tag":"NEW","expanded":true,"pages":[{"openapi":"get /api/agents/{agent_id}/scheduled_batches","title":"List Scheduled Call Batches","href":"/api-reference/agents/agents-scheduled-batches-list"},{"openapi":"post /api/agents/{agent_id}/scheduled_batches","title":"Create Scheduled Call Batch","href":"/api-reference/agents/agents-scheduled-batches-post"},{"openapi":"get /api/agents/{agent_id}/scheduled_batches/{batch_id}","title":"Get Scheduled Call Batch","href":"/api-reference/agents/agents-scheduled-batches-get"},{"openapi":"patch /api/agents/{agent_id}/scheduled_batches/{batch_id}","title":"Update Scheduled Call Batch","href":"/api-reference/agents/agents-scheduled-batches-patch"},{"openapi":"delete /api/agents/{agent_id}/scheduled_batches/{batch_id}","title":"Delete Scheduled Call Batch","href":"/api-reference/agents/agents-scheduled-batches-delete"},{"openapi":"get /api/agents/{agent_id}/scheduled_batches/{batch_id}/created_calls","title":"List Scheduled Call Batch Created Calls","href":"/api-reference/agents/agents-scheduled-batches-created-calls-list"},{"openapi":"get /api/agents/{agent_id}/scheduled_batches/{batch_id}/scheduled_calls","title":"List Scheduled Call Batch Scheduled Calls","href":"/api-reference/agents/agents-scheduled-batches-scheduled-calls-list"}]}]},{"group":"Calls, Messages, Stages","pages":[{"title":"Calls Overview","href":"/api-reference/calls/overview"},{"openapi":"get /api/calls","title":"List Calls","href":"/api-reference/calls/calls-list"},{"openapi":"get /api/calls/{call_id}","title":"Get Call","href":"/api-reference/calls/calls-get"},{"openapi":"post /api/calls","title":"Create Call","href":"/api-reference/calls/calls-post"},{"openapi":"delete /api/calls/{call_id}","title":"Delete Call","href":"/api-reference/calls/calls-delete"},{"openapi":"get /api/calls/{call_id}/messages","title":"List Call Messages","href":"/api-reference/calls/calls-messages-list"},{"openapi":"get /api/calls/{call_id}/tools","title":"List Call Tools","href":"/api-reference/calls/calls-tools-list"},{"openapi":"get /api/calls/{call_id}/recording","title":"Get Call Recording","href":"/api-reference/calls/calls-recording-get"},{"openapi":"get /api/calls/{call_id}/stages","title":"List Call Stages","href":"/api-reference/calls/calls-stages-list"},{"openapi":"get /api/calls/{call_id}/stages/{call_stage_id}","title":"Get Call Stage","href":"/api-reference/calls/calls-stages-get"},{"openapi":"get /api/calls/{call_id}/stages/{call_stage_id}/messages","title":"List Call Stage Messages","href":"/api-reference/calls/calls-stages-messages-list"},{"openapi":"get /api/calls/{call_id}/stages/{call_stage_id}/tools","title":"List Call Stage Tools","href":"/api-reference/calls/calls-stages-tools-list"},{"openapi":"get /api/calls/{call_id}/stages/{call_stage_id}/messages/{call_stage_message_index}/audio","title":"Get Call Stage Message Audio","href":"/api-reference/calls/calls-stages-message-audio-get"},{"openapi":"get /api/deleted_calls","title":"List Deleted Calls","href":"/api-reference/calls/calls-deleted-calls-list"},{"openapi":"get /api/deleted_calls/{call_id}","title":"Get Deleted Call","href":"/api-reference/calls/calls-deleted-calls-get"},{"openapi":"get /api/calls/{call_id}/events","title":"List Call Events","href":"/api-reference/calls/calls-events-list"},{"openapi":"get /api/calls/{call_id}/sip_logs","title":"Get Sip Logs for a call","href":"/api-reference/calls/calls-sip-logs-get"},{"openapi":"post /api/calls/{call_id}/send_data_message","title":"Send Data Message to Call","href":"/api-reference/calls/calls-send-data-message-post"}]},{"group":"Corpora, Query, Sources","pages":[{"title":"Corpus Service (RAG) Overview","href":"/api-reference/corpora/overview"},{"openapi":"get /api/corpora","title":"List Corpora","href":"/api-reference/corpora/corpora-list"},{"openapi":"post /api/corpora","title":"Create Corpus","href":"/api-reference/corpora/corpora-post"},{"openapi":"get /api/corpora/{corpus_id}","title":"Get Corpus","href":"/api-reference/corpora/corpora-get"},{"openapi":"patch /api/corpora/{corpus_id}","title":"Update Corpus","href":"/api-reference/corpora/corpora-patch"},{"openapi":"delete /api/corpora/{corpus_id}","title":"Delete Corpus","href":"/api-reference/corpora/corpora-delete"},{"openapi":"post /api/corpora/{corpus_id}/query","title":"Query Corpus","href":"/api-reference/corpora/corpus-query"},{"openapi":"get /api/corpora/{corpus_id}/sources","title":"List Corpus Sources","href":"/api-reference/corpora/corpora-sources-list"},{"openapi":"post /api/corpora/{corpus_id}/sources","title":"Create Corpus Source","href":"/api-reference/corpora/corpora-sources-post"},{"openapi":"get /api/corpora/{corpus_id}/sources/{source_id}","title":"Get Corpus Source","description":"Retrieves details for the specified source","href":"/api-reference/corpora/corpora-sources-get"},{"openapi":"patch /api/corpora/{corpus_id}/sources/{source_id}","title":"Update Corpus Source","href":"/api-reference/corpora/corpora-sources-patch"},{"openapi":"delete /api/corpora/{corpus_id}/sources/{source_id}","title":"Delete Corpus Source","description":"Deletes the specified source","href":"/api-reference/corpora/corpora-sources-delete"},{"openapi":"get /api/corpora/{corpus_id}/sources/{source_id}/documents","title":"List Corpus Source Documents","href":"/api-reference/corpora/corpora-sources-documents-list"},{"openapi":"get /api/corpora/{corpus_id}/sources/{source_id}/documents/{document_id}","title":"Get Corpus Source Document","href":"/api-reference/corpora/corpora-sources-documents-get"},{"openapi":"post /api/corpora/{corpus_id}/uploads","title":"Create Corpus File Upload","href":"/api-reference/corpora/corpora-uploads-post"}]},{"group":"Call Throttles","pages":[{"openapi":"get /api/call_throttles","title":"List Call Throttles","href":"/api-reference/call-throttles/call-throttles-list"},{"openapi":"get /api/call_throttles/{throttle_id}","title":"Get Call Throttle","href":"/api-reference/call-throttles/call-throttles-get"},{"openapi":"post /api/call_throttles","title":"Create Call Throttle","href":"/api-reference/call-throttles/call-throttles-post"},{"openapi":"put /api/call_throttles/{throttle_id}","title":"Update Call Throttle","href":"/api-reference/call-throttles/call-throttles-put"},{"openapi":"patch /api/call_throttles/{throttle_id}","title":"Patch Call Throttle","href":"/api-reference/call-throttles/call-throttles-patch"},{"openapi":"delete /api/call_throttles/{throttle_id}","title":"Delete Call Throttle","href":"/api-reference/call-throttles/call-throttles-delete"}]},{"group":"Tools","pages":[{"openapi":"get /api/tools","title":"List Tools","href":"/api-reference/tools/tools-list"},{"openapi":"get /api/tools/{tool_id}","title":"Get Tool","href":"/api-reference/tools/tools-get"},{"openapi":"post /api/tools","title":"Create Tool","href":"/api-reference/tools/tools-post"},{"openapi":"put /api/tools/{tool_id}","title":"Update Tool","href":"/api-reference/tools/tools-put"},{"openapi":"delete /api/tools/{tool_id}","title":"Delete Tool","href":"/api-reference/tools/tools-delete"},{"openapi":"get /api/tools/{tool_id}/history","title":"Get Tool History","href":"/api-reference/tools/tools-history-get"},{"openapi":"post /api/tools/{tool_id}/test","title":"Test Tool","href":"/api-reference/tools/tools-test-post"}]},{"group":"Voices","pages":[{"openapi":"get /api/voices","title":"List Voices","href":"/api-reference/voices/voices-list"},{"openapi":"get /api/voices/{voice_id}","title":"Get Voice","href":"/api-reference/voices/voices-get"},{"openapi":"post /api/voices","title":"Create (Clone) Voice","playground":"none","href":"/api-reference/voices/voices-post"},{"openapi":"delete /api/voices/{voice_id}","title":"Delete Voice","href":"/api-reference/voices/voices-delete"},{"openapi":"put /api/voices/{voice_id}","title":"Replace Voice","href":"/api-reference/voices/voices-put"},{"openapi":"patch /api/voices/{voice_id}","title":"Update Voice","href":"/api-reference/voices/voices-patch"},{"openapi":"post /api/voice_preview","title":"Preview Voice","href":"/api-reference/voices/voice-preview-post"},{"openapi":"get /api/voices/{voice_id}/preview","title":"Get Voice Sample","href":"/api-reference/voices/voices-preview-get"}]},{"group":"Webhooks","pages":[{"openapi":"get /api/webhooks","title":"List Webhooks","href":"/api-reference/webhooks/webhooks-list"},{"openapi":"get /api/webhooks/{webhook_id}","title":"Get Webhook","href":"/api-reference/webhooks/webhooks-get"},{"openapi":"post /api/webhooks","title":"Create Webhook","href":"/api-reference/webhooks/webhooks-post"},{"openapi":"put /api/webhooks/{webhook_id}","title":"Replace Webhook","href":"/api-reference/webhooks/webhooks-put"},{"openapi":"patch /api/webhooks/{webhook_id}","title":"Update Webhook","href":"/api-reference/webhooks/webhooks-patch"},{"openapi":"delete /api/webhooks/{webhook_id}","title":"Delete Webhook","href":"/api-reference/webhooks/webhooks-delete"}]},{"group":"Telephony","pages":[{"openapi":"get /api/sip","title":"Get Account SIP configuration","href":"/api-reference/sip/sip-get"},{"openapi":"patch /api/sip","title":"Update Account SIP configuration","href":"/api-reference/sip/sip-partial-update"},{"openapi":"post /api/sip/registrations","title":"Create SIP Registration","href":"/api-reference/sip/sip-registrations-create"},{"openapi":"get /api/sip/registrations","title":"List SIP Registrations","href":"/api-reference/sip/sip-registrations-list"},{"openapi":"get /api/sip/registrations/{registration_id}","title":"Get SIP Registration","href":"/api-reference/sip/sip-registrations-get"},{"openapi":"patch /api/sip/registrations/{registration_id}","title":"Update SIP Registration","href":"/api-reference/sip/sip-registrations-partial-update"},{"openapi":"delete /api/sip/registrations/{registration_id}","title":"Delete SIP Registration","href":"/api-reference/sip/sip-registrations-delete"},{"openapi":"get /api/telephony_configs/twilio","title":"Get Twilio Configuration for Account","href":"/api-reference/telephony/twilio-get"},{"openapi":"post /api/telephony_configs/twilio","title":"Create Twilio Configuration for Account","href":"/api-reference/telephony/twilio-post"},{"openapi":"patch /api/telephony_configs/twilio","title":"Update Twilio Configuration for Account","href":"/api-reference/telephony/twilio-patch"},{"openapi":"delete /api/telephony_configs/twilio","title":"Delete Twilio Configuration for Account","href":"/api-reference/telephony/twilio-delete"},{"openapi":"get /api/telephony_configs/telnyx","title":"Get Telnyx Configuration for Account","href":"/api-reference/telephony/telnyx-get"},{"openapi":"post /api/telephony_configs/telnyx","title":"Create Telnyx Configuration for Account","href":"/api-reference/telephony/telnyx-post"},{"openapi":"patch /api/telephony_configs/telnyx","title":"Update Telnyx Configuration for Account","href":"/api-reference/telephony/telnyx-patch"},{"openapi":"delete /api/telephony_configs/telnyx","title":"Delete Telnyx Configuration for Account","href":"/api-reference/telephony/telnyx-delete"},{"openapi":"get /api/telephony_configs/plivo","title":"Get Plivo Configuration for Account","href":"/api-reference/telephony/plivo-get"},{"openapi":"post /api/telephony_configs/plivo","title":"Create Plivo Configuration for Account","href":"/api-reference/telephony/plivo-post"},{"openapi":"patch /api/telephony_configs/plivo","title":"Update Plivo Configuration for Account","href":"/api-reference/telephony/plivo-patch"},{"openapi":"delete /api/telephony_configs/plivo","title":"Delete Plivo Configuration for Account","href":"/api-reference/telephony/plivo-delete"},{"openapi":"patch /api/accounts/me/telephony_config","title":"Set Telephony Credentials","href":"/api-reference/accounts/accounts-me-telephony-config-partial-update"},{"openapi":"get /api/accounts/me/telephony_config","title":"Get Telephony Credentials","href":"/api-reference/accounts/accounts-me-telephony-config-retrieve"}]},{"group":"Schema","pages":[{"title":"Call Definition","href":"/api-reference/schema/call-definition"},{"title":"Base Tool Definition","href":"/api-reference/schema/base-tool-definition"},{"title":"SIP Fallback Handler Response","href":"/api-reference/schema/sip-fallback-handler-response"},{"title":"Ultravox Data Message Protocol","href":"/api-reference/schema/datamessages"}]},{"group":"Other","pages":[{"openapi":"get /api/models","title":"List Models","href":"/api-reference/other/models-get"},{"openapi":"get /api/schema/","title":"Get OpenAPI Schema","href":"/api-reference/other/schema-get"}]}]},{"tab":"SDK Reference","pages":[{"title":"SDK Reference","href":"/sdk-reference/introduction"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/voximplant"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/news"}]}]},"basePath":"","title":"Update Corpus Source - Ultravox Docs","buildId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","deploymentId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-Myd8dsju.js","utils-C2HkQgW0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-8rSppmTv.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B6MjiCFm.js","snippetPresets-DwrSAONL.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-CxAy5y67.js","ApiExamples-1-a5UQKQ.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C541m7wZ.js","shallow-CWELCZ77.js","getApiPlaygroundDisplay-CTo5Zn03.js","CodeSnippet-D--dzvnl.js","CodeSnippets-DM3cXEDh.js","getPastedJson-C-VECgcL.js","icon-BPq2-Mg3.js","MethodPill-D9J5cUHd.js","DuplicateIcon-BqHaxUnD.js","createIcon-CIbcZHp9.js","DynamicMarkdown-BKiHAm_d.js","SectionHeading-DstQXt3H.js","axios-vUo_bRtp.js","Markdown-CpxgzsKA.js","clsx-C5EfhVm0.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CJ9Oly2E.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Mk6P3qvh.js"]}