Sign in

v5

latestOpenAPI 3.1.02026-08-043621,4011.8 MB
forced-alignment

Create Forced Alignment

Force align an audio file to text. Use this endpoint to get the timing information for each character and word in an audio file based on a provided text transcript.

post/v1/forced-alignment

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Response

Successful Response

lossnumber required

The average alignment loss/confidence score for the entire transcript, calculated from all characters.

Example response

{
  "characters": [
    {
      "end": 0.02,
      "start": 0,
      "text": "H"
    }
  ],
  "words": [
    {
      "end": 1.02,
      "loss": 0.12,
      "start": 0,
      "text": "Hello"
    }
  ]
}