API

Every aivoov.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Audio

create

audio.create Synthesise speech from one or more voice and text pairs, returning Base64-encoded audio. Consumes character credits Risk: write

await corsair.aivoov.api.audio.create({});

Input

Name	Type	Required	Description
`voice_id`	`string[]`	Yes	—
`transcribe_text`	`string[]`	Yes	—
`transcribe_ssml_pitch_rate`	`(number \| default)[]`	No	—
`transcribe_ssml_spk_rate`	`(number \| default)[]`	No	—
`transcribe_ssml_volume`	`(number \| default)[]`	No	—

Output

Name	Type	Required	Description
`status`	`boolean`	Yes	—
`message`	`string`	No	—
`audio`	`string`	Yes	—

Voices

list

voices.list List available text-to-speech voices, optionally filtered by BCP-47 language code. Limited to 20 calls per day, so results are mirrored to the voices entity Risk: read

await corsair.aivoov.api.voices.list({});

Input

Name	Type	Required	Description
`language_code`	`string`	No	—

Output

Name	Type	Required	Description
`status`	`boolean`	Yes	—
`message`	`string`	No	—
`data`	`object[]`	Yes	—

data full type

{
  voice_id: string,
  name: string,
  value?: string,
  gender?: string,
  language_code?: string,
  language_name?: string,
  label?: string
}[]

Overview

Plugins

Audio

create

Voices

list

​Audio

​create

​Voices

​list

Audio

create

Voices

list