List Agent Response Tests

Changed on

Lists all agent response tests with pagination support and optional search filtering.

get/v1/convai/agent-testing

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/convai/agent-testing
  • Auth
    none declared

Query parameters

cursorstring nullable

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

page_sizeinteger

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

searchstring nullable

Search query to filter tests and folders by name.

parent_folder_idstring nullable

Filter by parent folder ID. Use 'root' to get items in the root folder.

typesTestType[] nullable

If present, the endpoint will return only tests/folders of the given types.

include_foldersboolean nullable

Deprecated. Use the types query param and include folder instead.

sort_mode'default' | 'folders_first'

Sort mode for listing tests. Use 'folders_first' to place folders before tests.

sharing_mode'all' | 'shared_with_me'

Filter test visibility. Use shared_with_me to return only tests/folders shared with the current user that they did not create.

created_by_user_idstring nullable

Filter tests and folders by creator user ID. Use '@me' to refer to the authenticated user.

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
has_moreboolean required

Example response

{
  "tests": [
    {
      "access_info": {
        "access_source": "creator",
        "creator_email": "john.doe@example.com",
        "creator_name": "John Doe",
        "is_creator": true,
        "role": "admin"
      }
    }
  ]
}

Changes

  • 0c930e56e185Revision changes
    • info

      added the new optional query request parameter created_by_user_id

  • d1a4847203ceRevision changes
    • warning

      added the new avaya enum value to the /// response property for the response status