Prepare an instruction and matching audition script in the source voice’s language. Reuse the returned token to compare candidates with the same performance. This step does not create audio or reserve generation credits.
POST
/
v1
/
voice-previews
/
remix
/
prepare
cURL
curl \ --request POST \ --url "https://api.breeze.blue/v1/voice-previews/remix/prepare" \ --header "xi-api-key: $BREEZE_API_KEY" \ --header "Content-Type: application/json" \ --data '{ "voice_id": "voc_xeh3w54cqvnp", "prompt": "Make the voice older and softer."}'
import os
from breeze_blue import BreezeBlue
client = BreezeBlue(api_key=os.environ["BREEZE_API_KEY"])
prepared = client.voices.prepare_remix_preview(
voice_id="voc_xeh3w54cqvnp",
prompt="Make the voice older and softer.",
)
print(prepared["preparation_token"])
import { BreezeBlueClient } from "@breeze.blue/sdk";
const client = new BreezeBlueClient({
apiKey: process.env.BREEZE_API_KEY!,
});
const prepared = await client.voices.prepareRemixPreview({
voiceId: "voc_xeh3w54cqvnp",
prompt: "Make the voice older and softer.",
});
console.log(prepared.preparationToken);
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Breeze Blue","description":"Reference documentation, guides, and quickstarts for the Breeze Developer API, SDKs, and CLI.","colors":{"primary":"#0B5AD2","light":"#3D78DC","dark":"#0B5AD2"},"logo":{"light":"https://mintcdn.com/breezeblue/HJi9cL24BjuobeR3/logo-light.png?fit=max\u0026auto=format\u0026n=HJi9cL24BjuobeR3\u0026q=85\u0026s=64b2b794b84ec5e5975584a36d52f1cd","dark":"https://mintcdn.com/breezeblue/HJi9cL24BjuobeR3/logo-dark.png?fit=max\u0026auto=format\u0026n=HJi9cL24BjuobeR3\u0026q=85\u0026s=f5a080d68beff8740d65ef033ab6b564","href":"https://breezeblue.ai"},"favicon":"https://mintcdn.com/breezeblue/uwKEVtPuSz6xAzRM/favicon.png?fit=max\u0026auto=format\u0026n=uwKEVtPuSz6xAzRM\u0026q=85\u0026s=341474510af96418bfb8d36f42125d88","api":{"examples":{"autogenerate":false}},"appearance":{"default":"system","strict":false},"navbar":{"links":[{"href":"https://breezeblue.ai","label":"Breeze Blue"},{"href":"https://breezeblue.ai/app/developer","label":"Developer Console"}],"primary":{"type":"button","label":"Open Studio","href":"https://breezeblue.ai/app"}},"footer":{"socials":{"website":"https://breezeblue.ai","discord":"https://discord.gg/6H7AgPe9pA","x":"https://x.com/BreezeBlueX"},"links":[{"header":"Product","items":[{"label":"Creator","href":"https://breezeblue.ai/app"},{"label":"API","href":"/api-reference/introduction"},{"label":"CLI","href":"/cli"}]},{"header":"Explore","items":[{"label":"Bluebell","href":"https://breezeblue.ai/bluebell"},{"label":"Voice Galaxy","href":"https://breezeblue.ai/labs/voice-galaxy"}]},{"header":"Company","items":[{"label":"About","href":"https://breezeblue.ai/about"},{"label":"Blog","href":"https://breezeblue.ai/blog"},{"label":"Contact","href":"https://breezeblue.ai/contact"},{"label":"Email","href":"mailto:[email protected]"}]},{"header":"Legal","items":[{"label":"Privacy","href":"https://breezeblue.ai/legal/privacy"},{"label":"Terms","href":"https://breezeblue.ai/legal/terms"}]}]},"seo":{"metatags":{"google-site-verification":"eAqPjwtfRocfzlfoMcCcsjpUiDlOBlWswzYSNGb_D4s"},"indexing":"navigable"},"icons":{"library":"lucide"},"contextual":{"options":["copy","download-spec","chatgpt","claude"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"breezeblue","hasAudioNarration":false,"actualSubdomain":"breezeblue","customDomains":["docs.breezeblue.ai"],"gitSource":{"type":"github","owner":"breezebluestudio","repo":"breezebluestudio","deployBranch":"main","contentDirectory":"developer-docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae9f83c22dab27fc6c0c7cb","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API Reference","count":85},{"language":"default","tag":"Studio","count":42},{"language":"default","tag":"Documentation","count":23},{"language":"default","tag":"CLI Reference","count":13},{"language":"default","tag":"Guides","count":13},{"language":"default","tag":"Account","count":12},{"language":"default","tag":"Voice Previews","count":11},{"language":"default","tag":"Text to Speech","count":8},{"language":"default","tag":"Voices","count":6},{"language":"default","tag":"Get started","count":5}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#api-playground-2-operation-page .mdx-content:has(>.api-next-steps){display:flex;flex-direction:column}#api-playground-2-operation-page .mdx-content>.api-next-steps{order:1}"}],"page":{"pagePath":"api-reference/voice-previews/prepare-remix-preview","slug":"/api-reference/voice-previews/prepare-remix-preview","pageMetadata":{"title":"Prepare remix preview","description":"Prepare an instruction and matching audition script in the source voice's language. Reuse the returned token to compare candidates with the same performance. This step does not create audio or reserve generation credits.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/voice-previews/remix/prepare","href":"/api-reference/voice-previews/prepare-remix-preview","autogeneratedByOpenApi":true},"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: \"Prepare an instruction and matching audition script in the source voice’s language. Reuse the returned token to compare candidates with the same performance. This step does not create audio or reserve generation credits.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const{Card,Columns,Heading}={..._provideComponents(),...props.components};if(!Card)_missingMdxReference(`Card`,true);if(!Columns)_missingMdxReference(`Columns`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(`section`,{className:`api-next-steps`,\"aria-label\":`Continue building`,children:[_jsx(Heading,{level:`2`,id:`continue-building`,children:`Continue building`}),_jsxs(Columns,{cols:2,children:[_jsx(Card,{title:`Create remix preview`,icon:`braces`,href:`/api-reference/voice-previews/create-remix-preview`,children:`Generate a candidate using the prepared performance.`}),_jsx(Card,{title:`Voice Remix`,icon:`book-open`,href:`/guides/voice-remix`,children:`Compare strengths with a shared preparation.`})]})]})}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":"Prepare remix preview","description":"Prepare an instruction and matching audition script in the source voice's language. Reuse the returned token to compare candidates with the same performance. This step does not create audio or reserve generation credits.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/voice-previews/remix/prepare","href":"/api-reference/voice-previews/prepare-remix-preview","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Continue building","slug":"continue-building","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Voice Previews"],"summary":"Prepare remix preview","description":"Prepare an instruction and matching audition script in the source voice's language. Reuse the returned token to compare candidates with the same performance. This step does not create audio or reserve generation credits.","operationId":"voice_previews_remix_prepare","requestBody":"b1dd1848-96c0-4cfb-9126-79c3d8d18a84","responses":{"200":"bfeb34e0-2e00-4e1b-9247-e82196677c07","401":"532eefc3-2d91-4b95-99ca-1d3984497b02","404":"fee012d2-4929-45f9-ac27-da2eeca41f54","422":"f9015e51-59f2-4df0-bd45-0fdb6636f0e3","502":"2010731e-702a-45ba-92ed-f302cf826d0e","503":"cc3835ea-e16c-4ea5-8c1d-2036f5239493"},"x-mint":{"content":"\u003csection className=\"api-next-steps\" aria-label=\"Continue building\">\n\n## Continue building\n\n\u003cColumns cols={2}>\n\u003cCard title=\"Create remix preview\" icon=\"braces\" href=\"/api-reference/voice-previews/create-remix-preview\">Generate a candidate using the prepared performance.\u003c/Card>\n\u003cCard title=\"Voice Remix\" icon=\"book-open\" href=\"/guides/voice-remix\">Compare strengths with a shared preparation.\u003c/Card>\n\u003c/Columns>\n\n\u003c/section>"},"x-breeze-api-name":"Prepare remix preview","x-breeze-docs-group":"Voice Previews","x-breeze-docs-href":"/docs/api-reference/voice-previews/remix-prepare","x-breeze-errors":[{"code":"RESOURCE_NOT_FOUND","description":"The source voice is not available for remixing."},{"code":"VALIDATION_ERROR","description":"Provide a prompt or valid preset ID and a usable source voice."},{"code":"VOICE_REMIX_FAILED","description":"Preparation failed; no generation credits were reserved."}],"security":["bda12bcf-dff5-47dc-8f58-2757d70e0a6c"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl \\\n --request POST \\\n --url \"https://api.breeze.blue/v1/voice-previews/remix/prepare\" \\\n --header \"xi-api-key: $BREEZE_API_KEY\" \\\n --header \"Content-Type: application/json\" \\\n --data '{\n \"voice_id\": \"voc_xeh3w54cqvnp\",\n \"prompt\": \"Make the voice older and softer.\"\n}'"},{"lang":"Python","label":"Python SDK","source":"import os\n\nfrom breeze_blue import BreezeBlue\n\nclient = BreezeBlue(api_key=os.environ[\"BREEZE_API_KEY\"])\n\nprepared = client.voices.prepare_remix_preview(\n voice_id=\"voc_xeh3w54cqvnp\",\n prompt=\"Make the voice older and softer.\",\n)\nprint(prepared[\"preparation_token\"])"},{"lang":"TypeScript","label":"TypeScript SDK","source":"import { BreezeBlueClient } from \"@breeze.blue/sdk\";\n\nconst client = new BreezeBlueClient({\n apiKey: process.env.BREEZE_API_KEY!,\n});\n\nconst prepared = await client.voices.prepareRemixPreview({\n voiceId: \"voc_xeh3w54cqvnp\",\n prompt: \"Make the voice older and softer.\",\n});\nconsole.log(prepared.preparationToken);"}],"method":"post","type":"path","servers":["8bb76e4e-0975-4cf1-8ac6-7bf2353dcdda"],"path":"/v1/voice-previews/remix/prepare","baseUrlOptions":["https://api.breeze.blue"],"title":"Prepare remix preview","codeSamples":[{"label":"cURL","lang":"cURL","source":"curl \\\n --request POST \\\n --url \"https://api.breeze.blue/v1/voice-previews/remix/prepare\" \\\n --header \"xi-api-key: $BREEZE_API_KEY\" \\\n --header \"Content-Type: application/json\" \\\n --data '{\n \"voice_id\": \"voc_xeh3w54cqvnp\",\n \"prompt\": \"Make the voice older and softer.\"\n}'"},{"label":"Python SDK","lang":"Python","source":"import os\n\nfrom breeze_blue import BreezeBlue\n\nclient = BreezeBlue(api_key=os.environ[\"BREEZE_API_KEY\"])\n\nprepared = client.voices.prepare_remix_preview(\n voice_id=\"voc_xeh3w54cqvnp\",\n prompt=\"Make the voice older and softer.\",\n)\nprint(prepared[\"preparation_token\"])"},{"label":"TypeScript SDK","lang":"TypeScript","source":"import { BreezeBlueClient } from \"@breeze.blue/sdk\";\n\nconst client = new BreezeBlueClient({\n apiKey: process.env.BREEZE_API_KEY!,\n});\n\nconst prepared = await client.voices.prepareRemixPreview({\n voiceId: \"voc_xeh3w54cqvnp\",\n prompt: \"Make the voice older and softer.\",\n});\nconsole.log(prepared.preparationToken);"}],"requiredOnlyExamples":false,"disableCodeSampleGeneration":true,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"properties":{"voice_id":{"type":"string","maxLength":64,"minLength":1,"title":"Voice Id","description":"Your own or an available official voice ID. See [List voices](https://docs.breezeblue.ai/api-reference/voices/list-voices).","isRequired":true,"uniqueKey":"voice_id","typeLabel":"string"},"prompt":{"oneOf":[{"type":"string","title":"Prompt","description":"Desired voice change. Required unless preset_id selects a preset. Custom and edited preset descriptions are enhanced automatically.","maxLength":1000,"minLength":3,"uniqueKey":"prompt.oneOf.0","typeLabel":"string"},{"type":"null","title":"Prompt","description":"Desired voice change. Required unless preset_id selects a preset. Custom and edited preset descriptions are enhanced automatically.","uniqueKey":"prompt.oneOf.1","typeLabel":"null"}],"uniqueKey":"prompt","typeLabel":"string | null"},"preset_id":{"oneOf":[{"type":"string","title":"Preset Id","description":"ID from the remix preset catalog. An unchanged preset uses its curated instruction and script, translated when needed.","maxLength":64,"minLength":1,"uniqueKey":"preset_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Preset Id","description":"ID from the remix preset catalog. An unchanged preset uses its curated instruction and script, translated when needed.","uniqueKey":"preset_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"preset_id","typeLabel":"string | null"}},"additionalProperties":false,"type":"object","required":["voice_id"],"title":"VoiceRemixPrepareRequest","description":"Prepare a custom description or a curated preset in the source language.","uniqueKey":"","typeLabel":"VoiceRemixPrepareRequest · object"},"examples":{"Example":{"title":"Example","value":{"voice_id":"\u003cstring>","prompt":"\u003cstring>","preset_id":"\u003cstring>"}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"bfeb34e0-2e00-4e1b-9247-e82196677c07":{"description":"Prepared remix performance.","content":{"application/json":{"schema":{"properties":{"preparation_token":{"description":"Valid for 24 hours for the same account, source, language, prompt and preset. Reuse across candidate strengths.","title":"Preparation Token","type":"string","isRequired":true,"uniqueKey":"preparation_token","typeLabel":"string"},"language_code":{"title":"Language Code","type":"string","description":"See [supported language codes](https://docs.breezeblue.ai/concepts/multilingual).","isRequired":true,"uniqueKey":"language_code","typeLabel":"string"},"instruction":{"title":"Instruction","type":"string","isRequired":true,"uniqueKey":"instruction","typeLabel":"string"},"text":{"title":"Text","type":"string","isRequired":true,"uniqueKey":"text","typeLabel":"string"},"source_voice":{"properties":{"voice_id":{"oneOf":[{"type":"string","title":"Voice Id","uniqueKey":"source_voice.voice_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Voice Id","uniqueKey":"source_voice.voice_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"source_voice.voice_id","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","title":"Name","uniqueKey":"source_voice.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","uniqueKey":"source_voice.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"source_voice.name","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","title":"Description","uniqueKey":"source_voice.description.oneOf.0","typeLabel":"string"},{"type":"null","title":"Description","uniqueKey":"source_voice.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"source_voice.description","typeLabel":"string | null"}},"title":"VoiceRemixSourceResponse","type":"object","isRequired":true,"uniqueKey":"source_voice","typeLabel":"VoiceRemixSourceResponse · object"}},"required":["preparation_token","language_code","instruction","text","source_voice"],"title":"VoiceRemixPreparationResponse","type":"object","uniqueKey":"","typeLabel":"VoiceRemixPreparationResponse · object"},"examples":{"Example":{"title":"Example","value":{"preparation_token":"\u003cstring>","language_code":"\u003cstring>","instruction":"\u003cstring>","text":"\u003cstring>","source_voice":{"voice_id":"\u003cstring>","name":"\u003cstring>","description":"\u003cstring>"}}}},"exampleType":"generated"}},"headers":{"x-breeze-api-key-id":{"description":"Public API key identifier used to authenticate the request, when an API key was used.","schema":{"type":"string"}}},"exampleType":"generated"},"532eefc3-2d91-4b95-99ca-1d3984497b02":{"description":"HTTP 401 error response.","content":{"application/json":{"schema":{"properties":{"code":{"title":"Code","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"title":"Detail","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"error":{"title":"Error","type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"ok":{"default":false,"title":"Ok","type":"boolean","uniqueKey":"ok","typeLabel":"boolean"},"meta":{"oneOf":[{"type":"object","title":"Meta","additionalProperties":true,"uniqueKey":"meta.oneOf.0","typeLabel":"Meta · object"},{"type":"null","title":"Meta","uniqueKey":"meta.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta","typeLabel":"Meta · object | null"}},"required":["code","detail","error"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","detail":"\u003cstring>","error":"\u003cstring>","ok":false,"meta":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"fee012d2-4929-45f9-ac27-da2eeca41f54":{"description":"HTTP 404 error response.","content":{"application/json":{"schema":{"properties":{"code":{"title":"Code","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"title":"Detail","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"error":{"title":"Error","type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"ok":{"default":false,"title":"Ok","type":"boolean","uniqueKey":"ok","typeLabel":"boolean"},"meta":{"oneOf":[{"type":"object","title":"Meta","additionalProperties":true,"uniqueKey":"meta.oneOf.0","typeLabel":"Meta · object"},{"type":"null","title":"Meta","uniqueKey":"meta.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta","typeLabel":"Meta · object | null"}},"required":["code","detail","error"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","detail":"\u003cstring>","error":"\u003cstring>","ok":false,"meta":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"f9015e51-59f2-4df0-bd45-0fdb6636f0e3":{"description":"HTTP 422 error response.","content":{"application/json":{"schema":{"properties":{"code":{"title":"Code","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"title":"Detail","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"error":{"title":"Error","type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"ok":{"default":false,"title":"Ok","type":"boolean","uniqueKey":"ok","typeLabel":"boolean"},"meta":{"oneOf":[{"type":"object","title":"Meta","additionalProperties":true,"uniqueKey":"meta.oneOf.0","typeLabel":"Meta · object"},{"type":"null","title":"Meta","uniqueKey":"meta.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta","typeLabel":"Meta · object | null"}},"required":["code","detail","error"],"title":"ValidationErrorResponse","type":"object","uniqueKey":"","typeLabel":"ValidationErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","detail":"\u003cstring>","error":"\u003cstring>","ok":false,"meta":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"2010731e-702a-45ba-92ed-f302cf826d0e":{"description":"HTTP 502 error response.","content":{"application/json":{"schema":{"properties":{"code":{"title":"Code","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"title":"Detail","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"error":{"title":"Error","type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"ok":{"default":false,"title":"Ok","type":"boolean","uniqueKey":"ok","typeLabel":"boolean"},"meta":{"oneOf":[{"type":"object","title":"Meta","additionalProperties":true,"uniqueKey":"meta.oneOf.0","typeLabel":"Meta · object"},{"type":"null","title":"Meta","uniqueKey":"meta.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta","typeLabel":"Meta · object | null"}},"required":["code","detail","error"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","detail":"\u003cstring>","error":"\u003cstring>","ok":false,"meta":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"cc3835ea-e16c-4ea5-8c1d-2036f5239493":{"description":"HTTP 503 error response.","content":{"application/json":{"schema":{"properties":{"code":{"title":"Code","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"title":"Detail","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"error":{"title":"Error","type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"ok":{"default":false,"title":"Ok","type":"boolean","uniqueKey":"ok","typeLabel":"boolean"},"meta":{"oneOf":[{"type":"object","title":"Meta","additionalProperties":true,"uniqueKey":"meta.oneOf.0","typeLabel":"Meta · object"},{"type":"null","title":"Meta","uniqueKey":"meta.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta","typeLabel":"Meta · object | null"}},"required":["code","detail","error"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","detail":"\u003cstring>","error":"\u003cstring>","ok":false,"meta":{}}}},"exampleType":"generated"}},"headers":{"Retry-After":{"description":"When provided, seconds to wait before retrying a rate or shared-capacity rejection.","schema":{"type":"integer","minimum":0,"maximum":3600}}},"exampleType":"generated"}},"security":{"bda12bcf-dff5-47dc-8f58-2757d70e0a6c":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"xi-api-key","description":"Breeze Developer API key.","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"8bb76e4e-0975-4cf1-8ac6-7bf2353dcdda":{"url":"https://api.breeze.blue"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"xi-api-key","description":"Breeze Developer API key.","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"xi-api-key","type":"string","description":"Breeze Developer API key.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"xi-api-key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"breezeblue","siteName":"Breeze Blue","title":"Prepare remix preview - Breeze Blue","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-03T10:08:57.898Z","originalFileLocation":"api-reference/voice-previews/prepare-remix-preview.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=\"Prepare an instruction and matching audition script in the source voice\u0026#x27;s language. Reuse the returned token to compare candidates with the same performance. This step does not create audio or reserve generation credits.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Breeze Blue\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/breezeblue/EfwzJlIYKxgPDxPM/_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/breezeblue/EfwzJlIYKxgPDxPM/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/breezeblue/EfwzJlIYKxgPDxPM/_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/breezeblue/EfwzJlIYKxgPDxPM/_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/breezeblue/EfwzJlIYKxgPDxPM/_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/breezeblue/EfwzJlIYKxgPDxPM/_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/breezeblue/EfwzJlIYKxgPDxPM/_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/breezeblue/EfwzJlIYKxgPDxPM/_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/breezeblue/EfwzJlIYKxgPDxPM/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Prepare remix preview - Breeze Blue\">\u003cmeta data-mint-head property=\"og:description\" content=\"Prepare an instruction and matching audition script in the source voice\u0026#x27;s language. Reuse the returned token to compare candidates with the same performance. This step does not create audio or reserve generation credits.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Breeze Blue\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.breezeblue.ai/api-reference/voice-previews/prepare-remix-preview\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://breezeblue.mintlify.site/_mintlify/api/og/v2?division=Voice+Previews\u0026amp;title=Prepare+remix+preview\u0026amp;description=Prepare+an+instruction+and+matching+audition+script+in+the+source+voice%27s+language.+Reuse+the+returned+token+to+compare+candidates+with+the+same+performance.+Th\u0026amp;theme=3740d9931486a261965ee039\u0026amp;signature=dabc2902d0836fb5323722ba1e19270744bdc612d01f7c09df250c97b236c787\">\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=\"Prepare remix preview - Breeze Blue\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Prepare an instruction and matching audition script in the source voice\u0026#x27;s language. Reuse the returned token to compare candidates with the same performance. This step does not create audio or reserve generation credits.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://breezeblue.mintlify.site/_mintlify/api/og/v2?division=Voice+Previews\u0026amp;title=Prepare+remix+preview\u0026amp;description=Prepare+an+instruction+and+matching+audition+script+in+the+source+voice%27s+language.+Reuse+the+returned+token+to+compare+candidates+with+the+same+performance.+Th\u0026amp;theme=3740d9931486a261965ee039\u0026amp;signature=dabc2902d0836fb5323722ba1e19270744bdc612d01f7c09df250c97b236c787\">\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/breezeblue/EfwzJlIYKxgPDxPM/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Breeze Blue\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0B5AD2\">\u003cmeta data-mint-head name=\"google-site-verification\" content=\"eAqPjwtfRocfzlfoMcCcsjpUiDlOBlWswzYSNGb_D4s\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.breezeblue.ai/api-reference/voice-previews/prepare-remix-preview\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/voice-previews/prepare-remix-preview.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.breezeblue.ai/#organization\",\"name\":\"Breeze Blue\",\"url\":\"https://docs.breezeblue.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/breezeblue/HJi9cL24BjuobeR3/logo-light.png?fit=max\u0026auto=format\u0026n=HJi9cL24BjuobeR3\u0026q=85\u0026s=64b2b794b84ec5e5975584a36d52f1cd\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.breezeblue.ai#website\",\"name\":\"Breeze Blue\",\"url\":\"https://docs.breezeblue.ai\",\"publisher\":{\"@id\":\"https://docs.breezeblue.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.breezeblue.ai/api-reference/voice-previews/prepare-remix-preview#webpage\",\"url\":\"https://docs.breezeblue.ai/api-reference/voice-previews/prepare-remix-preview\",\"name\":\"Prepare remix preview\",\"description\":\"Prepare an instruction and matching audition script in the source voice's language. Reuse the returned token to compare candidates with the same performance. This step does not create audio or reserve generation credits.\",\"dateModified\":\"2026-11-03T10:08:57.898Z\",\"isPartOf\":{\"@id\":\"https://docs.breezeblue.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.breezeblue.ai/api-reference/voice-previews/prepare-remix-preview#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.breezeblue.ai/api-reference/voice-previews/prepare-remix-preview#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Voice Previews\",\"item\":\"https://docs.breezeblue.ai/api-reference/voice-previews/create-clone-preview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Prepare remix preview\",\"item\":\"https://docs.breezeblue.ai/api-reference/voice-previews/prepare-remix-preview\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.breezeblue.ai/api-reference/voice-previews/prepare-remix-preview#apireference\",\"headline\":\"Prepare remix preview\",\"name\":\"Prepare remix preview\",\"description\":\"Prepare an instruction and matching audition script in the source voice's language. Reuse the returned token to compare candidates with the same performance. This step does not create audio or reserve generation credits.\",\"url\":\"https://docs.breezeblue.ai/api-reference/voice-previews/prepare-remix-preview\",\"mainEntityOfPage\":{\"@id\":\"https://docs.breezeblue.ai/api-reference/voice-previews/prepare-remix-preview#webpage\"},\"dateModified\":\"2026-11-03T10:08:57.898Z\",\"publisher\":{\"@id\":\"https://docs.breezeblue.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.breezeblue.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Breeze Blue\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Breeze Blue","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","groups":[{"group":"Overview","icon":"braces","pages":[{"title":"API reference introduction","href":"/api-reference/introduction"}]},{"group":"Models","pages":[{"title":"List models","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/models","href":"/api-reference/models/list-models"}]},{"group":"Text to Speech","pages":[{"title":"Convert text to speech","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/text-to-speech/{voice_id}","href":"/api-reference/text-to-speech/convert-text-to-speech"},{"title":"Convert with timestamps","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/text-to-speech/{voice_id}/with-timestamps","href":"/api-reference/text-to-speech/convert-with-timestamps"},{"title":"Get generation job","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/generation-jobs/{generation_job_id}","href":"/api-reference/text-to-speech/get-generation-job"},{"title":"Download generation job audio","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/generation-jobs/{generation_job_id}/audio","href":"/api-reference/text-to-speech/download-generation-job-audio"},{"title":"Stream text to speech","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/text-to-speech/{voice_id}/stream","href":"/api-reference/text-to-speech/stream-text-to-speech"},{"title":"Stream speech with word timestamps","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/text-to-speech/{voice_id}/stream/with-timestamps","href":"/api-reference/text-to-speech/stream-speech-with-word-timestamps"},{"title":"Create realtime TTS session","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/text-to-speech/{voice_id}/realtime-sessions","href":"/api-reference/text-to-speech/create-realtime-tts-session"},{"title":"Enhance text to speech instruction","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/text-to-speech/enhance","href":"/api-reference/text-to-speech/enhance-text-to-speech-instruction"}]},{"group":"Voices","pages":[{"title":"List Voice Metadata options","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/voice-metadata/options","href":"/api-reference/voices/list-voice-metadata-options"},{"title":"List voices","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/voices","href":"/api-reference/voices/list-voices"},{"title":"Get a voice","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/voices/{voice_id}","href":"/api-reference/voices/get-a-voice"},{"title":"Delete a voice","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/voices/{voice_id}","href":"/api-reference/voices/delete-a-voice"},{"title":"Edit a voice","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/voices/{voice_id}","href":"/api-reference/voices/edit-a-voice"},{"title":"Update effective voice tags","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/voices/{voice_id}/tags","href":"/api-reference/voices/update-effective-voice-tags"}]},{"group":"Voice Previews","pages":[{"title":"Create clone preview","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/voice-previews/clone","href":"/api-reference/voice-previews/create-clone-preview"},{"title":"Create design previews","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/voice-previews/design","href":"/api-reference/voice-previews/create-design-previews"},{"title":"Stream a design preview","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/voice-previews/design/stream","href":"/api-reference/voice-previews/stream-a-design-preview"},{"title":"List remix presets","description":"Browse curated voice changes and their sample recordings. Use a preset ID when preparing or generating a remix. Browsing does not spend credits.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/voice-previews/remix/presets","href":"/api-reference/voice-previews/list-remix-presets"},{"title":"Prepare remix preview","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/voice-previews/remix/prepare","href":"/api-reference/voice-previews/prepare-remix-preview"},{"title":"Create remix preview","description":"Create one same-language voice candidate from an owned or official voice and a prompt. Poll the durable job, audition its preview, then save a private new voice. The source voice is never changed.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/voice-previews/remix","href":"/api-reference/voice-previews/create-remix-preview"},{"title":"Get remix preview","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/voice-previews/remix/{generation_job_id}","href":"/api-reference/voice-previews/get-remix-preview"},{"title":"Create localize preview","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/voice-previews/localize","href":"/api-reference/voice-previews/create-localize-preview"},{"title":"Get localize preview","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/voice-previews/localize/{generation_job_id}","href":"/api-reference/voice-previews/get-localize-preview"},{"title":"Download completed voice preview","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/voice-previews/{generated_voice_id}/stream","href":"/api-reference/voice-previews/download-completed-voice-preview"},{"title":"Save voice preview","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/voice-previews/{generated_voice_id}/save","href":"/api-reference/voice-previews/save-voice-preview"}]},{"group":"Account","pages":[{"title":"Get account balance","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/balance","href":"/api-reference/account/get-account-balance"},{"title":"Get account entitlements","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/entitlements","href":"/api-reference/account/get-account-entitlements"},{"title":"Get usage metering","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/usage","href":"/api-reference/account/get-usage-metering"},{"title":"List API keys","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/api-keys","href":"/api-reference/account/list-api-keys"},{"title":"Create an API key","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/api-keys","href":"/api-reference/account/create-an-api-key"},{"title":"Get the current API key","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/api-keys/current","href":"/api-reference/account/get-the-current-api-key"},{"title":"Delete an API key","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/api-keys/{key_id}","href":"/api-reference/account/delete-an-api-key"},{"title":"Update an API key","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/api-keys/{key_id}","href":"/api-reference/account/update-an-api-key"},{"title":"Disable an API key","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/api-keys/{key_id}/disable","href":"/api-reference/account/disable-an-api-key"},{"title":"Enable an API key","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/api-keys/{key_id}/enable","href":"/api-reference/account/enable-an-api-key"},{"title":"Rotate an API key","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/api-keys/{key_id}/rotate","href":"/api-reference/account/rotate-an-api-key"},{"title":"Reset an API key credit budget","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/api-keys/{key_id}/credit-budget/reset","href":"/api-reference/account/reset-an-api-key-credit-budget"}]},{"group":"History","pages":[{"title":"List history items","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/history","href":"/api-reference/history/list-history-items"},{"title":"Get a history item","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/history/{history_item_id}","href":"/api-reference/history/get-a-history-item"},{"title":"Delete a history item","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/history/{history_item_id}","href":"/api-reference/history/delete-a-history-item"},{"title":"Download history audio","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/history/{history_item_id}/audio","href":"/api-reference/history/download-history-audio"}]},{"group":"Studio","pages":[{"title":"List projects","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/studio/projects","href":"/api-reference/studio/list-projects"},{"title":"Create a project","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/studio/projects","href":"/api-reference/studio/create-a-project"},{"title":"Import a project","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/studio/projects/import","href":"/api-reference/studio/import-a-project"},{"title":"Get a project","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/studio/projects/{project_id}","href":"/api-reference/studio/get-a-project"},{"title":"Delete a project","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/studio/projects/{project_id}","href":"/api-reference/studio/delete-a-project"},{"title":"Update a project","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/studio/projects/{project_id}","href":"/api-reference/studio/update-a-project"},{"title":"List chapters","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/studio/projects/{project_id}/chapters","href":"/api-reference/studio/list-chapters"},{"title":"Create a chapter","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/studio/projects/{project_id}/chapters","href":"/api-reference/studio/create-a-chapter"},{"title":"Reorder chapters","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/studio/projects/{project_id}/chapters/reorder","href":"/api-reference/studio/reorder-chapters"},{"title":"Get a chapter","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/studio/projects/{project_id}/chapters/{chapter_id}","href":"/api-reference/studio/get-a-chapter"},{"title":"Delete a chapter","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/studio/projects/{project_id}/chapters/{chapter_id}","href":"/api-reference/studio/delete-a-chapter"},{"title":"Rename a chapter","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/studio/projects/{project_id}/chapters/{chapter_id}","href":"/api-reference/studio/rename-a-chapter"},{"title":"Restore a chapter","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/studio/projects/{project_id}/chapters/{chapter_id}/restore","href":"/api-reference/studio/restore-a-chapter"},{"title":"List clips","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/studio/projects/{project_id}/clips","href":"/api-reference/studio/list-clips"},{"title":"Create a clip","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/studio/projects/{project_id}/clips","href":"/api-reference/studio/create-a-clip"},{"title":"Create clips in bulk","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/studio/projects/{project_id}/clips/batch","href":"/api-reference/studio/create-clips-in-bulk"},{"title":"Update clips in bulk","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/studio/projects/{project_id}/clips/batch","href":"/api-reference/studio/update-clips-in-bulk"},{"title":"Delete clips in bulk","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/studio/projects/{project_id}/clips/bulk-delete","href":"/api-reference/studio/delete-clips-in-bulk"},{"title":"Reorder clips","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/studio/projects/{project_id}/clips/reorder","href":"/api-reference/studio/reorder-clips"},{"title":"Move clips","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/studio/projects/{project_id}/clips/move","href":"/api-reference/studio/move-clips"},{"title":"Get a clip","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/studio/projects/{project_id}/clips/{clip_id}","href":"/api-reference/studio/get-a-clip"},{"title":"Delete a clip","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/studio/projects/{project_id}/clips/{clip_id}","href":"/api-reference/studio/delete-a-clip"},{"title":"Update a clip","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/studio/projects/{project_id}/clips/{clip_id}","href":"/api-reference/studio/update-a-clip"},{"title":"List tracks","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/studio/projects/{project_id}/tracks","href":"/api-reference/studio/list-tracks"},{"title":"Create a track","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/studio/projects/{project_id}/tracks","href":"/api-reference/studio/create-a-track"},{"title":"Reorder tracks","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/studio/projects/{project_id}/tracks/reorder","href":"/api-reference/studio/reorder-tracks"},{"title":"Get a track","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/studio/projects/{project_id}/tracks/{track_id}","href":"/api-reference/studio/get-a-track"},{"title":"Delete a track","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/studio/projects/{project_id}/tracks/{track_id}","href":"/api-reference/studio/delete-a-track"},{"title":"Update a track","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/studio/projects/{project_id}/tracks/{track_id}","href":"/api-reference/studio/update-a-track"},{"title":"List instances","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/studio/projects/{project_id}/tracks/{track_id}/instances","href":"/api-reference/studio/list-instances"},{"title":"Create an instance","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/studio/projects/{project_id}/tracks/{track_id}/instances","href":"/api-reference/studio/create-an-instance"},{"title":"Get an instance","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/studio/projects/{project_id}/tracks/{track_id}/instances/{instance_id}","href":"/api-reference/studio/get-an-instance"},{"title":"Delete an instance","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/studio/projects/{project_id}/tracks/{track_id}/instances/{instance_id}","href":"/api-reference/studio/delete-an-instance"},{"title":"Update an instance","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/studio/projects/{project_id}/tracks/{track_id}/instances/{instance_id}","href":"/api-reference/studio/update-an-instance"},{"title":"List files","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/studio/files","href":"/api-reference/studio/list-files"},{"title":"Create a file","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/studio/files","href":"/api-reference/studio/create-a-file"},{"title":"Get a file","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/studio/files/{file_id}","href":"/api-reference/studio/get-a-file"},{"title":"Delete a file","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/studio/files/{file_id}","href":"/api-reference/studio/delete-a-file"},{"title":"Rename a file","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/studio/files/{file_id}","href":"/api-reference/studio/rename-a-file"},{"title":"Get an upload URL","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/studio/files/{file_id}/upload","href":"/api-reference/studio/get-an-upload-url"},{"title":"Complete an upload","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/studio/files/{file_id}/complete","href":"/api-reference/studio/complete-an-upload"},{"title":"Retry file processing","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/studio/files/{file_id}/retry","href":"/api-reference/studio/retry-file-processing"}]}]},{"tab":"CLI Reference","pages":[{"title":"CLI Reference","href":"/cli"}]}]},"basePath":"","title":"Prepare remix preview - Breeze Blue","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}