Create transcription (PydanticAI - OpenAI Whisper)

Transcribes audio into text using OpenAI Whisper via PydanticAI.

POST /pydanticai/v1/audio/transcriptions

Error

A valid request URL is required to generate request examples

200

{
  "duration": 123,
  "language": "<string>",
  "logprobs": [
    {
      "bytes": [
        123
      ],
      "logprob": 123,
      "token": "<string>"
    }
  ],
  "segments": [
    {
      "id": 123,
      "seek": 123,
      "start": 123,
      "end": 123,
      "text": "<string>",
      "tokens": [
        123
      ],
      "temperature": 123,
      "avg_logprob": 123,
      "compression_ratio": 123,
      "no_speech_prob": 123
    }
  ],
  "task": "<string>",
  "text": "<string>",
  "usage": {
    "input_tokens": 123,
    "input_token_details": {
      "text_tokens": 123,
      "audio_tokens": 123
    },
    "output_tokens": 123,
    "total_tokens": 123,
    "seconds": 123
  },
  "words": [
    {
      "word": "<string>",
      "start": 123,
      "end": 123
    }
  ],
  "extra_fields": {
    "request_type": "<string>",
    "model_requested": "<string>",
    "model_deployment": "<string>",
    "latency": 123,
    "chunk_index": 123,
    "raw_request": {},
    "raw_response": {},
    "cache_debug": {
      "cache_hit": true,
      "cache_id": "<string>",
      "hit_type": "<string>",
      "requested_provider": "<string>",
      "requested_model": "<string>",
      "provider_used": "<string>",
      "model_used": "<string>",
      "input_tokens": 123,
      "threshold": 123,
      "similarity": 123
    }
  }
}

{
  "event_id": "<string>",
  "type": "<string>",
  "is_bifrost_error": true,
  "status_code": 123,
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "event_id": "<string>"
  },
  "extra_fields": {
    "model_requested": "<string>",
    "request_type": "<string>"
  }
}

{
  "event_id": "<string>",
  "type": "<string>",
  "is_bifrost_error": true,
  "status_code": 123,
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "event_id": "<string>"
  },
  "extra_fields": {
    "model_requested": "<string>",
    "request_type": "<string>"
  }
}

Authorizations

BearerAuthBasicAuthVirtualKeyAuthApiKeyAuth

Authorization · string · header · required

Bearer token authentication. Use your provider API key or Bifrost authentication token. Virtual keys (prefixed with sk-bf-) can also be passed here.

Body

multipart/form-data

model · string · required

Model identifier (e.g., whisper-1)

Example:

"whisper-1"

file · file · required

Audio file to transcribe

language · string

Language of the audio (ISO 639-1)

prompt · string

Prompt to guide transcription

response_format · enum<string>

Available options: json, text, srt, verbose_json, vtt

temperature · number

Required range: 0 <= x <= 1

timestamp_granularities · enum<string>[]

Available options: word, segment

stream · boolean

fallbacks · string[]

Response

200

application/json

Successful response

duration · number

language · string

logprobs · object[]

Show child attributes

segments · object[]

Show child attributes

task · string

text · string

usage · object

Show child attributes

words · object[]

Show child attributes

extra_fields · object

Additional fields included in responses

Show child attributes