{
"error": {
"message": "The model does not exist or you do not have access to it.",
"type": "invalid_request_error",
"code": "model_not_found",
"param": null
}
}
{
"error": {
"message": "The model does not exist or you do not have access to it.",
"type": "invalid_request_error",
"code": "model_not_found",
"param": null
}
}
Present when status is failed. Explains the failure; the job is not charged.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Hypercove API","colors":{"primary":"#3944FF","light":"#B6D2FF","dark":"#3944FF"},"logo":{"light":"https://mintcdn.com/evermindlabs/flVed5SPK4RYNY3d/logo/light.svg?fit=max\u0026auto=format\u0026n=flVed5SPK4RYNY3d\u0026q=85\u0026s=9b75189d1370af2fa1211be4349ed01d","dark":"https://mintcdn.com/evermindlabs/flVed5SPK4RYNY3d/logo/dark.svg?fit=max\u0026auto=format\u0026n=flVed5SPK4RYNY3d\u0026q=85\u0026s=cb80b9c4161a9a4cd19fa4afbf1ed2a6","href":"https://deepshi.ai/"},"favicon":"https://mintcdn.com/evermindlabs/flVed5SPK4RYNY3d/favicon.svg?fit=max\u0026auto=format\u0026n=flVed5SPK4RYNY3d\u0026q=85\u0026s=f0af632ceeae8c5d6f0b576f238615e1","appearance":{"default":"dark"},"background":{"color":{"light":"#FFFFFF","dark":"#0A0A0A"}},"navbar":{"primary":{"type":"button","label":"Get API key","href":"https://deepshi.ai/"}},"footer":{"socials":{"x":"https://x.com/deepshi_ai","discord":"https://discord.gg/xmMJRbcRKB","instagram":"https://www.instagram.com/deepshi.ai","youtube":"https://www.youtube.com/@deepshi_ai"}},"seo":{"metatags":{"og:site_name":"Hypercove API","og:type":"website","og:image":"/images/og.png","og:image:width":"1200","og:image:height":"630","twitter:card":"summary_large_image","twitter:image":"/images/og.png"},"indexing":"all"},"banner":{"content":"Unrestricted image \u0026 video generation is now live in the API. [Browse the models →](/models/overview)","dismissible":true,"color":{"light":"#3944FF","dark":"#3944FF"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","grok","aistudio","mcp","cursor","vscode","download-spec"],"display":"header"},"markdown":{"instructions":"The Hypercove API is an OpenAI-compatible gateway. Base URL: https://api.deepshi.ai/v1. API keys start with sk-bf- and go in the Authorization: Bearer header. Prefer the official OpenAI SDKs pointed at the Hypercove base URL. Model ids are clean with no provider prefix (e.g. deepshi-3.0, claude-opus-4.8, gpt-5.5). Chat and image requests are synchronous; video and music requests are asynchronous job APIs (create, then poll). Every synchronous response carries usage.cost.total_cost in USD. Do not reference the internal /api/* admin plane or virtual keys."},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"evermindlabs","hasAudioNarration":false,"actualSubdomain":"evermindlabs","customDomains":["docs.deepshi.ai"],"gitSource":{"type":"github","owner":"deepshi-ai","repo":"deepshi-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"20b369f1-f025-4a5b-8665-83071fe218f6","liveDeploymentHistoryId":"6ae5830b3db8daa4679671b4","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae5830b3db8daa4679671b4"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae5830b3db8daa4679671b4","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"Guides","count":18},{"language":"default","tag":"API reference","count":13},{"language":"default","tag":"Models","count":11},{"language":"default","tag":"Endpoints","count":11},{"language":"default","tag":"Documentation","count":8},{"language":"default","tag":"Integrations","count":8},{"language":"default","tag":"Chat","count":5},{"language":"default","tag":"Media","count":4},{"language":"default","tag":"Get started","count":4},{"language":"default","tag":"Videos","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"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":"byok-sep-25","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":"billing-updated-9-15","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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/music/retrieve-a-music-job","slug":"/api-reference/music/retrieve-a-music-job","pageMetadata":{"title":"Retrieve a music job","description":"Poll a job for its status and result. When `status` is `completed`, the finished song is under `audio[]`. An audio id is scoped to the key that created it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/audio/generations/{audio_id}","href":"/api-reference/music/retrieve-a-music-job","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Poll a job for its status and result. When \", _jsx(_components.code, {\n children: \"status\"\n }), \" is \", _jsx(_components.code, {\n children: \"completed\"\n }), \", the finished song is under \", _jsx(_components.code, {\n children: \"audio[]\"\n }), \". An audio id is scoped to the key that created it.\"]\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}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":{"title":"Retrieve a music job","description":"Poll a job for its status and result. When `status` is `completed`, the finished song is under `audio[]`. An audio id is scoped to the key that created it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/audio/generations/{audio_id}","href":"/api-reference/music/retrieve-a-music-job","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getMusic","summary":"Retrieve a music job","description":"Poll a job for its status and result. When `status` is `completed`, the finished song is under `audio[]`. An audio id is scoped to the key that created it.","tags":["Music"],"parameters":["69aba2a1-3949-4ba2-ae44-ff7b5606cb39"],"responses":{"200":"e7e2a580-c182-48bf-9ea8-d55e6346cd78","401":"35a4c7d9-6f08-4625-8e3e-5324dcd78b74","403":"b9b39082-8715-40ef-aba5-059e2943fa9a","404":"3fa4f806-8d52-49ab-8a46-2dd3c0279bd5","429":"0f61484d-afac-4626-a3cd-d3f7c666cdda","500":"d7de67a5-e4ae-4297-a2a6-c2a90ee352b9"},"method":"get","type":"path","servers":["595befbb-adaf-48d2-915e-b0fabfd7a759"],"security":["ffc62f40-cc94-469b-a77d-2c18c3fb4f42"],"path":"/v1/audio/generations/{audio_id}","baseUrlOptions":["https://api.deepshi.ai"],"title":"Retrieve a music job","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"69aba2a1-3949-4ba2-ae44-ff7b5606cb39":{"name":"audio_id","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"The job id returned by `POST /v1/audio/generations`.","uniqueKey":"","typeLabel":"string"},"description":"The job id returned by `POST /v1/audio/generations`."}},"responses":{"e7e2a580-c182-48bf-9ea8-d55e6346cd78":{"description":"The music job.","content":{"application/json":{"schema":{"type":"object","description":"A music generation job.","properties":{"id":{"type":"string","description":"The job id. Pass it to the retrieve and content endpoints.","uniqueKey":"id","typeLabel":"string"},"object":{"type":"string","description":"Object type, always `audio`.","example":"audio","uniqueKey":"object","typeLabel":"string"},"model":{"type":"string","description":"The music model id you requested.","uniqueKey":"model","typeLabel":"string"},"status":{"type":"string","enum":["in_progress","completed","failed"],"description":"Lifecycle state of the job.","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"seconds":{"type":"string","description":"Length of the generated track in seconds, present when `status` is `completed`.","uniqueKey":"seconds","typeLabel":"string"},"created_at":{"type":"integer","format":"int64","description":"Unix timestamp when the job was created.","uniqueKey":"created_at","typeLabel":"integer\u003cint64>"},"completed_at":{"oneOf":[{"type":"integer","format":"int64","description":"Unix timestamp when the job completed.","uniqueKey":"completed_at.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"Unix timestamp when the job completed.","uniqueKey":"completed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"completed_at","typeLabel":"integer\u003cint64> | null"},"audio":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Output kind, always `url`.","example":"url","uniqueKey":"audio.items.[INDEX].type","typeLabel":"string"},"url":{"type":"string","description":"Direct link to the finished `.mp3`.","uniqueKey":"audio.items.[INDEX].url","typeLabel":"string"},"content_type":{"type":"string","description":"Media type, always `audio/mpeg`.","uniqueKey":"audio.items.[INDEX].content_type","typeLabel":"string"}},"uniqueKey":"audio.items.[INDEX]","typeLabel":"object"},"description":"The generated song, present when `status` is `completed`.","uniqueKey":"audio","typeLabel":"object[]"},"error":{"oneOf":[{"type":"object","description":"Present when `status` is `failed`. Explains the failure; the job is not charged.","properties":{"code":{"type":"string","uniqueKey":"error.oneOf.0.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.oneOf.0.message","typeLabel":"string"}},"uniqueKey":"error.oneOf.0","typeLabel":"object"},{"type":"null","description":"Present when `status` is `failed`. Explains the failure; the job is not charged.","properties":{"code":{"type":"string"},"message":{"type":"string"}},"uniqueKey":"error.oneOf.1","typeLabel":"null"}],"uniqueKey":"error","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"id":"aud_a1b2c3","object":"audio","model":"minimax-music-v2","status":"completed","seconds":"95","created_at":1783695957,"completed_at":1783696052,"audio":[{"type":"url","url":"https://media.cdn-deepshi.com/audio/019f4c8f-....mp3","content_type":"audio/mpeg"}]},"examples":{"Example":{"title":"Example","value":{"id":"aud_a1b2c3","object":"audio","model":"minimax-music-v2","status":"completed","seconds":"95","created_at":1783695957,"completed_at":1783696052,"audio":[{"type":"url","url":"https://media.cdn-deepshi.com/audio/019f4c8f-....mp3","content_type":"audio/mpeg"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"35a4c7d9-6f08-4625-8e3e-5324dcd78b74":{"description":"Missing, malformed, or unknown API key.","content":{"application/json":{"schema":{"type":"object","description":"Error envelope, matching the OpenAI shape.","required":["error"],"properties":{"error":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable description of the error.","uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"Error category, e.g. `invalid_request_error` or `insufficient_quota`.","uniqueKey":"error.type","typeLabel":"string"},"code":{"oneOf":[{"type":"string","description":"Machine-readable error code, e.g. `invalid_api_key`, `model_not_found`, `insufficient_quota` (may be null).","uniqueKey":"error.code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Machine-readable error code, e.g. `invalid_api_key`, `model_not_found`, `insufficient_quota` (may be null).","uniqueKey":"error.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.code","typeLabel":"string | null"},"param":{"oneOf":[{"type":"string","description":"The request parameter the error relates to, when applicable.","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"The request parameter the error relates to, when applicable.","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"message":"Incorrect API key provided.","type":"invalid_request_error","code":"invalid_api_key","param":null}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"Incorrect API key provided.","type":"invalid_request_error","code":"invalid_api_key","param":null}}}},"exampleType":"examples"}},"exampleType":"examples"},"b9b39082-8715-40ef-aba5-059e2943fa9a":{"description":"The key is revoked, or not permitted to use the requested model.","content":{"application/json":{"schema":{"type":"object","description":"Error envelope, matching the OpenAI shape.","required":["error"],"properties":{"error":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable description of the error.","uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"Error category, e.g. `invalid_request_error` or `insufficient_quota`.","uniqueKey":"error.type","typeLabel":"string"},"code":{"oneOf":[{"type":"string","description":"Machine-readable error code, e.g. `invalid_api_key`, `model_not_found`, `insufficient_quota` (may be null).","uniqueKey":"error.code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Machine-readable error code, e.g. `invalid_api_key`, `model_not_found`, `insufficient_quota` (may be null).","uniqueKey":"error.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.code","typeLabel":"string | null"},"param":{"oneOf":[{"type":"string","description":"The request parameter the error relates to, when applicable.","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"The request parameter the error relates to, when applicable.","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"message":"The model does not exist or you do not have access to it.","type":"invalid_request_error","code":"model_not_found","param":null}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"The model does not exist or you do not have access to it.","type":"invalid_request_error","code":"model_not_found","param":null}}}},"exampleType":"examples"}},"exampleType":"examples"},"3fa4f806-8d52-49ab-8a46-2dd3c0279bd5":{"description":"No audio job with that id exists for your key, or the id is invalid.","content":{"application/json":{"schema":{"type":"object","description":"Error envelope, matching the OpenAI shape.","required":["error"],"properties":{"error":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable description of the error.","uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"Error category, e.g. `invalid_request_error` or `insufficient_quota`.","uniqueKey":"error.type","typeLabel":"string"},"code":{"oneOf":[{"type":"string","description":"Machine-readable error code, e.g. `invalid_api_key`, `model_not_found`, `insufficient_quota` (may be null).","uniqueKey":"error.code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Machine-readable error code, e.g. `invalid_api_key`, `model_not_found`, `insufficient_quota` (may be null).","uniqueKey":"error.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.code","typeLabel":"string | null"},"param":{"oneOf":[{"type":"string","description":"The request parameter the error relates to, when applicable.","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"The request parameter the error relates to, when applicable.","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"message":"Audio not found.","type":"invalid_request_error","code":"audio_not_found","param":"audio_id"}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"Audio not found.","type":"invalid_request_error","code":"audio_not_found","param":"audio_id"}}}},"exampleType":"examples"}},"exampleType":"examples"},"0f61484d-afac-4626-a3cd-d3f7c666cdda":{"description":"Too many requests. Back off and retry.","content":{"application/json":{"schema":{"type":"object","description":"Error envelope, matching the OpenAI shape.","required":["error"],"properties":{"error":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable description of the error.","uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"Error category, e.g. `invalid_request_error` or `insufficient_quota`.","uniqueKey":"error.type","typeLabel":"string"},"code":{"oneOf":[{"type":"string","description":"Machine-readable error code, e.g. `invalid_api_key`, `model_not_found`, `insufficient_quota` (may be null).","uniqueKey":"error.code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Machine-readable error code, e.g. `invalid_api_key`, `model_not_found`, `insufficient_quota` (may be null).","uniqueKey":"error.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.code","typeLabel":"string | null"},"param":{"oneOf":[{"type":"string","description":"The request parameter the error relates to, when applicable.","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"The request parameter the error relates to, when applicable.","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"message":"Rate limit reached. Please retry after a short delay.","type":"rate_limit_error","code":"rate_limit_exceeded","param":null}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"Rate limit reached. Please retry after a short delay.","type":"rate_limit_error","code":"rate_limit_exceeded","param":null}}}},"exampleType":"examples"}},"exampleType":"examples"},"d7de67a5-e4ae-4297-a2a6-c2a90ee352b9":{"description":"Temporary server error. Retry with backoff.","content":{"application/json":{"schema":{"type":"object","description":"Error envelope, matching the OpenAI shape.","required":["error"],"properties":{"error":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable description of the error.","uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"Error category, e.g. `invalid_request_error` or `insufficient_quota`.","uniqueKey":"error.type","typeLabel":"string"},"code":{"oneOf":[{"type":"string","description":"Machine-readable error code, e.g. `invalid_api_key`, `model_not_found`, `insufficient_quota` (may be null).","uniqueKey":"error.code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Machine-readable error code, e.g. `invalid_api_key`, `model_not_found`, `insufficient_quota` (may be null).","uniqueKey":"error.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.code","typeLabel":"string | null"},"param":{"oneOf":[{"type":"string","description":"The request parameter the error relates to, when applicable.","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"The request parameter the error relates to, when applicable.","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"message":"The server had an error while processing your request. Please retry.","type":"api_error","code":null,"param":null}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"The server had an error while processing your request. Please retry.","type":"api_error","code":null,"param":null}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"ffc62f40-cc94-469b-a77d-2c18c3fb4f42":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Your Hypercove API key, sent as `Authorization: Bearer \u003ckey>`.","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"595befbb-adaf-48d2-915e-b0fabfd7a759":{"url":"https://api.deepshi.ai","description":"Hypercove API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Your Hypercove API key, sent as `Authorization: Bearer \u003ckey>`.","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your Hypercove API key, sent as `Authorization: Bearer \u003ckey>`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"evermindlabs","siteName":"Hypercove API","title":"Retrieve a music job - Hypercove API","contextualStarterQuestions":[],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-30T21:31:42.420Z","originalFileLocation":"api-reference/music/retrieve-a-music-job.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=\"Poll a job for its status and result. When status is completed, the finished song is under audio[]. An audio id is scoped to the key that created it.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Hypercove API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/evermindlabs/3C9yVazs2QQLc4GE/_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/evermindlabs/3C9yVazs2QQLc4GE/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/evermindlabs/3C9yVazs2QQLc4GE/_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/evermindlabs/3C9yVazs2QQLc4GE/_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/evermindlabs/3C9yVazs2QQLc4GE/_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/evermindlabs/3C9yVazs2QQLc4GE/_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/evermindlabs/3C9yVazs2QQLc4GE/_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/evermindlabs/3C9yVazs2QQLc4GE/_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/evermindlabs/3C9yVazs2QQLc4GE/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve a music job - Hypercove API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Poll a job for its status and result. When status is completed, the finished song is under audio[]. An audio id is scoped to the key that created it.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hypercove API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.deepshi.ai/api-reference/music/retrieve-a-music-job\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://evermindlabs.mintlify.app/images/og.png\">\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=\"Retrieve a music job - Hypercove API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Poll a job for its status and result. When status is completed, the finished song is under audio[]. An audio id is scoped to the key that created it.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://evermindlabs.mintlify.app/images/og.png\">\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/evermindlabs/3C9yVazs2QQLc4GE/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Hypercove API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3944FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.deepshi.ai/api-reference/music/retrieve-a-music-job\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/music/retrieve-a-music-job.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.deepshi.ai/#organization\",\"name\":\"Hypercove API\",\"url\":\"https://docs.deepshi.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/evermindlabs/flVed5SPK4RYNY3d/logo/light.svg?fit=max\u0026auto=format\u0026n=flVed5SPK4RYNY3d\u0026q=85\u0026s=9b75189d1370af2fa1211be4349ed01d\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.deepshi.ai#website\",\"name\":\"Hypercove API\",\"url\":\"https://docs.deepshi.ai\",\"publisher\":{\"@id\":\"https://docs.deepshi.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.deepshi.ai/api-reference/music/retrieve-a-music-job#webpage\",\"url\":\"https://docs.deepshi.ai/api-reference/music/retrieve-a-music-job\",\"name\":\"Retrieve a music job\",\"description\":\"Poll a job for its status and result. When status is completed, the finished song is under audio[]. An audio id is scoped to the key that created it.\",\"dateModified\":\"2026-10-30T21:31:42.420Z\",\"isPartOf\":{\"@id\":\"https://docs.deepshi.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.deepshi.ai/api-reference/music/retrieve-a-music-job#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.deepshi.ai/api-reference/music/retrieve-a-music-job#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.deepshi.ai/api-reference/models/list-available-models\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Music\",\"item\":\"https://docs.deepshi.ai/api-reference/music/create-a-music-job\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Retrieve a music job\",\"item\":\"https://docs.deepshi.ai/api-reference/music/retrieve-a-music-job\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.deepshi.ai/api-reference/music/retrieve-a-music-job#apireference\",\"headline\":\"Retrieve a music job\",\"name\":\"Retrieve a music job\",\"description\":\"Poll a job for its status and result. When status is completed, the finished song is under audio[]. An audio id is scoped to the key that created it.\",\"url\":\"https://docs.deepshi.ai/api-reference/music/retrieve-a-music-job\",\"mainEntityOfPage\":{\"@id\":\"https://docs.deepshi.ai/api-reference/music/retrieve-a-music-job#webpage\"},\"image\":\"https://docs.deepshi.ai/images/og.png\",\"dateModified\":\"2026-10-30T21:31:42.420Z\",\"publisher\":{\"@id\":\"https://docs.deepshi.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.deepshi.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Hypercove API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Hypercove API","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/capabilities/text-and-chat"}]},{"tab":"Models","pages":[{"title":"Models","href":"/models/overview"}]},{"tab":"API reference","groups":[{"group":"Reference","pages":[{"title":"API reference","icon":"book-open","href":"/api-reference/introduction"},{"title":"Errors \u0026 status codes","icon":"triangle-exclamation","href":"/resources/errors"}]},{"group":"Endpoints","pages":[{"group":"Models","pages":[{"title":"List available models","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/models","href":"/api-reference/models/list-available-models"}]},{"group":"Chat","pages":[{"title":"Create a chat completion","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/chat/completions","href":"/api-reference/chat/create-a-chat-completion"}]},{"group":"Images","pages":[{"title":"Generate an image","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/images/generations","href":"/api-reference/images/generate-an-image"},{"title":"Edit an image","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/images/edits","href":"/api-reference/images/edit-an-image"}]},{"group":"Videos","pages":[{"title":"Create a video job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/videos","href":"/api-reference/videos/create-a-video-job"},{"title":"Retrieve a video job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/videos/{video_id}","href":"/api-reference/videos/retrieve-a-video-job"},{"title":"Cancel or delete a video job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/videos/{video_id}","href":"/api-reference/videos/cancel-or-delete-a-video-job"},{"title":"Download the finished video","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/videos/{video_id}/content","href":"/api-reference/videos/download-the-finished-video"}]},{"group":"Music","pages":[{"title":"Create a music job","description":"Create an asynchronous music generation job from a style prompt. Returns a job with `status: \"in_progress\"`; poll `GET /v1/audio/generations/{audio_id}` until it is `completed`. Some models take lyrics and generate vocal songs, others are instrumental; call `GET /v1/models` to see the parameters a model supports. Music is billed once, on completion; pricing is shown on deepshi.ai.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/audio/generations","href":"/api-reference/music/create-a-music-job"},{"title":"Retrieve a music job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/audio/generations/{audio_id}","href":"/api-reference/music/retrieve-a-music-job"},{"title":"Download the finished song","description":"Redirect (HTTP 302) to the finished audio file. Follow the redirect to download the `.mp3`. Equivalent to using `audio[].url` from the retrieve response. Only available once the job is `completed`; before then it returns `404`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/audio/generations/{audio_id}/content","href":"/api-reference/music/download-the-finished-song"}]}]}]}]},"basePath":"","title":"Retrieve a music job - Hypercove API","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-DHaG7hr_.js","dist-DKZWslLH.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-BIWXJmsZ.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","AssistantPageLink-UDqbR6xh.js"]}