{"openapi":"3.1.0","info":{"title":"VoiceChange API","version":"1.0.0","description":"Change the voice of a recording, turn text into speech or make a song cover. Jobs run asynchronously and use the account’s credits at voicechange.io prices: 1 credit per 10 s of audio (Premium voices 1 per 5 s; text to speech counts ~14 characters per second). Credits are held when a job starts and refunded if it fails. Make an API key at https://voicechange.io/account#api-keys.","contact":{"name":"VoiceChange","url":"https://voicechange.io/contact"},"termsOfService":"https://voicechange.io/terms"},"externalDocs":{"description":"Guide and examples","url":"https://voicechange.io/developers"},"servers":[{"url":"https://voicechange.io/api/v1"}],"security":[{"bearer":[]},{"apiKeyHeader":[]}],"paths":{"/me":{"get":{"operationId":"getMe","summary":"The API key and its account’s credits","description":"Use it to test a key (Zapier’s connection test).","responses":{"200":{"description":"The key and balance.","content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"prefix":{"type":"string","description":"First characters of the key, to tell keys apart."}}},"credits":{"type":"object","properties":{"balance":{"type":"integer","description":"Credits available now."},"held":{"type":"integer","description":"Credits set aside for running jobs."}}}}},"example":{"key":{"id":"81bdc816-e2c1-11f1-8f70-d9283dbaee79","name":"Zapier","prefix":"vc_JcrcGE7"},"credits":{"balance":1549,"held":0}}}}},"401":{"description":"Missing, wrong or revoked API key (`invalid_api_key`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/voices":{"get":{"operationId":"listVoices","summary":"Voices you can use","parameters":[{"name":"kind","in":"query","required":false,"schema":{"type":"string","enum":["cover"]},"description":"`cover` lists only voices that can sing."}],"responses":{"200":{"description":"All ready, shared voices, sorted by name.","content":{"application/json":{"schema":{"type":"object","properties":{"voices":{"type":"array","items":{"$ref":"#/components/schemas/Voice"}},"count":{"type":"integer"}}}}}},"401":{"description":"Missing, wrong or revoked API key (`invalid_api_key`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/jobs":{"post":{"operationId":"createJob","summary":"Start a job","description":"Starts a voice change, text to speech or song cover. Audio for `voice` and `cover` comes from `audio_url` (JSON) or a multipart file field `audio`: mp3, wav, m4a, ogg, flac or webm, up to 15 MB and 10 minutes. Answers at once with the queued job; poll `GET /jobs/{id}` or pass `callback_url`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["voice_id"],"properties":{"kind":{"type":"string","enum":["voice","tts","cover"],"default":"voice","description":"`voice` changes a recording’s voice, `tts` speaks text, `cover` makes a song cover (keeps the music)."},"voice_id":{"type":"string","description":"An `id` from `GET /voices`. For `cover`, the voice must have `can_sing: true`."},"text":{"type":"string","maxLength":1000,"description":"Required for `tts`."},"pitch":{"type":"integer","minimum":-24,"maximum":24,"default":0,"description":"Pitch shift in semitones."},"auto_pitch":{"type":"boolean","default":true,"description":"Match the voice’s range automatically."},"callback_url":{"type":"string","format":"uri","maxLength":1000,"description":"Optional https URL. When the job finishes or fails, the Job JSON is POSTed to it (retried with backoff on non-2xx)."},"audio_url":{"type":"string","format":"uri","description":"Required for `voice` and `cover` (unless sent as multipart). A public http(s) link."}}},"examples":{"tts":{"value":{"kind":"tts","voice_id":"f6aff186-3834-49c1-b459-4892147708a7","text":"Hello there!"}},"voice":{"value":{"kind":"voice","voice_id":"a33286e5-aeee-467d-b83f-96e1e221f244","audio_url":"https://example.com/recording.mp3"}}}},"multipart/form-data":{"schema":{"type":"object","required":["voice_id"],"properties":{"kind":{"type":"string","enum":["voice","tts","cover"],"default":"voice","description":"`voice` changes a recording’s voice, `tts` speaks text, `cover` makes a song cover (keeps the music)."},"voice_id":{"type":"string","description":"An `id` from `GET /voices`. For `cover`, the voice must have `can_sing: true`."},"text":{"type":"string","maxLength":1000,"description":"Required for `tts`."},"pitch":{"type":"integer","minimum":-24,"maximum":24,"default":0,"description":"Pitch shift in semitones."},"auto_pitch":{"type":"boolean","default":true,"description":"Match the voice’s range automatically."},"callback_url":{"type":"string","format":"uri","maxLength":1000,"description":"Optional https URL. When the job finishes or fails, the Job JSON is POSTed to it (retried with backoff on non-2xx)."},"audio":{"type":"string","format":"binary","description":"The audio file."},"audio_url":{"type":"string","format":"uri"}}}}}},"responses":{"201":{"description":"The job, usually `queued` or `processing`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}},"400":{"description":"Bad input: `bad_kind`, `missing_voice`, `missing_text`, `text_too_long`, `missing_audio`, `bad_audio_url`, `audio_too_long`, `voice_cannot_sing`, `bad_callback_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, wrong or revoked API key (`invalid_api_key`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Not enough credits (`no_credits`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No such voice (`unknown_voice`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"413":{"description":"File larger than 15 MB (`file_too_large`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"415":{"description":"Audio that can’t be read (`unsupported_audio`, `unreadable_audio`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Too many jobs: at most 30 new jobs a minute and 5 running at once (`rate_limited`, `too_many_running`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"get":{"operationId":"listJobs","summary":"This account’s API jobs, newest first","description":"The last 100 jobs made with any of the account’s API keys.","parameters":[{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["queued","processing","finished","failed"]}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":50}}],"responses":{"200":{"description":"Jobs.","content":{"application/json":{"schema":{"type":"object","properties":{"jobs":{"type":"array","items":{"$ref":"#/components/schemas/Job"}}}}}}},"401":{"description":"Missing, wrong or revoked API key (`invalid_api_key`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/jobs/{id}":{"get":{"operationId":"getJob","summary":"One job","description":"Has `audio_url` (a signed link valid for 1 hour; ask again for a fresh one) once `status` is `finished`.","parameters":[{"$ref":"#/components/parameters/JobId"}],"responses":{"200":{"description":"The job.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}},"401":{"description":"Missing, wrong or revoked API key (`invalid_api_key`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No such job for this account (`not_found`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/jobs/{id}/callback":{"post":{"operationId":"setJobCallback","summary":"Add a webhook to a running job","description":"If the job has already ended, the webhook is still sent within seconds.","parameters":[{"$ref":"#/components/parameters/JobId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["callback_url"],"properties":{"callback_url":{"type":"string","format":"uri","maxLength":1000,"description":"Optional https URL. When the job finishes or fails, the Job JSON is POSTed to it (retried with backoff on non-2xx)."}}}}}},"responses":{"200":{"description":"The job.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}},"400":{"description":"Not an https URL to a public host (`bad_callback_url`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, wrong or revoked API key (`invalid_api_key`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No such job for this account (`not_found`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The webhook was already sent (`callback_sent`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"webhooks":{"jobEnded":{"post":{"summary":"A job with a callback_url finished or failed","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}},"responses":{"200":{"description":"Any 2xx ends the retries. 400, 404 and 410 stop them too."}}}}},"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Authorization: Bearer vc_…"},"apiKeyHeader":{"type":"apiKey","in":"header","name":"X-API-Key"}},"parameters":{"JobId":{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}},"schemas":{"Voice":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"category":{"type":["string","null"]},"premium":{"type":"boolean","description":"Premium voices use twice the credits."},"can_sing":{"type":"boolean","description":"Can be used for song covers."},"icon":{"type":["string","null"]},"description":{"type":["string","null"]}}},"Job":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["voice","tts","cover"]},"status":{"type":"string","enum":["queued","processing","finished","failed"]},"voice_id":{"type":"string"},"voice_name":{"type":["string","null"]},"credits":{"type":"integer","description":"Credits the job costs; 0 when it failed (refunded)."},"audio_url":{"type":["string","null"],"format":"uri","description":"Signed link to the result, valid 1 hour. Set when finished."},"audio_format":{"type":["string","null"],"enum":["wav","mp3",null]},"share_url":{"type":["string","null"],"format":"uri"},"error":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time"},"finished_at":{"type":["string","null"],"format":"date-time"}},"example":{"id":"a260984b-6fd1-4337-b53f-c6051b7d6342","kind":"tts","status":"finished","voice_id":"f6aff186-3834-49c1-b459-4892147708a7","voice_name":"Adam","credits":1,"audio_url":"https://…r2.cloudflarestorage.com/a260984b-6fd1-4337-b53f-c6051b7d6342.wav?X-Amz-Expires=3600&…","audio_format":"wav","share_url":"https://voicechange.io/s/a260984b-6fd1-4337-b53f-c6051b7d6342","error":null,"created_at":"2026-11-17T20:00:24.592Z","finished_at":"2026-11-17T20:00:36.104Z"}},"Error":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","description":"A stable code."},"message":{"type":"string","description":"What went wrong, for people."}}}}}}