ELelevenlabs
Agents Platform

List Analysis Items

Changed on

List analysis items available in the workspace.

get/v1/convai/analysis-items

Request

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

Query parameters

searchstring nullable

If specified, only analysis items whose names start with this string are returned, ordered by relevance rather than sort_direction.

page_sizeinteger nullable

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

kind'evaluation' | 'data_collection'

If specified, only analysis items of this kind are returned.

analysis_item_idsstring[] nullable

If specified, only analysis items with these IDs are returned.

created_by_user_idstring nullable

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

sort_direction'asc' | 'desc'

The direction to sort the results

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

Example response

{
  "analysis_items": [
    {
      "definition": {
        "value_schema": {
          "description": "A user-provided message",
          "type": "string"
        }
      },
      "access_info": {
        "access_source": "creator",
        "creator_email": "john.doe@example.com",
        "creator_name": "John Doe",
        "is_creator": true,
        "role": "admin"
      }
    }
  ]
}

Changes