Speech Engine

List Speech Engines

Changed on

Returns a paginated list of Speech Engine resources.

get/v1/speech-engine

Request

  • Base URL
    https://api.elevenlabs.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.elevenlabs.io/v1/speech-engine
  • Auth
    none declared

Query parameters

page_sizeinteger

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

sort_direction'asc' | 'desc'

The direction to sort the results

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

The field to sort the results by

cursorstring nullable

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.

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"
      ],
      "updated_at_unix_secs": 1714086400,
      "voice_id": "UCaNsl8F6Xh4GALkVMLS"
    }
  ]
}

Changes

  • 6bdc01ad54abRevision changes
    • info

      added the enum value updated_at to the property anyOf[subschema #1: AgentSortBy]/ of the query request parameter sort_by

    • info

      added the required property // to the response with the status

  • d393c67c384aRevision changes
    • info

      added the required property // to the response with the status