file_ref accepts either the file’s label or its id.
Authorizations
Authorization
string
header
required
Your API key as a Bearer token, e.g. Authorization: Bearer vk_….
Path Parameters
file_ref
string
required
The file's label or id.
Response
Successful Response
label
string
required
Identifier for this file: its filename slugified, plus a short random suffix. Paste it into an agent's prompt to let that agent send the file. It never changes.
Example:
"autumn-brochure_7bq2xk"
id
string
required
The file's unique id. Either this or the label works wherever a path takes a file reference.
name
string
required
What the file is called in your library. Editable; the label is not.
Example:
"Autumn brochure"
mime_type
string
required
The file's type, read from its contents rather than its name.
Example:
"application/pdf"
kind
string
required
One of image, video, audio or document.
Example:
"document"
size_bytes
integer
required
The file's size in bytes.
Example:
184320
status
string
required
ready when the file can be sent. A file that failed its malware scan is quarantined and holds no contents; a deleted file is deleted.
Example:
"ready"
description
string
default:""
Your note about what the file is for. Agents read it when choosing which file to send.
filename
string
default:""
The file's original name. This is the document name the recipient sees on WhatsApp.
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Vocily","description":"Product documentation for Vocily — the voice \u0026 WhatsApp AI agent platform.","colors":{"primary":"#737373","light":"#FFFFFF","dark":"#111111"},"logo":{"light":"https://mintcdn.com/vocily-ai-3efb182a/1QPLTBdybNjwQZ8w/logo/light.svg?fit=max\u0026auto=format\u0026n=1QPLTBdybNjwQZ8w\u0026q=85\u0026s=50d362b7ed5aa424a1c4608728607066","dark":"https://mintcdn.com/vocily-ai-3efb182a/1QPLTBdybNjwQZ8w/logo/dark.svg?fit=max\u0026auto=format\u0026n=1QPLTBdybNjwQZ8w\u0026q=85\u0026s=a5a771a0d6e80cb6c807d4b6a355f305"},"favicon":"https://mintcdn.com/vocily-ai-3efb182a/WWXZqJaCDv4uEmpO/favicon.svg?fit=max\u0026auto=format\u0026n=WWXZqJaCDv4uEmpO\u0026q=85\u0026s=a19a94ec2eddf8dc7931fc677247f72b","api":{"playground":{"display":"interactive","proxy":true}},"appearance":{"default":"dark","strict":false},"background":{"color":{"light":"#FAFAFA","dark":"#111111"}},"navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://app.vocily.ai/login"}},"footer":{"socials":{"website":"https://www.vocily.ai"}},"search":{"prompt":"Search Vocily docs..."},"icons":{"library":"tabler"},"styling":{"eyebrows":"section","codeblocks":"dark","latex":true},"navigation":{"directory":"card","pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"vocily-ai-3efb182a","hasAudioNarration":false,"actualSubdomain":"vocily-ai-3efb182a","customDomains":["docs.vocily.ai"],"gitSource":{"type":"github","owner":"ayush-voice-ai","repo":"vocily-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6af5ebc53a147584b5ca66a8","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"API Reference","count":66},{"language":"default","tag":"Documentation","count":48},{"language":"default","tag":"Agents","count":16},{"language":"default","tag":"Building Agents","count":15},{"language":"default","tag":"Account \u0026 Workspace","count":8},{"language":"default","tag":"Knowledge Bases","count":8},{"language":"default","tag":"WhatsApp","count":8},{"language":"default","tag":"Custom Analysis","count":7},{"language":"default","tag":"Files","count":7},{"language":"default","tag":"Memory","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"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":"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":"editor-metadata","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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"#search-bar-entry>div:first-child{min-width:0;flex:1 1 auto;overflow:hidden}#search-bar-entry>div:first-child>div{min-width:0;overflow:hidden;text-overflow:ellipsis;white-space:nowrap}#search-bar-entry>span{flex:0 0 auto;margin-left:auto}#chat-assistant-floating-input .chat-assistant-input>div{min-width:0}#chat-assistant-floating-input .chat-assistant-input textarea{width:100%;min-width:0;padding-right:4.5rem}#chat-assistant-floating-input .chat-assistant-input span[class*=\"peer-focus/input:hidden\"]{min-width:max-content;white-space:nowrap;display:inline-flex!important}@media (min-width: 1024px){#navbar div:has(>a>img.nav-logo){flex:0 0 auto}#navbar div:has(>div>div>.nav-tabs){flex:1 1 auto;min-width:0}#navbar div:has(>div>.nav-tabs){margin-left:9rem;margin-right:auto;justify-content:flex-start}#navbar nav[aria-label=\"Main\"]{margin-left:auto}}"}],"page":{"pagePath":"developers/files/get","slug":"/developers/files/get","pageMetadata":{"title":"Get a file","sidebarTitle":"Get a file","description":"One file, by handle or id.","openapi":"developers/openapi.json GET /v1/files/{file_ref}","href":"/developers/files/get"},"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: \"One file, by handle or id.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_components.p,{children:[_jsx(_components.code,{children:`file_ref`}),` accepts either the file’s `,_jsx(_components.code,{children:`label`}),` or its `,_jsx(_components.code,{children:`id`}),`.`]})}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":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Get a file","sidebarTitle":"Get a file","description":"One file, by handle or id.","openapi":"developers/openapi.json GET /v1/files/{file_ref}","href":"/developers/files/get"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["files"],"summary":"Get File","description":"One file, by handle or id.","operationId":"get_file_v1_files__file_ref__get","parameters":["279d6bbf-6ab8-43c2-bd28-bcb4d0d32237"],"responses":{"200":"cb767eb9-0d50-469a-b684-076a18627224","401":"537137b6-e60f-4454-8b0a-d980bae6178f","422":"9719346b-abb6-4ce2-802a-72927d18b958","429":"c6ec1ae2-1651-49c5-880c-f755a00cde3f"},"security":["b5259b34-ff26-4e9d-bcc6-a3be5fef0aa9"],"x-mint":{"metadata":{"playground":"disabled"}},"method":"get","type":"path","servers":["49b9979d-546b-46e9-9a86-091f07e3af14"],"path":"/v1/files/{file_ref}","baseUrlOptions":["https://api.vocily.ai"],"title":"Get File","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"279d6bbf-6ab8-43c2-bd28-bcb4d0d32237":{"name":"file_ref","in":"path","required":true,"schema":{"type":"string","description":"The file's label or id.","title":"File Ref","isRequired":true,"uniqueKey":"","typeLabel":"string"},"description":"The file's label or id."}},"responses":{"cb767eb9-0d50-469a-b684-076a18627224":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"label":{"type":"string","title":"Label","description":"Identifier for this file: its filename slugified, plus a short random suffix. Paste it into an agent's prompt to let that agent send the file. It never changes.","examples":["autumn-brochure_7bq2xk"],"isRequired":true,"uniqueKey":"label","typeLabel":"string"},"id":{"type":"string","title":"Id","description":"The file's unique id. Either this or the label works wherever a path takes a file reference.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"name":{"type":"string","title":"Name","description":"What the file is called in your library. Editable; the label is not.","examples":["Autumn brochure"],"isRequired":true,"uniqueKey":"name","typeLabel":"string"},"mime_type":{"type":"string","title":"Mime Type","description":"The file's type, read from its contents rather than its name.","examples":["application/pdf"],"isRequired":true,"uniqueKey":"mime_type","typeLabel":"string"},"kind":{"type":"string","title":"Kind","description":"One of `image`, `video`, `audio` or `document`.","examples":["document"],"isRequired":true,"uniqueKey":"kind","typeLabel":"string"},"size_bytes":{"type":"integer","title":"Size Bytes","description":"The file's size in bytes.","examples":[184320],"isRequired":true,"uniqueKey":"size_bytes","typeLabel":"integer"},"status":{"type":"string","title":"Status","description":"`ready` when the file can be sent. A file that failed its malware scan is `quarantined` and holds no contents; a deleted file is `deleted`.","examples":["ready"],"isRequired":true,"uniqueKey":"status","typeLabel":"string"},"description":{"type":"string","title":"Description","description":"Your note about what the file is for. Agents read it when choosing which file to send.","default":"","uniqueKey":"description","typeLabel":"string"},"filename":{"type":"string","title":"Filename","description":"The file's original name. This is the document name the recipient sees on WhatsApp.","default":"","examples":["autumn-brochure.pdf"],"uniqueKey":"filename","typeLabel":"string"},"created_at":{"oneOf":[{"type":"string","title":"Created At","description":"When the file was uploaded.","uniqueKey":"created_at.oneOf.0","typeLabel":"string"},{"type":"null","title":"Created At","description":"When the file was uploaded.","uniqueKey":"created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"created_at","typeLabel":"string | null"}},"type":"object","required":["label","id","name","mime_type","kind","size_bytes","status"],"title":"PublicFile","example":{"created_at":"2026-10-16T09:14:02.511Z","description":"Two-page product brochure, updated October.","filename":"autumn-brochure.pdf","id":"8f14e45f-ea1c-4b31-9a2b-7c3d5e6f1a20","kind":"document","label":"autumn-brochure_7bq2xk","mime_type":"application/pdf","name":"Autumn brochure","size_bytes":184320,"status":"ready"},"uniqueKey":"","typeLabel":"PublicFile · object"},"example":{"label":"autumn-brochure_7bq2xk","id":"00000001-0000-4000-8000-000000000001","name":"Autumn brochure","description":"Two-page product brochure, updated October.","filename":"autumn-brochure.pdf","mime_type":"application/pdf","kind":"document","size_bytes":184320,"status":"ready","created_at":"2026-10-16T09:14:02Z"},"examples":{"Example":{"title":"Example","value":{"label":"autumn-brochure_7bq2xk","id":"00000001-0000-4000-8000-000000000001","name":"Autumn brochure","description":"Two-page product brochure, updated October.","filename":"autumn-brochure.pdf","mime_type":"application/pdf","kind":"document","size_bytes":184320,"status":"ready","created_at":"2026-10-16T09:14:02Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"537137b6-e60f-4454-8b0a-d980bae6178f":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"type":"object","description":"Error envelope. `code` is derived from the HTTP status, so branch on it for the CLASS of failure; the specific reason is `detail.code`. Every public refusal carries both.","properties":{"detail":{"type":"object","description":"The reason. `code` is the domain reason (e.g. `call_not_found`) and `message` is a sentence safe to log. On a `422` it also carries `errors[]`, one entry per rejected field — see `HTTPValidationError`.","properties":{"code":{"type":"string","example":"call_not_found","isRequired":true,"uniqueKey":"detail.code","typeLabel":"string"},"message":{"type":"string","example":"Call not found","isRequired":true,"uniqueKey":"detail.message","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"detail","typeLabel":"object"},"code":{"type":"string","description":"Derived from the HTTP status, not the domain reason.","example":"NOT_FOUND","uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"detail":"Invalid API key","code":"UNAUTHORIZED"},"examples":{"Example":{"title":"Example","value":{"detail":"Invalid API key","code":"UNAUTHORIZED"}}},"exampleType":"examples"}},"exampleType":"examples"},"9719346b-abb6-4ce2-802a-72927d18b958":{"description":"Validation Error","content":{"application/json":{"schema":{"type":"object","title":"HTTPValidationError","description":"A request the API could not read: a field of the wrong type, out of range, missing, or one we do not accept. Same envelope as every other error.","properties":{"detail":{"type":"object","description":"What was wrong, as `code`, a one-line `message`, and every offending field in `errors`.","required":["code","message","errors"],"properties":{"code":{"type":"string","enum":["validation_error"],"isRequired":true,"uniqueKey":"detail.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"The first problem in one line, with a count of the rest — e.g. `model.temperature: Input should be less than or equal to 2 (and 1 more)`.","isRequired":true,"uniqueKey":"detail.message","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","title":"ValidationError","required":["field","message","type"],"properties":{"field":{"type":"string","description":"The offending field as a path from the root of your request — `voice.speed`, `variables[0].key`, or `query.limit` for a query parameter. **This is the field to read.**","isRequired":true,"uniqueKey":"detail.errors.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","description":"What is wrong with it, in plain language.","isRequired":true,"uniqueKey":"detail.errors.items.[INDEX].message","typeLabel":"string"},"type":{"type":"string","description":"A stable machine code for the kind of failure, e.g. `extra_forbidden` for a field we do not accept, `missing` for a required one, or `less_than_equal` for a number out of range. Switch on this rather than on `message`, which may be reworded.","isRequired":true,"uniqueKey":"detail.errors.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"detail.errors.items.[INDEX]","typeLabel":"ValidationError · object"},"description":"One entry per offending field. **Every problem is reported at once**, not just the first, so a malformed body needs one round trip to fix rather than one per field.","isRequired":true,"uniqueKey":"detail.errors","typeLabel":"ValidationError · object[]"}},"uniqueKey":"detail","typeLabel":"object"},"code":{"type":"string","enum":["VALIDATION_ERROR"],"description":"Derived from the HTTP status, as on every error.","uniqueKey":"code","typeLabel":"enum\u003cstring>"}},"uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":{"code":"validation_error","message":"\u003cstring>","errors":[{"field":"\u003cstring>","message":"\u003cstring>","type":"\u003cstring>"}]},"code":"VALIDATION_ERROR"}}},"exampleType":"generated"}},"exampleType":"generated"},"c6ec1ae2-1651-49c5-880c-f755a00cde3f":{"description":"Rate limit exceeded — honor `Retry-After`.","content":{"application/json":{"schema":{"type":"object","description":"Error envelope. `code` is derived from the HTTP status, so branch on it for the CLASS of failure; the specific reason is `detail.code`. Every public refusal carries both.","properties":{"detail":{"type":"object","description":"The reason. `code` is the domain reason (e.g. `call_not_found`) and `message` is a sentence safe to log. On a `422` it also carries `errors[]`, one entry per rejected field — see `HTTPValidationError`.","properties":{"code":{"type":"string","example":"call_not_found","isRequired":true,"uniqueKey":"detail.code","typeLabel":"string"},"message":{"type":"string","example":"Call not found","isRequired":true,"uniqueKey":"detail.message","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"detail","typeLabel":"object"},"code":{"type":"string","description":"Derived from the HTTP status, not the domain reason.","example":"NOT_FOUND","uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"code":"rate_limited"},"examples":{"Example":{"title":"Example","value":{"code":"rate_limited"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"b5259b34-ff26-4e9d-bcc6-a3be5fef0aa9":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Your API key as a Bearer token, e.g. `Authorization: Bearer vk_…`.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"49b9979d-546b-46e9-9a86-091f07e3af14":{"url":"https://api.vocily.ai","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Your API key as a Bearer token, e.g. `Authorization: Bearer vk_…`.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your API key as a Bearer token, e.g. `Authorization: Bearer vk_…`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"developers/openapi.json"},"subdomain":"vocily-ai-3efb182a","siteName":"Vocily","title":"Get a file - Vocily","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-31T16:55:24.737Z","originalFileLocation":"developers/files/get.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=\"dark\"}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=\"One file, by handle or id.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Vocily\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/vocily-ai-3efb182a/2Zv3y20qo7JA0-AR/_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/vocily-ai-3efb182a/2Zv3y20qo7JA0-AR/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/vocily-ai-3efb182a/2Zv3y20qo7JA0-AR/_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/vocily-ai-3efb182a/2Zv3y20qo7JA0-AR/_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/vocily-ai-3efb182a/2Zv3y20qo7JA0-AR/_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/vocily-ai-3efb182a/2Zv3y20qo7JA0-AR/_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/vocily-ai-3efb182a/2Zv3y20qo7JA0-AR/_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/vocily-ai-3efb182a/2Zv3y20qo7JA0-AR/_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/vocily-ai-3efb182a/2Zv3y20qo7JA0-AR/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a file - Vocily\">\u003cmeta data-mint-head property=\"og:description\" content=\"One file, by handle or id.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Vocily\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.vocily.ai/developers/files/get\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://vocily-ai-3efb182a.mintlify.site/_mintlify/api/og/v2?division=Files\u0026amp;title=Get+a+file\u0026amp;description=One+file%2C+by+handle+or+id.\u0026amp;theme=4b342937fb5124a54e38022b\u0026amp;signature=21977c6d7e67e7fbd595a75d6e1fbe88b3c574bc8a5c578df9227d0d381d52bb\">\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=\"Get a file - Vocily\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"One file, by handle or id.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://vocily-ai-3efb182a.mintlify.site/_mintlify/api/og/v2?division=Files\u0026amp;title=Get+a+file\u0026amp;description=One+file%2C+by+handle+or+id.\u0026amp;theme=4b342937fb5124a54e38022b\u0026amp;signature=21977c6d7e67e7fbd595a75d6e1fbe88b3c574bc8a5c578df9227d0d381d52bb\">\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/vocily-ai-3efb182a/2Zv3y20qo7JA0-AR/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Vocily\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#737373\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.vocily.ai/developers/files/get\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/developers/files/get.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.vocily.ai/#organization\",\"name\":\"Vocily\",\"url\":\"https://docs.vocily.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/vocily-ai-3efb182a/1QPLTBdybNjwQZ8w/logo/light.svg?fit=max\u0026auto=format\u0026n=1QPLTBdybNjwQZ8w\u0026q=85\u0026s=50d362b7ed5aa424a1c4608728607066\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.vocily.ai#website\",\"name\":\"Vocily\",\"url\":\"https://docs.vocily.ai\",\"publisher\":{\"@id\":\"https://docs.vocily.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.vocily.ai/developers/files/get#webpage\",\"url\":\"https://docs.vocily.ai/developers/files/get\",\"name\":\"Get a file\",\"description\":\"One file, by handle or id.\",\"dateModified\":\"2026-10-31T16:55:24.737Z\",\"isPartOf\":{\"@id\":\"https://docs.vocily.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.vocily.ai/developers/files/get#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.vocily.ai/developers/files/get#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Files\",\"item\":\"https://docs.vocily.ai/developers/files/list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get a file\",\"item\":\"https://docs.vocily.ai/developers/files/get\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.vocily.ai/developers/files/get#apireference\",\"headline\":\"Get a file\",\"name\":\"Get a file\",\"description\":\"One file, by handle or id.\",\"url\":\"https://docs.vocily.ai/developers/files/get\",\"mainEntityOfPage\":{\"@id\":\"https://docs.vocily.ai/developers/files/get#webpage\"},\"dateModified\":\"2026-10-31T16:55:24.737Z\",\"publisher\":{\"@id\":\"https://docs.vocily.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.vocily.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Vocily\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Vocily\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/developers/files/get.md","siteName":"Vocily","nav":{"global":null,"directory":"card","tabs":[{"tab":"Documentation","icon":"book","align":"start","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","icon":"code","align":"start","pages":[{"title":"API Reference","sidebarTitle":"Introduction","href":"/developers/api-reference"},{"title":"API changes","sidebarTitle":"Changes","href":"/developers/changes"},{"group":"Calls","icon":"phone","pages":[{"title":"Place a call","sidebarTitle":"Place a call","openapi":"developers/openapi.json POST /v1/calls","href":"/developers/calls/create"},{"title":"List calls","sidebarTitle":"List calls","openapi":"developers/openapi.json GET /v1/calls","href":"/developers/calls/list"},{"title":"Get a call","sidebarTitle":"Get a call","openapi":"developers/openapi.json GET /v1/calls/{call_id}","href":"/developers/calls/get"},{"title":"Get a recording","sidebarTitle":"Get a recording","openapi":"developers/openapi.json GET /v1/calls/{call_id}/recording","href":"/developers/calls/recording"}]},{"group":"Chats","icon":"message-circle","pages":[{"title":"List chats","sidebarTitle":"List chats","openapi":"developers/openapi.json GET /v1/chats","href":"/developers/chats/list"},{"title":"Get a chat","sidebarTitle":"Get a chat","openapi":"developers/openapi.json GET /v1/chats/{chat_id}","href":"/developers/chats/get"}]},{"group":"Phone Numbers","icon":"phone","pages":[{"title":"List phone numbers","sidebarTitle":"List phone numbers","openapi":"developers/openapi.json GET /v1/numbers","href":"/developers/numbers/list"}]},{"group":"Knowledge Bases","icon":"book-open","pages":[{"title":"Create a knowledge base","sidebarTitle":"Create","openapi":"developers/openapi.json POST /v1/knowledge-bases","href":"/developers/knowledge-bases/create"},{"title":"List knowledge bases","sidebarTitle":"List knowledge bases","openapi":"developers/openapi.json GET /v1/knowledge-bases","href":"/developers/knowledge-bases/list"},{"title":"Get a knowledge base","sidebarTitle":"Get a knowledge base","openapi":"developers/openapi.json GET /v1/knowledge-bases/{kb_id}","href":"/developers/knowledge-bases/get"},{"title":"Update a knowledge base","sidebarTitle":"Update","openapi":"developers/openapi.json PATCH /v1/knowledge-bases/{kb_id}","href":"/developers/knowledge-bases/update"},{"title":"Delete a knowledge base","sidebarTitle":"Delete a knowledge base","openapi":"developers/openapi.json DELETE /v1/knowledge-bases/{kb_id}","href":"/developers/knowledge-bases/delete"},{"title":"Add a document","sidebarTitle":"Add a document","openapi":"developers/openapi.json POST /v1/knowledge-bases/{kb_id}/documents","href":"/developers/knowledge-bases/add-document"},{"title":"Delete a document","sidebarTitle":"Delete a document","openapi":"developers/openapi.json DELETE /v1/knowledge-bases/{kb_id}/documents/{doc_id}","href":"/developers/knowledge-bases/delete-document"},{"title":"Reindex a document","sidebarTitle":"Reindex","openapi":"developers/openapi.json POST /v1/knowledge-bases/{kb_id}/documents/{doc_id}/reindex","href":"/developers/knowledge-bases/reindex-document"}]},{"group":"Files","icon":"file-text","pages":[{"title":"List files","sidebarTitle":"List files","openapi":"developers/openapi.json GET /v1/files","href":"/developers/files/list"},{"title":"Upload a file","sidebarTitle":"Upload a file","openapi":"developers/openapi.json POST /v1/files","href":"/developers/files/upload"},{"title":"File limits","sidebarTitle":"Limits","description":"What can be uploaded, and how large.","openapi":"developers/openapi.json GET /v1/files/limits","href":"/developers/files/limits"},{"title":"Get a file","sidebarTitle":"Get a file","openapi":"developers/openapi.json GET /v1/files/{file_ref}","href":"/developers/files/get"},{"title":"Update a file","sidebarTitle":"Update a file","description":"Rename a file or change its description.","openapi":"developers/openapi.json PATCH /v1/files/{file_ref}","href":"/developers/files/update"},{"title":"Get a download link","sidebarTitle":"Download link","openapi":"developers/openapi.json GET /v1/files/{file_ref}/download-url","href":"/developers/files/download-url"},{"title":"Delete a file","sidebarTitle":"Delete a file","openapi":"developers/openapi.json DELETE /v1/files/{file_ref}","href":"/developers/files/delete"}]},{"group":"Agents","icon":"robot","pages":[{"title":"List agents","sidebarTitle":"List agents","openapi":"developers/openapi.json GET /v1/agents","href":"/developers/agents/list"},{"title":"Create an agent","sidebarTitle":"Create","openapi":"developers/openapi.json POST /v1/agents","href":"/developers/agents/create"},{"title":"Get an agent","sidebarTitle":"Get","openapi":"developers/openapi.json GET /v1/agents/{agent_id}","href":"/developers/agents/get"},{"title":"Update an agent","sidebarTitle":"Update","openapi":"developers/openapi.json PATCH /v1/agents/{agent_id}","href":"/developers/agents/update"},{"title":"Backups","sidebarTitle":"Backups","href":"/developers/agents/backups"},{"title":"Delete an agent","sidebarTitle":"Delete","openapi":"developers/openapi.json DELETE /v1/agents/{agent_id}","href":"/developers/agents/delete"},{"title":"List versions","sidebarTitle":"List versions","openapi":"developers/openapi.json GET /v1/agents/{agent_id}/versions","href":"/developers/agents/versions"},{"title":"Get a version","sidebarTitle":"Get version","openapi":"developers/openapi.json GET /v1/agents/{agent_id}/versions/{version_id}","href":"/developers/agents/get-version"},{"title":"Delete a version","sidebarTitle":"Delete version","openapi":"developers/openapi.json DELETE /v1/agents/{agent_id}/versions/{version_id}","href":"/developers/agents/delete-version"},{"title":"Create a draft","sidebarTitle":"Create draft","openapi":"developers/openapi.json POST /v1/agents/{agent_id}/drafts","href":"/developers/agents/create-draft"},{"title":"Publish a version","sidebarTitle":"Publish","openapi":"developers/openapi.json POST /v1/agents/{agent_id}/versions/{version_id}/publish","href":"/developers/agents/publish"},{"title":"Make a version live","sidebarTitle":"Make live","openapi":"developers/openapi.json POST /v1/agents/{agent_id}/versions/{version_id}/make-live","href":"/developers/agents/make-live"},{"title":"Take an agent off air","sidebarTitle":"Take off air","openapi":"developers/openapi.json DELETE /v1/agents/{agent_id}/live","href":"/developers/agents/off-air"},{"title":"Deploy history","sidebarTitle":"Deploy history","openapi":"developers/openapi.json GET /v1/agents/{agent_id}/activations","href":"/developers/agents/activations"},{"title":"Compare two versions","sidebarTitle":"Compare","openapi":"developers/openapi.json GET /v1/agents/{agent_id}/compare","href":"/developers/agents/compare"},{"title":"Variable suggestions","sidebarTitle":"Variable suggestions","openapi":"developers/openapi.json GET /v1/agents/{agent_id}/variable-suggestions","href":"/developers/agents/variable-suggestions"}]},{"group":"Speech","icon":"waveform","pages":[{"title":"Synthesize speech","sidebarTitle":"Synthesize","openapi":"developers/openapi.json POST /v1/speech","href":"/developers/speech/synthesize"}]},{"group":"Catalogues","icon":"list","pages":[{"title":"Models","sidebarTitle":"Models","openapi":"developers/openapi.json GET /v1/models","href":"/developers/catalogues/models"},{"title":"Voices","sidebarTitle":"Voices","openapi":"developers/openapi.json GET /v1/voices","href":"/developers/catalogues/voices"},{"title":"Transcribers","sidebarTitle":"Transcribers","openapi":"developers/openapi.json GET /v1/transcribers","href":"/developers/catalogues/transcribers"},{"title":"Languages","sidebarTitle":"Languages","openapi":"developers/openapi.json GET /v1/languages","href":"/developers/catalogues/languages"},{"title":"TTS capabilities","sidebarTitle":"TTS capabilities","openapi":"developers/openapi.json GET /v1/tts-capabilities","href":"/developers/catalogues/tts-capabilities"}]},{"group":"Integrations","icon":"plug","pages":[{"title":"WhatsApp numbers","sidebarTitle":"WhatsApp numbers","openapi":"developers/openapi.json GET /v1/whatsapp/numbers","href":"/developers/integrations/whatsapp-numbers"}]},{"group":"Custom Analysis","icon":"chart-line","pages":[{"title":"The analysis library","sidebarTitle":"List","openapi":"developers/openapi.json GET /v1/custom-analysis","href":"/developers/custom-analysis/list"},{"title":"Create an analysis group","sidebarTitle":"Create group","openapi":"developers/openapi.json POST /v1/custom-analysis/groups","href":"/developers/custom-analysis/create-group"},{"title":"Rename a group","sidebarTitle":"Update group","openapi":"developers/openapi.json PUT /v1/custom-analysis/groups/{group_id}","href":"/developers/custom-analysis/update-group"},{"title":"Delete a group","sidebarTitle":"Delete group","openapi":"developers/openapi.json DELETE /v1/custom-analysis/groups/{group_id}","href":"/developers/custom-analysis/delete-group"},{"title":"Add an item","sidebarTitle":"Add item","openapi":"developers/openapi.json POST /v1/custom-analysis/items","href":"/developers/custom-analysis/create-item"},{"title":"Edit an item","sidebarTitle":"Update item","openapi":"developers/openapi.json PUT /v1/custom-analysis/items/{item_id}","href":"/developers/custom-analysis/update-item"},{"title":"Delete an item","sidebarTitle":"Delete item","openapi":"developers/openapi.json DELETE /v1/custom-analysis/items/{item_id}","href":"/developers/custom-analysis/delete-item"}]},{"group":"Memory","icon":"brain","pages":[{"title":"Remembered callers","sidebarTitle":"List callers","openapi":"developers/openapi.json GET /v1/agents/{agent_id}/memory/subjects","href":"/developers/memory/subjects"},{"title":"One caller's memory","sidebarTitle":"Get a caller","openapi":"developers/openapi.json GET /v1/agents/{agent_id}/memory/subjects/{subject_id}","href":"/developers/memory/get-subject"},{"title":"Memory on one call","sidebarTitle":"Memory for a call","openapi":"developers/openapi.json GET /v1/agents/{agent_id}/memory/calls/{call_id}","href":"/developers/memory/for-call"},{"title":"Export memory","sidebarTitle":"Export","openapi":"developers/openapi.json GET /v1/agents/{agent_id}/memory/export","href":"/developers/memory/export"},{"title":"Delete one fact","sidebarTitle":"Delete a fact","openapi":"developers/openapi.json DELETE /v1/agents/{agent_id}/memory/facts/{fact_id}","href":"/developers/memory/delete-fact"},{"title":"Erase memory","sidebarTitle":"Flush","openapi":"developers/openapi.json POST /v1/agents/{agent_id}/memory/flush","href":"/developers/memory/flush"}]},{"group":"Widget","icon":"code","pages":[{"title":"The website widget","sidebarTitle":"Read widget","openapi":"developers/openapi.json GET /v1/agents/{agent_id}/widget","href":"/developers/widgets/get"},{"title":"Configure the widget","sidebarTitle":"Update widget","openapi":"developers/openapi.json PATCH /v1/agents/{agent_id}/widget","href":"/developers/widgets/update"},{"title":"Rotate the widget key","sidebarTitle":"Rotate key","openapi":"developers/openapi.json POST /v1/agents/{agent_id}/widget/rotate-key","href":"/developers/widgets/rotate-key"}]},{"group":"Webhooks","icon":"webhook","pages":[{"title":"Webhooks","sidebarTitle":"Overview","href":"/developers/webhooks/overview"},{"title":"Events","sidebarTitle":"Events","href":"/developers/webhooks/events"},{"title":"Verifying signatures","sidebarTitle":"Verify signatures","href":"/developers/webhooks/signature-verification"}]}]}]},"basePath":"","title":"Get a file - Vocily","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-BIYvYBgk.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}