Skip to main content
Inworld AI logo
  • Category: artificial intelligence
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 6
  • Triggers: 0
  • Slug: INWORLD_AI
  • Version: 20261101_00

Tools

Slug: INWORLD_AI_CREATE_EMBEDDINGSGenerate one complete embedding vector per input text with an Inworld-hosted embedding model. Batches can produce large responses.

Input Parameters

array
required
Texts to embed, in output order. A call accepts 1-16 texts; each returned vector can be large.
string
Embedding model ID. The default model was verified against the live API.
string
Embedding service provider identifier. Use SERVICE_PROVIDER_INWORLD with the verified default model.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INWORLD_AI_GET_VOICE_PREVIEWGenerate the provider-selected, unmetered MP3 preview for a voice and return it as a downloadable file.

Input Parameters

string
required
TTS model used to select the preview.
string
required
Voice ID from LIST_VOICES. System voice IDs are valid for previews.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INWORLD_AI_LIST_MODELSList Inworld-supported models and the pricing, modality, context, and output limits needed to choose a model. The endpoint returns the complete model catalog and can produce a moderately large response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INWORLD_AI_LIST_VOICESReturn one page of voices available for preview or speech synthesis, with optional filtering, language selection, and sorting. The filter and languages parameters are mutually exclusive.

Input Parameters

string
Continuation token returned by a previous call; omit for the first page.
string
Optional AIP-160 filter, for example source = “IVC” for workspace-owned voices or source = “SYSTEM” for system voices. Cannot be combined with languages.
string
Comma-separated voice fields to sort by, with optional desc after a field.
array
Optional BCP-47 language codes to include, such as en-US. Cannot be combined with filter.
integer
Maximum voices to return in this page (1-2000). Smaller pages reduce response size.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INWORLD_AI_SYNTHESIZE_SPEECHSynthesize short text with an Inworld voice and return the complete audio as a downloadable file. Long text can exceed tool payload limits; prefer short text and compressed MP3 output.

Input Parameters

string
required
Text to speak (1-2000 characters). Prefer short text because generated base64 audio can exceed Composio/runtime payload limits.
integer
Optional encoded-audio bit rate supported by the selected encoding and model.
string
Optional BCP-47 language code when language should be selected explicitly.
string
required
TTS model ID, for example inworld-tts-2.
string
required
Voice ID from LIST_VOICES. System voice IDs are accepted by synthesis.
number
Optional speech-speed multiplier supported by the selected model.
string ("MP3" | "LINEAR16" | "OGG_OPUS" | "MULAW" | "ALAW" | "FLAC")
Output audio encoding. MP3 is recommended to minimize transport size.
integer
Optional output sample rate in hertz supported by the selected encoding and model.
boolean
Whether to enable the provider’s generation enhancement when supported by the selected model.
string ("ON" | "OFF" | "APPLY_TEXT_NORMALIZATION_UNSPECIFIED")
Text-normalization mode. ON expands values such as numbers and abbreviations, OFF reads text as written, and APPLY_TEXT_NORMALIZATION_UNSPECIFIED lets Inworld decide.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INWORLD_AI_TRANSCRIBE_AUDIOSynchronously transcribe a short audio file and return the transcript, with word timestamps and usage when available. Prefer compressed input to limit base64 payload growth.

Input Parameters

array
Optional words or phrases that help the model recognize expected names or terminology.
string
Optional language code such as en; omit to use provider detection or default behavior.
string
Synchronous STT model ID. The default was live-verified; groq/whisper-large-v3 is also supported for synchronous use.
object
required
Short audio file to transcribe. Prefer compressed MP3 and avoid large files because the API embeds audio as base64 JSON.
string ("AUTO_DETECT" | "LINEAR16" | "MP3" | "OGG_OPUS" | "FLAC")
Encoding of audio_file; it must match the uploaded audio bytes. Use AUTO_DETECT for self-describing formats when the encoding is unknown.
integer
Sample rate in hertz for raw audio; omit for self-describing container formats such as MP3.
integer
Channel count for raw audio; omit for self-describing container formats such as MP3.
boolean
Whether to include per-word timestamps in the transcription.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not