Skip to main content
POST

Authorizations

Authorization
string
header
required

Your authentication credentials. For Basic authentication, please populate Basic $INWORLD_API_KEY. You can create a key in one command with the Inworld CLI: inworld workspace add-key.

Body

application/json

Request message for the synchronous TranscribeSpeech API.

transcribeConfig
Groq · object
required

Configuration for transcribing audio. Contains model selection, audio format settings, and optional feature configurations. Provider-specific configuration is mutually exclusive — set at most one of groqConfig or inworldSttV1Config.

audioData
object
required

Container for raw audio data bytes.

Response

A successful response.

transcription
object

Represents the result of a speech-to-text transcription. May be an interim (partial) result or a final result depending on the is_final field.

usage
object

Usage metrics for billing and monitoring purposes.