Generate a voice-over line
generate_voiceoverSpeak ONE line (one sentence, up to 400 characters) and return a WAV file URL with its exact duration. For reels: one call per beat, the same voice for the whole video, so every scene can be cut to its line. Two kinds of voice:
An Ignix voice (
voice+language): 3 AI credits per started 100 characters (a one-sentence reel line is usually 3). Voices: stock_ava (female, warm, friendly narrator); stock_mia (female, young, upbeat, casual); stock_nora (female, calm, clear); stock_leo (male, young, upbeat, casual); stock_max (male, warm, confident narrator); stock_sam (male, calm, informative); stock_zoe (female, breezy, light, easy-going); stock_vera (female, mature, calm, trustworthy); stock_kira (female, firm, confident); stock_teo (male, casual, laid-back); stock_nico (male, excitable, high energy); stock_hugo (male, firm, authoritative). The user can hear every voice at https://ignix.social/voices — link it when they choose one.The user's OWN voice (
myVoiceIdfromlist_my_voices; it speaks the language of the text):quality"normal" costs 3 credits per started 100 characters, "cinema" 10 and also takes per-word tags in the text (…, …, …) and [break] for a pause.directionsays how to say it in a few English words ("smiling, telling a secret"). Directions count as characters. The line is also kept in the user's Ignix audio library. When the user has their own voice, offer it first. SPENDS AI CREDITS ONLY WITH confirm: true. Call it first without confirm: nothing runs and nothing is charged, you get the quote (what it will do and the credits). Tell the user, in your own words, exactly that — including the options you chose, so they can change them — and wait for a clear yes before calling again with the same arguments and confirm: true. One yes covers the plan they approved (e.g. every line of an approved voice-over with the chosen voice); anything new or different needs a new yes.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| text | Yes | Exactly what to say. One sentence, written the way a person talks. To fix where a word is stressed (names, brands), mark its stressed vowel with U+0301 after it (Сухи́н) or a + before it (Сух+ин): the mark is not read aloud. With quality "cinema", per-word tags as described above. | |
| voice | No | Ignix voice id (not with myVoiceId). Keep the same one for a whole video. | |
| confirm | No | true ONLY after the user said yes to the quote (what it does and the credits). Without it nothing runs and nothing is charged. | |
| quality | No | Own voice only: "normal" (default) or "cinema" (directed per word). | |
| delivery | No | "hook" for the opening line, "cta" for the closing ask, "narration" for the rest, "calm" for a relaxed read. | |
| language | No | Ignix voices only: any language the user wants, as its ISO code with optional region: es-ES, en-US, en-GB, pt-PT, pt-BR, fr, de, it, ru, nl, pl, ja, ar… (more than 120). If it is not available the call says so: tell the user. Spanish always sounds from Spain; Portuguese from Portugal unless pt-BR (Brazil). | |
| direction | No | Own voice only, optional: how to say it, a few English words (max 120 characters). Without it, `delivery` sets the tone. | |
| myVoiceId | No | The user's own voice, an id from list_my_voices (instead of voice + language). | |
| workspaceId | No | Workspace to work on (an id from list_workspaces). Not needed when this connection is tied to one workspace, or when you pass an account: the account's workspace is used. | |
| idempotencyKey | No | Optional. A unique id for this action (16-128 chars: letters, digits, _ : . -). If you are unsure whether a call went through (timeout, network error), repeat it with the SAME idempotencyKey and the same arguments: you get the original result and nothing is done twice. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | Public URL of the WAV file. It expires after 7 days: download it into the project. | |
| mediaType | No | ||
| durationSec | No | Exact length of the audio, in seconds. | |
| confirmToken | No | ||
| creditsCharged | No | ||
| creditsRemaining | No | Credits left this month. null = this organization has no monthly credit cap. | |
| estimatedCredits | No | ||
| needsConfirmation | No | true = this is only the quote: nothing was done or charged. |