{ "success": true, "data": { "jobId": "e0b5df98-0867-490a-b321-cd10fdd80130", "status": "queued", "message": "Metadata request queued. You will receive a webhook when it's complete." }}
The result is the source’s own metadata in snake_case, so which fields exist depends on the platform. The most useful ones are listed on Metadata. If you only need the title, duration, and thumbnail, basic metadata is faster.
The stream url inside each entry of formats is short-lived and often tied to the IP that fetched it. Download with POST /import instead of fetching it yourself.
Your API key from the dashboard, sent as Authorization: Bearer <api key>.
Body
application/json
url
string<uri>
required
Public media page URL, e.g. a YouTube, TikTok or podcast episode link.
Example:
"https://www.youtube.com/watch?v=jNQXAC9IVRw"
webhookUrl
string<uri>
HTTPS URL that receives the result when the job finishes. It must not point to a private or
internal address. A job that fails for good sends one webhook with success: false, code
and message.
Example:
"https://example.com/webhooks/importly"
Response
The metadata job was queued.
success
boolean
required
data
object
required
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Importly","description":"Turn any video or audio link into files, transcripts and metadata. One API for your app, and your AI agent can build it in over MCP.","colors":{"primary":"#535a80","light":"#a5b3d4","dark":"#474d68"},"logo":{"light":"https://mintcdn.com/importly/6vbwnx_rStiYvjul/logo/light.svg?fit=max\u0026auto=format\u0026n=6vbwnx_rStiYvjul\u0026q=85\u0026s=7954cd5d4aab420bab4914e4a33f1375","dark":"https://mintcdn.com/importly/6vbwnx_rStiYvjul/logo/dark.svg?fit=max\u0026auto=format\u0026n=6vbwnx_rStiYvjul\u0026q=85\u0026s=f991dd67b7936e2ba5f95ce35527756b","href":"https://www.importly.io"},"favicon":"https://mintcdn.com/importly/6vbwnx_rStiYvjul/favicon.svg?fit=max\u0026auto=format\u0026n=6vbwnx_rStiYvjul\u0026q=85\u0026s=7f423d49468f80e4e0c31e0516a35b02","api":{"playground":{"display":"interactive","proxy":true},"examples":{"defaults":"required","languages":["bash","javascript","python"]}},"appearance":{"default":"system","strict":false},"navbar":{"links":[{"href":"https://www.importly.io/docs/integrations/mcp","label":"MCP"},{"href":"https://www.importly.io/pricing","label":"Pricing"},{"href":"https://www.importly.io/blog","label":"Blog"},{"href":"https://www.importly.io/login?mode=signin","label":"Sign in"}],"primary":{"type":"button","label":"Sign up free","href":"https://www.importly.io/login?mode=signup"}},"seo":{"metatags":{"canonical":"https://www.importly.io/docs"}},"fonts":{"family":"Geist"},"icons":{"library":"lucide"},"integrations":{"gtm":{"tagId":"GTM-MQ62XM9H"}},"errors":{"404":{"redirect":false}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity",{"title":"Connect the Importly MCP","description":"Let Claude Code, Cursor, Claude, or ChatGPT build Importly into your app","icon":"plug","href":"https://www.importly.io/docs/integrations/mcp"}],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"importly","hasAudioNarration":false,"actualSubdomain":"importly","customDomains":[],"gitSource":{"type":"github","owner":"yyildiz","repo":"import-dev","deployBranch":"main","contentDirectory":"docs-site","isPrivate":true,"mountPath":"","label":"","_id":"6afbcd3d6ed90620868a16d2"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6b020ca0e49cbc075efb181f","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Documentation","count":39},{"language":"default","tag":"API Reference","count":23},{"language":"default","tag":"Errors \u0026 limits","count":14},{"language":"default","tag":"Error codes","count":13},{"language":"default","tag":"Account settings","count":7},{"language":"default","tag":"Guides","count":7},{"language":"default","tag":"Get started","count":6},{"language":"default","tag":"Metadata","count":6},{"language":"default","tag":"Features","count":6},{"language":"default","tag":"Webhook payloads","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"site-roles","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":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[]}
{"page":{"pagePath":"endpoints/metadata","slug":"/endpoints/metadata","pageMetadata":{"title":"Get metadata","sidebarTitle":"Metadata","description":"Full media metadata (formats, uploader, thumbnails, stats) without downloading.","openapi":"openapi.yaml POST /metadata","href":"/endpoints/metadata"},"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: \"Full media metadata (formats, uploader, thumbnails, stats) without downloading.\"\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{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,..._provideComponents(),...props.components},{Warning}=_components;if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`The result is the source’s own metadata in snake_case, so which fields exist depends on the platform. The most useful ones are listed on `,_jsx(_components.a,{href:`/features/metadata#full-metadata-fields`,children:`Metadata`}),`. If you only need the title, duration, and thumbnail, `,_jsx(_components.a,{href:`/endpoints/basic-metadata`,children:`basic metadata`}),` is faster.`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`The stream `,_jsx(_components.code,{children:`url`}),` inside each entry of `,_jsx(_components.code,{children:`formats`}),` is short-lived and often tied to the IP that fetched it. Download with `,_jsx(_components.a,{href:`/endpoints/import`,children:_jsx(_components.code,{children:`POST /import`})}),` instead of fetching it yourself.`]})}),`\n`,_jsxs(_components.p,{children:[`Poll the result with `,_jsx(_components.a,{href:`/endpoints/metadata-status`,children:_jsx(_components.code,{children:`GET /metadata/status`})}),`, or receive it by `,_jsx(_components.a,{href:`/endpoints/webhooks/metadata`,children:`webhook`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get metadata","sidebarTitle":"Metadata","description":"Full media metadata (formats, uploader, thumbnails, stats) without downloading.","openapi":"openapi.yaml POST /metadata","href":"/endpoints/metadata"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/importly/b4b9ddcbd1d5d7f4/analytics.js"],"openApiReferenceData":{"operation":{"tags":["Metadata"],"operationId":"getMetadata","summary":"Get metadata","description":"Full media metadata (formats, uploader, thumbnails, stats) without downloading.","requestBody":"f6161faa-df57-4427-b2c6-cb7daf8b3876","responses":{"200":"119a47d1-7ca6-4869-a42d-ff2c62e682ac","400":"e21f2f3a-2a02-432d-8003-8775eaab2e8b","401":"6be0da46-6436-41af-bf38-680f90c58783","402":"6057a9eb-75ff-4ee8-9d89-385d23f40c92","429":"cb590c3a-30c8-418e-98b6-c8a4cc51d137","500":"c04df10c-f179-4e85-9e64-39606010401f"},"method":"post","type":"path","servers":["480312df-c189-47bc-9777-6f30a7d0d0f2"],"security":["99135008-976c-41f7-9db4-9fd3c9b21bf7"],"path":"/metadata","baseUrlOptions":["https://api.importly.io"],"title":"Get metadata","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri","description":"Public media page URL, e.g. a YouTube, TikTok or podcast episode link.","example":"https://www.youtube.com/watch?v=jNQXAC9IVRw","isRequired":true,"uniqueKey":"url","typeLabel":"string\u003curi>"},"webhookUrl":{"type":"string","format":"uri","description":"HTTPS URL that receives the result when the job finishes. It must not point to a private or\ninternal address. A job that fails for good sends one webhook with `success: false`, `code`\nand `message`.\n","example":"https://example.com/webhooks/importly","uniqueKey":"webhookUrl","typeLabel":"string\u003curi>"}},"uniqueKey":"","typeLabel":"object"},"example":{"url":"https://www.youtube.com/watch?v=jNQXAC9IVRw","webhookUrl":"https://example.com/webhooks/importly"},"examples":{"Example":{"title":"Example","value":{"url":"https://www.youtube.com/watch?v=jNQXAC9IVRw","webhookUrl":"https://example.com/webhooks/importly"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"119a47d1-7ca6-4869-a42d-ff2c62e682ac":{"description":"The metadata job was queued.","content":{"application/json":{"schema":{"type":"object","required":["success","data"],"properties":{"success":{"type":"boolean","const":true,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"data":{"type":"object","required":["jobId","status","message"],"properties":{"jobId":{"type":"string","format":"uuid","description":"Pass this as `id` to the matching status endpoint.","isRequired":true,"uniqueKey":"data.jobId","typeLabel":"string\u003cuuid>"},"status":{"type":"string","const":"queued","isRequired":true,"uniqueKey":"data.status","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"data.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":true,"data":{"jobId":"e0b5df98-0867-490a-b321-cd10fdd80130","status":"queued","message":"Metadata request queued. You will receive a webhook when it's complete."}},"examples":{"Example":{"title":"Example","value":{"success":true,"data":{"jobId":"e0b5df98-0867-490a-b321-cd10fdd80130","status":"queued","message":"Metadata request queued. You will receive a webhook when it's complete."}}}},"exampleType":"examples"}},"exampleType":"examples"},"e21f2f3a-2a02-432d-8003-8775eaab2e8b":{"description":"A parameter is missing or invalid.","content":{"application/json":{"schema":{"type":"object","required":["success","error","code"],"properties":{"success":{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"string","description":"What went wrong, in plain English.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"A stable, machine-readable error code: `UNAUTHORIZED`, `INSUFFICIENT_BALANCE`, `RATE_LIMITED`,\n`INVALID_URL`, `INVALID_REQUEST`, `NOT_FOUND` or `INTERNAL_ERROR`.\n","examples":["INVALID_URL"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"documentationUrl":{"type":"string","format":"uri","description":"A page explaining this error and how to fix it.","examples":["https://www.importly.io/docs/errors/invalid-url"],"uniqueKey":"documentationUrl","typeLabel":"string\u003curi>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"missingUrl":{"title":"missingUrl","summary":"Missing url","value":{"success":false,"error":"Missing required parameter: url","code":"INVALID_URL","documentationUrl":"https://www.importly.io/docs/errors/invalid-url"}},"invalidUrl":{"title":"invalidUrl","summary":"Invalid url","value":{"success":false,"error":"Invalid URL format - must be a valid HTTP or HTTPS URL","code":"INVALID_URL","documentationUrl":"https://www.importly.io/docs/errors/invalid-url"}},"webhookNotHttps":{"title":"webhookNotHttps","summary":"Webhook URL isn't HTTPS","value":{"success":false,"error":"Webhook URL must use HTTPS","code":"INVALID_REQUEST","documentationUrl":"https://www.importly.io/docs/errors/invalid-request"}}},"exampleType":"examples"}},"exampleType":"examples"},"6be0da46-6436-41af-bf38-680f90c58783":{"description":"The API key is missing or invalid.","content":{"application/json":{"schema":{"type":"object","required":["success","error","code"],"properties":{"success":{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"string","description":"What went wrong, in plain English.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"A stable, machine-readable error code: `UNAUTHORIZED`, `INSUFFICIENT_BALANCE`, `RATE_LIMITED`,\n`INVALID_URL`, `INVALID_REQUEST`, `NOT_FOUND` or `INTERNAL_ERROR`.\n","examples":["INVALID_URL"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"documentationUrl":{"type":"string","format":"uri","description":"A page explaining this error and how to fix it.","examples":["https://www.importly.io/docs/errors/invalid-url"],"uniqueKey":"documentationUrl","typeLabel":"string\u003curi>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"missingHeader":{"title":"missingHeader","summary":"No Authorization header","value":{"success":false,"error":"Missing or invalid Authorization header. Must be in format: Bearer YOUR_API_KEY","code":"UNAUTHORIZED","documentationUrl":"https://www.importly.io/docs/errors/unauthorized"}},"invalidKey":{"title":"invalidKey","summary":"Unknown key","value":{"success":false,"error":"Invalid API key","code":"UNAUTHORIZED","documentationUrl":"https://www.importly.io/docs/errors/unauthorized"}}},"exampleType":"examples"}},"exampleType":"examples"},"6057a9eb-75ff-4ee8-9d89-385d23f40c92":{"description":"Your balance is below what the job needs to start ($0.01 for an import or transcription, $0.003 for metadata). Add credits on the Billing page.","content":{"application/json":{"schema":{"type":"object","required":["code","success","error"],"properties":{"success":{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"string","description":"What went wrong, in plain English.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"A stable, machine-readable error code: `UNAUTHORIZED`, `INSUFFICIENT_BALANCE`, `RATE_LIMITED`,\n`INVALID_URL`, `INVALID_REQUEST`, `NOT_FOUND` or `INTERNAL_ERROR`.\n","const":"INSUFFICIENT_BALANCE","example":"INVALID_URL","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"documentationUrl":{"type":"string","format":"uri","description":"A page explaining this error and how to fix it.","examples":["https://www.importly.io/docs/errors/invalid-url"],"uniqueKey":"documentationUrl","typeLabel":"string\u003curi>"},"endpoint":{"type":"string","description":"The rate-limit bucket the request counted against.","uniqueKey":"endpoint","typeLabel":"string"},"balanceRequired":{"type":"number","description":"Minimum balance in US dollars needed to start the job.","uniqueKey":"balanceRequired","typeLabel":"number"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":"Insufficient balance. Please add credits to your account.","code":"INSUFFICIENT_BALANCE","endpoint":"/import","balanceRequired":0.01,"documentationUrl":"https://www.importly.io/docs/errors/insufficient-credits"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":"Insufficient balance. Please add credits to your account.","code":"INSUFFICIENT_BALANCE","endpoint":"/import","balanceRequired":0.01,"documentationUrl":"https://www.importly.io/docs/errors/insufficient-credits"}}},"exampleType":"examples"}},"exampleType":"examples"},"cb590c3a-30c8-418e-98b6-c8a4cc51d137":{"description":"You hit the hourly rate limit for this endpoint, or have too many jobs queued or running (`outstanding` and `outstandingLimit` are set). Wait `retryAfter` seconds and retry.","headers":{"X-RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"When the window resets, as Unix time in milliseconds.","schema":{"type":"integer"}},"X-RateLimit-Window":{"description":"Window length, e.g. `1 h`.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["success","error","code"],"properties":{"success":{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"string","description":"What went wrong, in plain English.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"A stable, machine-readable error code: `UNAUTHORIZED`, `INSUFFICIENT_BALANCE`, `RATE_LIMITED`,\n`INVALID_URL`, `INVALID_REQUEST`, `NOT_FOUND` or `INTERNAL_ERROR`.\n","examples":["INVALID_URL"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"documentationUrl":{"type":"string","format":"uri","description":"A page explaining this error and how to fix it.","examples":["https://www.importly.io/docs/errors/invalid-url"],"uniqueKey":"documentationUrl","typeLabel":"string\u003curi>"},"limit":{"type":"integer","description":"Requests allowed per window.","uniqueKey":"limit","typeLabel":"integer"},"remaining":{"type":"integer","description":"Requests left in the window.","uniqueKey":"remaining","typeLabel":"integer"},"reset":{"type":"integer","description":"When the window resets, as Unix time in milliseconds.","uniqueKey":"reset","typeLabel":"integer"},"retryAfter":{"type":"integer","description":"Seconds to wait before retrying.","uniqueKey":"retryAfter","typeLabel":"integer"},"endpoint":{"type":"string","description":"The rate-limit bucket the request counted against.","uniqueKey":"endpoint","typeLabel":"string"},"outstandingLimit":{"type":"integer","description":"Present instead of `limit` when too many of your jobs of this kind are queued or running; the most allowed at once.","uniqueKey":"outstandingLimit","typeLabel":"integer"},"outstanding":{"type":"integer","description":"Present with `outstandingLimit`. How many of your jobs of this kind are queued or running.","uniqueKey":"outstanding","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":"Rate limit exceeded. Limit: 240 requests per 1 h","code":"RATE_LIMITED","limit":240,"remaining":0,"reset":1763200000000,"retryAfter":1800,"endpoint":"/import","documentationUrl":"https://www.importly.io/docs/errors/rate-limited"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":"Rate limit exceeded. Limit: 240 requests per 1 h","code":"RATE_LIMITED","limit":240,"remaining":0,"reset":1763200000000,"retryAfter":1800,"endpoint":"/import","documentationUrl":"https://www.importly.io/docs/errors/rate-limited"}}},"exampleType":"examples"}},"exampleType":"examples"},"c04df10c-f179-4e85-9e64-39606010401f":{"description":"Unexpected server error. Retry with exponential backoff.","content":{"application/json":{"schema":{"type":"object","required":["success","error","code"],"properties":{"success":{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"string","description":"What went wrong, in plain English.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"A stable, machine-readable error code: `UNAUTHORIZED`, `INSUFFICIENT_BALANCE`, `RATE_LIMITED`,\n`INVALID_URL`, `INVALID_REQUEST`, `NOT_FOUND` or `INTERNAL_ERROR`.\n","examples":["INVALID_URL"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"documentationUrl":{"type":"string","format":"uri","description":"A page explaining this error and how to fix it.","examples":["https://www.importly.io/docs/errors/invalid-url"],"uniqueKey":"documentationUrl","typeLabel":"string\u003curi>"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":"Internal server error","code":"INTERNAL_ERROR","documentationUrl":"https://www.importly.io/docs/errors/server-error"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":"Internal server error","code":"INTERNAL_ERROR","documentationUrl":"https://www.importly.io/docs/errors/server-error"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"99135008-976c-41f7-9db4-9fd3c9b21bf7":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Your API key from the dashboard, sent as `Authorization: Bearer \u003capi key>`.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"480312df-c189-47bc-9777-6f30a7d0d0f2":{"url":"https://api.importly.io","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Your API key from the dashboard, sent as `Authorization: Bearer \u003capi key>`.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your API key from the dashboard, sent as `Authorization: Bearer \u003capi key>`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"importly","siteName":"Importly","title":"Get metadata - Importly","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-17T04:34:02.497Z","originalFileLocation":"endpoints/metadata.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=\"Full media metadata (formats, uploader, thumbnails, stats) without downloading.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Importly\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/importly/2khYl_XH3IZT57vg/_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=\"/docs/mintlify-assets/_mintlify/favicons/importly/2khYl_XH3IZT57vg/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/importly/2khYl_XH3IZT57vg/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/importly/2khYl_XH3IZT57vg/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/importly/2khYl_XH3IZT57vg/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/importly/2khYl_XH3IZT57vg/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/importly/2khYl_XH3IZT57vg/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/importly/2khYl_XH3IZT57vg/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/importly/2khYl_XH3IZT57vg/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get metadata - Importly\">\u003cmeta data-mint-head property=\"og:description\" content=\"Full media metadata (formats, uploader, thumbnails, stats) without downloading.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Importly\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.importly.io/docs/endpoints/metadata\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://importly.mintlify.site/docs/_mintlify/api/og/v2?division=Metadata\u0026amp;title=Get+metadata\u0026amp;description=Full+media+metadata+%28formats%2C+uploader%2C+thumbnails%2C+stats%29+without+downloading.\u0026amp;theme=8d5e5fd802c7550123a7b754\u0026amp;signature=5d618bd56fa5933f2a144cafb00b9d4748de359cdf7a6970080791ef87ae4ba2\">\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 metadata - Importly\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Full media metadata (formats, uploader, thumbnails, stats) without downloading.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://importly.mintlify.site/docs/_mintlify/api/og/v2?division=Metadata\u0026amp;title=Get+metadata\u0026amp;description=Full+media+metadata+%28formats%2C+uploader%2C+thumbnails%2C+stats%29+without+downloading.\u0026amp;theme=8d5e5fd802c7550123a7b754\u0026amp;signature=5d618bd56fa5933f2a144cafb00b9d4748de359cdf7a6970080791ef87ae4ba2\">\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=\"/docs/mintlify-assets/_mintlify/favicons/importly/2khYl_XH3IZT57vg/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Importly\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#535a80\">\u003clink data-mint-head rel=\"canonical\" href=\"https://www.importly.io/docs/endpoints/metadata\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/endpoints/metadata.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.importly.io/#organization\",\"name\":\"Importly\",\"url\":\"https://www.importly.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/importly/6vbwnx_rStiYvjul/logo/light.svg?fit=max\u0026auto=format\u0026n=6vbwnx_rStiYvjul\u0026q=85\u0026s=7954cd5d4aab420bab4914e4a33f1375\"}},{\"@type\":\"WebSite\",\"@id\":\"https://www.importly.io/docs#website\",\"name\":\"Importly\",\"url\":\"https://www.importly.io/docs\",\"publisher\":{\"@id\":\"https://www.importly.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://www.importly.io/docs/endpoints/metadata#webpage\",\"url\":\"https://www.importly.io/docs/endpoints/metadata\",\"name\":\"Get metadata\",\"description\":\"Full media metadata (formats, uploader, thumbnails, stats) without downloading.\",\"dateModified\":\"2026-11-17T04:34:02.497Z\",\"isPartOf\":{\"@id\":\"https://www.importly.io/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.importly.io/docs/endpoints/metadata#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.importly.io/docs/endpoints/metadata#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Importly\",\"item\":\"https://www.importly.io/docs\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get metadata\",\"item\":\"https://www.importly.io/docs/endpoints/metadata\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://www.importly.io/docs/endpoints/metadata#apireference\",\"headline\":\"Get metadata\",\"name\":\"Get metadata\",\"description\":\"Full media metadata (formats, uploader, thumbnails, stats) without downloading.\",\"url\":\"https://www.importly.io/docs/endpoints/metadata\",\"mainEntityOfPage\":{\"@id\":\"https://www.importly.io/docs/endpoints/metadata#webpage\"},\"dateModified\":\"2026-11-17T04:34:02.497Z\",\"publisher\":{\"@id\":\"https://www.importly.io/#organization\"},\"isPartOf\":{\"@id\":\"https://www.importly.io/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Importly\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Importly\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/endpoints/metadata.md","siteName":"Importly","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","icon":"square-terminal","groups":[{"group":"Using the API","pages":[{"title":"API reference","sidebarTitle":"Introduction","href":"/api-reference"}]},{"group":"Media","pages":[{"title":"Import media","sidebarTitle":"Import","openapi":"openapi.yaml POST /import","href":"/endpoints/import"},{"title":"Get import status","sidebarTitle":"Import status","openapi":"openapi.yaml GET /import/status","href":"/endpoints/import-status"}]},{"group":"Transcripts","pages":[{"title":"Transcribe media","sidebarTitle":"Transcribe","openapi":"openapi.yaml POST /transcribe","href":"/endpoints/transcribe"},{"title":"Get transcription status","sidebarTitle":"Transcription status","description":"Poll a transcription job until it's completed or failed. Completed jobs carry the text and timestamped segments.","openapi":"openapi.yaml GET /transcribe/status","href":"/endpoints/transcribe-status"}]},{"group":"Metadata","pages":[{"title":"Get metadata","sidebarTitle":"Metadata","openapi":"openapi.yaml POST /metadata","href":"/endpoints/metadata"},{"title":"Get metadata status","sidebarTitle":"Metadata status","description":"Poll a metadata job until it's completed or failed. Completed jobs carry the source's full metadata.","openapi":"openapi.yaml GET /metadata/status","href":"/endpoints/metadata-status"},{"title":"Get basic metadata","sidebarTitle":"Basic metadata","openapi":"openapi.yaml POST /metadata/basic","href":"/endpoints/basic-metadata"},{"title":"Get basic metadata status","sidebarTitle":"Basic metadata status","openapi":"openapi.yaml GET /metadata/basic/status","href":"/endpoints/basic-metadata-status"},{"title":"Get metadata (GET form)","sidebarTitle":"Metadata (GET)","openapi":"openapi.yaml GET /metadata","href":"/endpoints/metadata-get"},{"title":"Get basic metadata (GET form)","sidebarTitle":"Basic metadata (GET)","openapi":"openapi.yaml GET /metadata/basic","href":"/endpoints/basic-metadata-get"}]},{"group":"Account","pages":[{"title":"Get balance","sidebarTitle":"Balance","openapi":"openapi.yaml GET /balance","href":"/endpoints/balance"}]},{"group":"Account settings","pages":[{"title":"Get S3 storage settings","sidebarTitle":"Get S3 settings","openapi":"openapi.yaml GET /s3-storage","playground":"none","href":"/endpoints/get-s3-storage"},{"title":"Save S3 storage settings","sidebarTitle":"Save S3 settings","openapi":"openapi.yaml POST /s3-storage","playground":"none","href":"/endpoints/save-s3-storage"},{"title":"Delete S3 storage settings","sidebarTitle":"Delete S3 settings","openapi":"openapi.yaml DELETE /s3-storage","playground":"none","href":"/endpoints/delete-s3-storage"},{"title":"Test S3 storage settings","sidebarTitle":"Test S3 settings","openapi":"openapi.yaml POST /s3-storage/test","playground":"none","href":"/endpoints/test-s3-storage"},{"title":"List transcription provider keys","sidebarTitle":"List provider keys","openapi":"openapi.yaml GET /transcription-provider","playground":"none","href":"/endpoints/list-transcription-providers"},{"title":"Save a transcription provider key","sidebarTitle":"Save provider key","openapi":"openapi.yaml POST /transcription-provider","playground":"none","href":"/endpoints/save-transcription-provider"},{"title":"Delete a transcription provider key","sidebarTitle":"Delete provider key","openapi":"openapi.yaml DELETE /transcription-provider","playground":"none","href":"/endpoints/delete-transcription-provider"}]},{"group":"Webhook payloads","pages":[{"title":"Import completed webhook","sidebarTitle":"Import completed","openapi":"openapi.yaml webhook importCompleted","href":"/endpoints/webhooks/import"},{"title":"Transcription completed webhook","sidebarTitle":"Transcription completed","openapi":"openapi.yaml webhook transcribeCompleted","href":"/endpoints/webhooks/transcribe"},{"title":"Metadata completed webhook","sidebarTitle":"Metadata completed","openapi":"openapi.yaml webhook metadataCompleted","href":"/endpoints/webhooks/metadata"},{"title":"Basic metadata completed webhook","sidebarTitle":"Basic metadata completed","openapi":"openapi.yaml webhook basicMetadataCompleted","href":"/endpoints/webhooks/basic-metadata"}]}]}]},"basePath":"","title":"Get metadata - Importly","deploymentId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","buildId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Ku9dSkH0.js","snippetPresets-Cjez4eet.js","utils-BqNa-fnS.js","style-to-object-BY3JEAdk.js","utils-DiE92JCe.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-Bi0DpqVf.js","conditional-requirements-CFM0id0Q.js","cloneDeep-C6xnxscF.js","_Uint8Array-B7g0OYAt.js","isObject-FP1Yky1u.js","ApiExamples-Bf8Ecb5t.js","usePlaygroundInputsStore-BA942cq6.js","shallow-D0sePNkF.js","isEqual-CnnQO8sL.js","CodeSnippets-BTANoy1T.js","CodeSnippet-CTZvgJfu.js","getApiPlaygroundDisplay-BK2o1XYu.js","Page--B9YZ09u.js","DynamicMarkdown-CsgNpZb1.js","SectionHeading-C3K437Dy.js","icon-DlxjjqnB.js","MethodPill-Cr7Ib9nN.js","getPastedJson-DXo3wtHt.js","Check2Icon-ChEI-f_B.js","axios-CsQoIw0U.js","Markdown-CH4mv0N8.js","AssistantPageLink-BHjmqccN.js","dist-DYCPzQwJ.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}