Get transcriptions

Authorization

AuthorizationRequiredBearer <token>

In: header

Query parameters

limitinteger

The maximum number of transcriptions to return (minimum 1, maximum 1000).

Default: 1000Minimum: 1Maximum: 1000

cursorstring

Pagination cursor for the next page of results.

Response body

200

A list of transcriptions.

transcriptionsRequiredarray<object>

An array of transcriptions.

next_page_cursorstring

next_page_cursor is used for pagination, providing a token that references the next page of results. If the current response does not include all available data, the next_page_cursor will contain a value that can be sent in the cursor parameter of a subsequent request to fetch the next page. If there are no additional results, this field will be null.

Errors

A list of transcriptions.

{
  "transcriptions": [
    {
      "id": "73d4357d-cad2-4338-a60d-ec6f2044f721",
      "status": "completed",
      "created_at": "2024-11-26T00:00:00Z",
      "model": "stt-async-preview",
      "audio_url": "https://soniox.com/media/examples/coffee_shop.mp3",
      "file_id": null,
      "filename": "coffee_shop.mp3",
      "language_hints": [
        "en",
        "fr"
      ],
      "context": "extra context for the transcription",
      "audio_duration_ms": 16079,
      "error_message": null,
      "webhook_url": "https://example.com/webhook",
      "webhook_auth_header_name": "Authorization",
      "webhook_auth_header_value": "******************",
      "webhook_status_code": null,
      "client_reference_id": "some_internal_id"
    }
  ],
  "next_page_cursor": "cursor_or_null"
}

Get transcriptions

Authorization

Query parameters

Response body

200

Errors

400Invalid request.

401Authentication error.

500Internal server error.

Response