Sign in

v4

OpenAPI 3.1.02026-07-313621,3961.8 MB
Speech Engine

List Speech Engines

Returns a paginated list of Speech Engine resources.

get/v1/speech-engine

Query parameters

page_sizeinteger

How many Speech Engines to return at maximum. Can not exceed 100, defaults to 30.

How many Speech Engines to return at maximum. Can not exceed 100, defaults to 30.

searchstring nullable

Search term to filter Speech Engines by name

Search term to filter Speech Engines by name

sort_direction'asc' | 'desc'

The direction to sort the results

sort_by'name' | 'created_at' | 'call_count_7d'

The field to sort the results by

cursorstring nullable

Used for fetching next page. Cursor is returned in the response.

Used for fetching next page. Cursor is returned in the response.

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

next_cursorstring nullable

Cursor for fetching the next page

has_moreboolean required

Whether there are more results

Example response

{
  "has_more": false,
  "speech_engines": [
    {
      "access_info": {
        "creator_email": "john@example.com",
        "creator_name": "John Doe",
        "is_creator": true,
        "role": "admin"
      },
      "created_at_unix_secs": 1714000000,
      "name": "My Speech Engine",
      "speech_engine_id": "seng_3701k3ttaq12ewp8b7qv5rfyszkz",
      "tags": [
        "production",
        "v1"
      ]
    }
  ]
}