Create transcription

Transcribes audio into text (speech-to-text) with word-level timestamps. The request body is multipart/form-data carrying the audio file (or a URL to it).

Authorization

bearerAuth

AuthorizationBearer <token>

Bearer token authentication using API keys

In: header

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

model*string

ID of the transcription (speech-to-text) model to use.

file?string

The audio file to transcribe. Required unless url is provided.

url?string

URL of an audio file to download and transcribe upstream. Required unless file is provided.

language?string

Language code (e.g. 'en'). When set, enables inverse text normalization so numbers and currencies are formatted in their written form.

diarize?string

When 'true', enables speaker diarization; each word in the response includes a speaker field.

filler_words?string

When 'true', filler words (e.g. 'uh', 'um') are kept in the transcript instead of being removed.

keyterm?string

A key term to bias transcription toward (e.g. product names). Repeat the field for multiple terms.

Response Body

`application/json`

curl -X POST "https://example.com/v1/audio/transcriptions" \  -F model="grok-stt-1-0"

{
  "text": "string",
  "language": "string",
  "duration": 0,
  "words": [
    {
      "text": "string",
      "start": 0,
      "end": 0,
      "speaker": 0
    }
  ],
  "channels": [
    {
      "property1": null,
      "property2": null
    }
  ]
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

Create transcription

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

402application/json

403application/json

410application/json

413application/json

429application/json

500application/json

502application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`