Submit a media source and up to 20 model targets for processing. Each target specifies a model and output format.Provide exactly one source β either a public HTTPS url, an s3:// or gs:// URI with a storageIntegrationId, or an assetId from a previous upload.
Optional. S3 or GCS URI prefix to write outputs under (e.g. "s3://my-bucket/outputs" or "gs://my-bucket/outputs"). Requires storageIntegrationId. The source 'url' must also have a matching URI scheme (s3:// or gs://). The bucket must be covered by a configured storage integration. Outputs are written under //*. Use output[].link for exact object locations. See Custom Storage Integrations.
Optional. Webhook URL to notify when this Task completes. Overrides the global webhook URL configured in the dashboard for this Task only. See Using Webhooks.
S3 or GCS URI prefix outputs were written under. The source 'url' must also have a matching URI scheme (s3:// or gs://). Outputs are written under //*. Use output[].link for exact object locations. Only present when a custom write destination was provided.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"AudioShake Developers","colors":{"primary":"#0F7A6E","light":"#3AA89A","dark":"#0F7A6E"},"logo":{"light":"https://mintcdn.com/audioshake/a4R6sqRrLL6RJwFi/logo/audioshake-logo-light.svg?fit=max\u0026auto=format\u0026n=a4R6sqRrLL6RJwFi\u0026q=85\u0026s=b0de973196be153f8f4ccd6aca4ebdbb","dark":"https://mintcdn.com/audioshake/a4R6sqRrLL6RJwFi/logo/audioshake-logo-dark.svg?fit=max\u0026auto=format\u0026n=a4R6sqRrLL6RJwFi\u0026q=85\u0026s=1c04953555f7afaea3740547416bb914","href":"/"},"favicon":"https://mintcdn.com/audioshake/a4R6sqRrLL6RJwFi/favicon.svg?fit=max\u0026auto=format\u0026n=a4R6sqRrLL6RJwFi\u0026q=85\u0026s=78157418a19e82e0740fac9926377f5c","appearance":{"default":"system","strict":false},"background":{"color":{"light":"#FCF9F5","dark":"#1C1C1B"}},"navbar":{"links":[{"href":"mailto:support@audioshake.ai","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.audioshake.ai"}},"footer":{"socials":{"website":"https://audioshake.ai","linkedin":"https://www.linkedin.com/products/audioshake"}},"fonts":{"family":"Geist"},"banner":{"content":"π **A new version of Multi-Voice is here** β [see what's new](/multi-speaker-separation)","dismissible":true},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Documentation","icon":"book-open-cover","href":"/"},{"anchor":"API Reference","icon":"terminal","href":"/api-reference/authentication"},{"anchor":"Blog","icon":"newspaper","href":"https://www.audioshake.ai/blog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"audioshake","hasAudioNarration":false,"actualSubdomain":"audioshake","customDomains":["developer.audioshake.ai"],"gitSource":{"type":"github","owner":"audioshake","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aebd00a462b5d8e3699d481","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"Documentation","count":26},{"language":"default","tag":"API Reference","count":20},{"language":"default","tag":"Tutorials","count":14},{"language":"default","tag":"API Overview","count":6},{"language":"default","tag":"Storage Integrations","count":6},{"language":"default","tag":"Tools","count":6},{"language":"default","tag":"Tasks","count":4},{"language":"default","tag":"Getting started","count":4},{"language":"default","tag":"Music","count":4},{"language":"default","tag":"Sports \u0026 Media","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"#page-title,.mdx-content h1{letter-spacing:0.03em!important}.mdx-content h2,.mdx-content h3{letter-spacing:0.02em!important}"}],"page":{"pagePath":"api-reference/tasks/create","slug":"/api-reference/tasks/create","pageMetadata":{"title":"Create Task","openapi":"POST /tasks","description":null,"href":"/api-reference/tasks/create"},"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`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{CodeBlock,Heading,Step,Steps,Tip}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Step)_missingMdxReference(`Step`,true);if(!Steps)_missingMdxReference(`Steps`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Submit a media source and up to 20 model targets for processing. Each target specifies a `,_jsx(_components.a,{href:`/models`,children:`model`}),` and output format.`]}),`\n`,_jsxs(_components.p,{children:[`Provide exactly one source β either a public HTTPS `,_jsx(_components.code,{children:`url`}),`, an `,_jsx(_components.code,{children:`s3://`}),` or `,_jsx(_components.code,{children:`gs://`}),` URI with a `,_jsx(_components.code,{children:`storageIntegrationId`}),`, or an `,_jsx(_components.code,{children:`assetId`}),` from a `,_jsx(_components.a,{href:`/api-reference/assets/upload`,children:`previous upload`}),`.`]}),`\n`,_jsxs(Tip,{children:[`To read inputs from and write outputs to your own S3 or GCS bucket, see `,_jsx(_components.a,{href:`/api-reference/custom-storage`,children:`Custom Storage Integrations`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`examples`,children:`Examples`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Separate vocals and instrumental:`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`7`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`7`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"assetId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"your_asset_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"targets\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"model\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"vocals\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"formats\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"wav\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`] },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"model\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"instrumental\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"formats\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"wav\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`] }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Transcribe lyrics:`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`6`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`6`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"assetId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"your_asset_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"targets\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"model\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"transcription\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"formats\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"json\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`] }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`checking-results`,children:`Checking results`}),`\n`,_jsxs(_components.p,{children:[`Tasks process asynchronously. The response returns a Task `,_jsx(_components.code,{children:`id`}),` you can use to check progress:`]}),`\n`,_jsxs(Steps,{children:[_jsx(Step,{title:`Task is created`,children:_jsxs(_components.p,{children:[`Each target begins in `,_jsx(_components.code,{children:`processing`}),` status.`]})}),_jsx(Step,{title:`Check for completion`,children:_jsxs(_components.p,{children:[`Call `,_jsx(_components.a,{href:`/api-reference/tasks/get`,children:`Get Task by ID`}),` and check each targetβs `,_jsx(_components.code,{children:`status`}),`. When a target finishes, its status becomes `,_jsx(_components.code,{children:`completed`}),` (with output download links) or `,_jsx(_components.code,{children:`error`}),`.`]})})]}),`\n`,_jsxs(Tip,{children:[`Use `,_jsx(_components.a,{href:`/api-reference/tasks/webhooks`,children:`webhooks`}),` to get notified when a Task completes instead of polling.`]})]})}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":"Create Task","openapi":"POST /tasks","description":null,"href":"/api-reference/tasks/create"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Examples","slug":"examples","depth":2,"children":[]},{"title":"Checking results","slug":"checking-results","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"createTask","summary":"Create Task","tags":["tasks"],"requestBody":"eb7d6743-3730-4870-8c84-7b4f10a561e6","responses":{"200":"f3f6a6a5-c83f-49d1-97a0-a4cca81cf538"},"method":"post","type":"path","servers":["f0388a2e-b12d-4398-a608-73b703f15e29"],"security":["a0519df1-ffb6-499a-acef-d5e8025d0928"],"path":"/tasks","baseUrlOptions":["https://api.audioshake.ai"],"title":"Create Task","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["assetId","targets"],"example":{"assetId":"your_asset_id","targets":[{"model":"vocals","formats":["wav"]},{"model":"instrumental","formats":["wav"]}]},"properties":{"assetId":{"description":"Asset ID of an input media file","type":"string","isRequired":true,"uniqueKey":"oneOf.0.assetId","typeLabel":"string"},"targets":{"description":"One or more model targets to process","minItems":1,"maxItems":20,"uniqueItems":true,"type":"array","items":{"description":"A target specifying a model and desired output formats.","additionalProperties":false,"type":"object","properties":{"model":{"description":"Model to run. See the Models page for available options. The special value \"residual\" returns one stem with everything the task's other targets don't cover; it requires at least one other target, all targets must use the same formats, and it cannot be combined with the per-target residual flag.","minLength":2,"maxLength":255,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.targets.items.[INDEX].model","typeLabel":"string"},"formats":{"description":"Output file formats: \"wav\", \"mp3\" for audio models, \"json\" for transcription and detection models.","uniqueItems":true,"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.targets.items.[INDEX].formats.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"oneOf.0.targets.items.[INDEX].formats","typeLabel":"string[]"},"residual":{"description":"Optional. Return the residual (everything not in the target stem).","type":"boolean","uniqueKey":"oneOf.0.targets.items.[INDEX].residual","typeLabel":"boolean"},"numSpeakers":{"description":"Optional. Number of speakers to separate. Only applies to the multi_voice model. Detected automatically if omitted.","minimum":1,"type":"integer","uniqueKey":"oneOf.0.targets.items.[INDEX].numSpeakers","typeLabel":"integer"},"language":{"description":"Optional. ISO 639-1 language code (e.g. \"en\"). Only applies to transcription and alignment models. Auto-detected if omitted.","minLength":2,"maxLength":2,"type":"string","uniqueKey":"oneOf.0.targets.items.[INDEX].language","typeLabel":"string"},"transcriptAssetId":{"description":"Optional. Asset ID of an existing transcript to align against. Only used with the alignment model. Mutually exclusive with transcriptUrl.","minLength":2,"type":"string","uniqueKey":"oneOf.0.targets.items.[INDEX].transcriptAssetId","typeLabel":"string"},"transcriptUrl":{"description":"Optional. HTTPS URL of an existing transcript to align against. Only used with the alignment model. Mutually exclusive with transcriptAssetId.","format":"uri","minLength":2,"type":"string","uniqueKey":"oneOf.0.targets.items.[INDEX].transcriptUrl","typeLabel":"string\u003curi>"}},"required":["model","formats"],"uniqueKey":"oneOf.0.targets.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"oneOf.0.targets","typeLabel":"object[]"},"storageIntegrationId":{"description":"ID of a configured storage integration. Required when using an S3 or GCS input url or a custom writeDestination. See Custom Storage Integrations.","type":"string","uniqueKey":"oneOf.0.storageIntegrationId","typeLabel":"string"},"writeDestination":{"description":"Optional. S3 or GCS URI prefix to write outputs under (e.g. \"s3://my-bucket/outputs\" or \"gs://my-bucket/outputs\"). Requires storageIntegrationId. The source 'url' must also have a matching URI scheme (s3:// or gs://). The bucket must be covered by a configured storage integration. Outputs are written under \u003cwriteDestination>/\u003ctaskId>/*. Use output[].link for exact object locations. See Custom Storage Integrations.","format":"uri","type":"string","uniqueKey":"oneOf.0.writeDestination","typeLabel":"string\u003curi>"},"webhookUrl":{"description":"Optional. Webhook URL to notify when this Task completes. Overrides the global webhook URL configured in the dashboard for this Task only. See Using Webhooks.","format":"uri","type":"string","uniqueKey":"oneOf.0.webhookUrl","typeLabel":"string\u003curi>"},"metadata":{"description":"Client-provided metadata. Stored and returned as-is in responses and webhooks.","maxLength":4096,"type":"string","uniqueKey":"oneOf.0.metadata","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["url","targets"],"example":{"url":"https://example.com/song.wav","targets":[{"model":"vocals","formats":["wav"]},{"model":"instrumental","formats":["wav"]}]},"properties":{"url":{"description":"Public HTTPS URL, S3 URI (s3://bucket/key), or GCS URI (gs://bucket/key) of an input media file. S3 and GCS URIs require storageIntegrationId.","format":"uri","type":"string","isRequired":true,"uniqueKey":"oneOf.1.url","typeLabel":"string\u003curi>"},"targets":{"description":"One or more model targets to process","minItems":1,"maxItems":20,"uniqueItems":true,"type":"array","items":{"description":"A target specifying a model and desired output formats.","additionalProperties":false,"type":"object","properties":{"model":{"description":"Model to run. See the Models page for available options. The special value \"residual\" returns one stem with everything the task's other targets don't cover; it requires at least one other target, all targets must use the same formats, and it cannot be combined with the per-target residual flag.","minLength":2,"maxLength":255,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.targets.items.[INDEX].model","typeLabel":"string"},"formats":{"description":"Output file formats: \"wav\", \"mp3\" for audio models, \"json\" for transcription and detection models.","uniqueItems":true,"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.targets.items.[INDEX].formats.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"oneOf.1.targets.items.[INDEX].formats","typeLabel":"string[]"},"residual":{"description":"Optional. Return the residual (everything not in the target stem).","type":"boolean","uniqueKey":"oneOf.1.targets.items.[INDEX].residual","typeLabel":"boolean"},"numSpeakers":{"description":"Optional. Number of speakers to separate. Only applies to the multi_voice model. Detected automatically if omitted.","minimum":1,"type":"integer","uniqueKey":"oneOf.1.targets.items.[INDEX].numSpeakers","typeLabel":"integer"},"language":{"description":"Optional. ISO 639-1 language code (e.g. \"en\"). Only applies to transcription and alignment models. Auto-detected if omitted.","minLength":2,"maxLength":2,"type":"string","uniqueKey":"oneOf.1.targets.items.[INDEX].language","typeLabel":"string"},"transcriptAssetId":{"description":"Optional. Asset ID of an existing transcript to align against. Only used with the alignment model. Mutually exclusive with transcriptUrl.","minLength":2,"type":"string","uniqueKey":"oneOf.1.targets.items.[INDEX].transcriptAssetId","typeLabel":"string"},"transcriptUrl":{"description":"Optional. HTTPS URL of an existing transcript to align against. Only used with the alignment model. Mutually exclusive with transcriptAssetId.","format":"uri","minLength":2,"type":"string","uniqueKey":"oneOf.1.targets.items.[INDEX].transcriptUrl","typeLabel":"string\u003curi>"}},"required":["model","formats"],"uniqueKey":"oneOf.1.targets.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"oneOf.1.targets","typeLabel":"object[]"},"storageIntegrationId":{"description":"ID of a configured storage integration. Required when url is an S3 or GCS URI (s3://... or gs://...) or when writing outputs to a custom writeDestination. See Custom Storage Integrations.","type":"string","uniqueKey":"oneOf.1.storageIntegrationId","typeLabel":"string"},"writeDestination":{"description":"Optional. S3 or GCS URI prefix to write outputs under (e.g. \"s3://my-bucket/outputs\" or \"gs://my-bucket/outputs\"). Requires storageIntegrationId. The source 'url' must also have a matching URI scheme (s3:// or gs://). The bucket must be covered by a configured storage integration. Outputs are written under \u003cwriteDestination>/\u003ctaskId>/*. Use output[].link for exact object locations. See Custom Storage Integrations.","format":"uri","type":"string","uniqueKey":"oneOf.1.writeDestination","typeLabel":"string\u003curi>"},"webhookUrl":{"description":"Optional. Webhook URL to notify when this Task completes. Overrides the global webhook URL configured in the dashboard for this Task only. See Using Webhooks.","format":"uri","type":"string","uniqueKey":"oneOf.1.webhookUrl","typeLabel":"string\u003curi>"},"metadata":{"description":"Client-provided metadata. Stored and returned as-is in responses and webhooks.","maxLength":4096,"type":"string","uniqueKey":"oneOf.1.metadata","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"assetId":"your_asset_id","targets":[{"model":"vocals","formats":["wav"]},{"model":"instrumental","formats":["wav"]}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"f3f6a6a5-c83f-49d1-97a0-a4cca81cf538":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Unique identifier of the Task","type":"string","uniqueKey":"id","typeLabel":"string"},"createdAt":{"format":"date-time","description":"Timestamp of when the Task was created","type":"string","uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"completedAt":{"oneOf":[{"type":"string","description":"Timestamp of when the Task was completed","format":"date-time","uniqueKey":"completedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","uniqueKey":"completedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"completedAt","typeLabel":"string\u003cdate-time> | null"},"clientId":{"description":"Unique identifier of the client","type":"string","uniqueKey":"clientId","typeLabel":"string"},"cost":{"description":"Processing cost in credits","type":"number","uniqueKey":"cost","typeLabel":"number"},"assetId":{"description":"Asset ID of an input media file. Mutually exclusive with url","type":"string","uniqueKey":"assetId","typeLabel":"string"},"url":{"oneOf":[{"type":"string","description":"URL of an input media file (HTTPS, s3://, or gs://). Mutually exclusive with assetId","uniqueKey":"url.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"url.oneOf.1","typeLabel":"null"}],"uniqueKey":"url","typeLabel":"string | null"},"storageIntegrationId":{"oneOf":[{"type":"string","description":"ID of the storage integration used to read the S3 or GCS input and write outputs. Only present when a storage integration was provided.","uniqueKey":"storageIntegrationId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"storageIntegrationId.oneOf.1","typeLabel":"null"}],"uniqueKey":"storageIntegrationId","typeLabel":"string | null"},"writeDestination":{"oneOf":[{"type":"string","description":"S3 or GCS URI prefix outputs were written under. The source 'url' must also have a matching URI scheme (s3:// or gs://). Outputs are written under \u003cwriteDestination>/\u003ctaskId>/*. Use output[].link for exact object locations. Only present when a custom write destination was provided.","uniqueKey":"writeDestination.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"writeDestination.oneOf.1","typeLabel":"null"}],"uniqueKey":"writeDestination","typeLabel":"string | null"},"metadata":{"description":"Client-provided metadata. Stored and returned as-is in responses and webhooks.","type":"string","uniqueKey":"metadata","typeLabel":"string"},"targets":{"description":"Processing targets and their current status","type":"array","items":{"type":"object","properties":{"id":{"description":"Unique identifier of the target","type":"string","isRequired":true,"uniqueKey":"targets.items.[INDEX].id","typeLabel":"string"},"model":{"description":"Model to run. See the Models page for available options. The special value \"residual\" returns one stem with everything the task's other targets don't cover; it requires at least one other target, all targets must use the same formats, and it cannot be combined with the per-target residual flag.","type":"string","isRequired":true,"uniqueKey":"targets.items.[INDEX].model","typeLabel":"string"},"status":{"description":"Status of the target: 'processing' β actively running; 'completed' β results ready in output; 'error' β see error field for details","enum":["processing","completed","error"],"type":"string","isRequired":true,"uniqueKey":"targets.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"formats":{"type":"array","items":{"description":"Output file formats (e.g. \"wav\", \"mp3\", \"json\")","type":"string","uniqueKey":"targets.items.[INDEX].formats.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"targets.items.[INDEX].formats","typeLabel":"string[]"},"output":{"description":"Downloadable output files for this target. Populated when status is \"completed\".","type":"array","items":{"type":"object","properties":{"name":{"description":"Filename of the output asset","type":"string","isRequired":true,"uniqueKey":"targets.items.[INDEX].output.items.[INDEX].name","typeLabel":"string"},"format":{"description":"Format of the output file","type":"string","isRequired":true,"uniqueKey":"targets.items.[INDEX].output.items.[INDEX].format","typeLabel":"string"},"link":{"description":"Presigned download URL. Expires after one hour β re-fetch the Task for a fresh link.","type":"string","isRequired":true,"uniqueKey":"targets.items.[INDEX].output.items.[INDEX].link","typeLabel":"string"}},"required":["name","format","link"],"uniqueKey":"targets.items.[INDEX].output.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"targets.items.[INDEX].output","typeLabel":"object[]"},"cost":{"description":"Processing cost in credits","type":"number","uniqueKey":"targets.items.[INDEX].cost","typeLabel":"number"},"error":{"oneOf":[{"type":"object","required":["code","message"],"properties":{"code":{"description":"Error code","type":"number","isRequired":true,"uniqueKey":"targets.items.[INDEX].error.oneOf.0.code","typeLabel":"number"},"message":{"description":"Error message","type":"string","isRequired":true,"uniqueKey":"targets.items.[INDEX].error.oneOf.0.message","typeLabel":"string"}},"uniqueKey":"targets.items.[INDEX].error.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"targets.items.[INDEX].error.oneOf.1","typeLabel":"null"}],"uniqueKey":"targets.items.[INDEX].error","typeLabel":"object | null"},"duration":{"description":"Processed audio duration in seconds","type":"number","uniqueKey":"targets.items.[INDEX].duration","typeLabel":"number"},"residual":{"description":"Include residual with results","type":"boolean","uniqueKey":"targets.items.[INDEX].residual","typeLabel":"boolean"},"language":{"description":"ISO 639-1 two-letter language code. Improves model accuracy and timing alignment for transcription and alignment models. If omitted, the model will attempt to auto-detect.","type":"string","uniqueKey":"targets.items.[INDEX].language","typeLabel":"string"},"transcriptUrl":{"description":"URL to transcript file for alignment","type":"string","uniqueKey":"targets.items.[INDEX].transcriptUrl","typeLabel":"string"},"transcriptAssetId":{"description":"Asset ID of a transcript for alignment","type":"string","uniqueKey":"targets.items.[INDEX].transcriptAssetId","typeLabel":"string"}},"required":["id","model","status","formats","output"],"uniqueKey":"targets.items.[INDEX]","typeLabel":"object"},"uniqueKey":"targets","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","completedAt":"2023-11-07T05:31:56Z","clientId":"\u003cstring>","cost":123,"assetId":"\u003cstring>","url":"\u003cstring>","storageIntegrationId":"\u003cstring>","writeDestination":"\u003cstring>","metadata":"\u003cstring>","targets":[{"id":"\u003cstring>","model":"\u003cstring>","status":"processing","formats":["\u003cstring>"],"output":[{"name":"\u003cstring>","format":"\u003cstring>","link":"\u003cstring>"}],"cost":123,"error":{"code":123,"message":"\u003cstring>"},"duration":123,"residual":true,"language":"\u003cstring>","transcriptUrl":"\u003cstring>","transcriptAssetId":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"a0519df1-ffb6-499a-acef-d5e8025d0928":{"apiKey":{"type":"apiKey","name":"x-api-key","in":"header","scopes":[],"schemeName":"apiKey"}}},"servers":{"f0388a2e-b12d-4398-a608-73b703f15e29":{"url":"https://api.audioshake.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"x-api-key","in":"header","scopes":[],"schemeName":"apiKey"},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"x-api-key"}],"title":"apiKey"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"audioshake","siteName":"AudioShake Developers","title":"Create Task - AudioShake Developers","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-05T00:38:39.104Z","originalFileLocation":"api-reference/tasks/create.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=\"application-name\" content=\"AudioShake Developers\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/audioshake/_t23WT7AtnufNpIq/_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/audioshake/_t23WT7AtnufNpIq/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/audioshake/_t23WT7AtnufNpIq/_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/audioshake/_t23WT7AtnufNpIq/_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/audioshake/_t23WT7AtnufNpIq/_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/audioshake/_t23WT7AtnufNpIq/_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/audioshake/_t23WT7AtnufNpIq/_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/audioshake/_t23WT7AtnufNpIq/_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/audioshake/_t23WT7AtnufNpIq/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Task - AudioShake Developers\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"AudioShake Developers\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.audioshake.ai/api-reference/tasks/create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://audioshake.mintlify.site/_mintlify/api/og/v2?division=Tasks\u0026amp;title=Create+Task\u0026amp;theme=18215f91953d15a46f7b6a9f\u0026amp;signature=b3998592d3a44320891a3592e67d10f67c9a61ae7431afb92de5e4fe33d4afde\">\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=\"Create Task - AudioShake Developers\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://audioshake.mintlify.site/_mintlify/api/og/v2?division=Tasks\u0026amp;title=Create+Task\u0026amp;theme=18215f91953d15a46f7b6a9f\u0026amp;signature=b3998592d3a44320891a3592e67d10f67c9a61ae7431afb92de5e4fe33d4afde\">\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/audioshake/_t23WT7AtnufNpIq/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"AudioShake Developers\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0F7A6E\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.audioshake.ai/api-reference/tasks/create\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/tasks/create.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.audioshake.ai/#organization\",\"name\":\"AudioShake Developers\",\"url\":\"https://developer.audioshake.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/audioshake/a4R6sqRrLL6RJwFi/logo/audioshake-logo-light.svg?fit=max\u0026auto=format\u0026n=a4R6sqRrLL6RJwFi\u0026q=85\u0026s=b0de973196be153f8f4ccd6aca4ebdbb\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.audioshake.ai#website\",\"name\":\"AudioShake Developers\",\"url\":\"https://developer.audioshake.ai\",\"publisher\":{\"@id\":\"https://developer.audioshake.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.audioshake.ai/api-reference/tasks/create#webpage\",\"url\":\"https://developer.audioshake.ai/api-reference/tasks/create\",\"name\":\"Create Task\",\"dateModified\":\"2026-11-05T00:38:39.104Z\",\"isPartOf\":{\"@id\":\"https://developer.audioshake.ai#website\"},\"breadcrumb\":{\"@id\":\"https://developer.audioshake.ai/api-reference/tasks/create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.audioshake.ai/api-reference/tasks/create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"AudioShake Developers\",\"item\":\"https://developer.audioshake.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Task\",\"item\":\"https://developer.audioshake.ai/api-reference/tasks/create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.audioshake.ai/api-reference/tasks/create#apireference\",\"headline\":\"Create Task\",\"name\":\"Create Task\",\"url\":\"https://developer.audioshake.ai/api-reference/tasks/create\",\"mainEntityOfPage\":{\"@id\":\"https://developer.audioshake.ai/api-reference/tasks/create#webpage\"},\"dateModified\":\"2026-11-05T00:38:39.104Z\",\"publisher\":{\"@id\":\"https://developer.audioshake.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.audioshake.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"AudioShake Developers\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"AudioShake Developers","nav":{"global":{"anchors":[{"anchor":"Documentation","icon":"book-open-cover","href":"/"},{"anchor":"API Reference","icon":"terminal","href":"/api-reference/authentication"},{"anchor":"Blog","icon":"newspaper","href":"https://www.audioshake.ai/blog"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","groups":[{"group":"API Overview","pages":[{"title":"Authentication","icon":"key","href":"/api-reference/authentication"},{"title":"Formats","icon":"file-audio","href":"/api-reference/formats"},{"title":"Languages","icon":"globe","href":"/api-reference/languages"},{"title":"Rate Limits","icon":"gauge","href":"/api-reference/rate-limits"},{"title":"Webhooks","icon":"bell","href":"/api-reference/tasks/webhooks"},{"title":"Custom Storage Integrations","icon":"cloud","href":"/api-reference/custom-storage"}]},{"group":"Assets","pages":[{"title":"Upload File","openapi":"POST /assets","href":"/api-reference/assets/upload"},{"title":"Get Asset by ID","openapi":"GET /assets/{id}","href":"/api-reference/assets/get"},{"title":"List Assets","openapi":"GET /assets","href":"/api-reference/assets/list"}]},{"group":"Models","pages":[{"title":"List Models","openapi":"GET /models","description":"Public endpoint. Unauthenticated requests return default app config values. Authenticated requests return client-specific access and pricing.","href":"/api-reference/models/list"}]},{"group":"Tasks","pages":[{"title":"Create Task","openapi":"POST /tasks","href":"/api-reference/tasks/create"},{"title":"Get Task by ID","openapi":"GET /tasks/{id}","description":null,"href":"/api-reference/tasks/get"},{"title":"List Tasks","openapi":"GET /tasks","href":"/api-reference/tasks/list"},{"title":"Task Statistics","openapi":"GET /tasks/statistics","href":"/api-reference/tasks/statistics"}]},{"group":"Storage Integrations","pages":[{"title":"Create Storage Integration","openapi":"POST /storage-integrations","href":"/api-reference/storage-integrations/create"},{"title":"List Storage Integrations","openapi":"GET /storage-integrations","href":"/api-reference/storage-integrations/list"},{"title":"Get Storage Integration","openapi":"GET /storage-integrations/{id}","href":"/api-reference/storage-integrations/get"},{"title":"Update Storage Integration","openapi":"PUT /storage-integrations/{id}","href":"/api-reference/storage-integrations/update"},{"title":"Delete Storage Integration","openapi":"DELETE /storage-integrations/{id}","href":"/api-reference/storage-integrations/delete"},{"title":"Test Storage Integration","openapi":"POST /storage-integrations/test","href":"/api-reference/storage-integrations/test"}]}]}]},"basePath":"","title":"Create Task - AudioShake Developers","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-Cj6eAYhz.js","dist-CdrJecqK.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-D-TRO5q5.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-5FCzAcfS.js","utils-SLtAG4EZ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-2DZi8ZMu.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D7J3nkzE.js","snippetPresets-D0Alv0AH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BI4qNJ2c.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BD3uyr8j.js","shallow-D8iEBr5z.js","getApiPlaygroundDisplay-CgNP4lzR.js","CodeSnippet-CX-QHuMs.js","CodeSnippets-VlXE-ZUf.js","Page-D9ithiIZ.js","getPastedJson-DYNQkZ1M.js","icon-CzacdwOi.js","MethodPill-2JVqoYKi.js","DuplicateIcon-_xVXs-U8.js","createIcon-BRHrweLo.js","DynamicMarkdown-mQG_iQiE.js","SectionHeading-DMpJzv8f.js","axios-vUo_bRtp.js","Markdown-5FGIym-8.js","AssistantPageLink-CHlcWBLM.js"]}