Newer
Older
cortex-hub / ai-hub / docs / api_reference / stt.md

API Reference: STT

POST /stt/transcribe

Summary: Transcribe audio to text

Description: Transcribes an uploaded audio file into text using the configured STT service.

The audio file is expected to be a common audio format like WAV or MP3, though the specific provider implementation will determine supported formats.

Parameters

Name In Required Type Description
provider_name query No anyOf
x-user-id header No anyOf

Request Body

Required: Yes

  • Media Type: multipart/form-data
  • Schema: Body_transcribe_audio_to_text_stt_transcribe_post (Define in Models)

Responses

Status Code Description
200 The transcribed text from the audio file.
422 Validation Error

Example Usage

curl -X 'POST' \
  'http://localhost:8000/api/v1/stt/transcribe?provider_name=<provider_name>' \
  -H 'accept: application/json' \
  -H 'X-User-ID: <your_user_id>' \
  -H 'Content-Type: multipart/form-data' \
  -F 'file=@/path/to/file'