Listar agentes

GET

/v1/convai/agents

GET

/v1/convai/agents

curl -G https://api.elevenlabs.io/v1/convai/agents \
     -d archived=true \
     -d created_by_user_id=created_by_user_id \
     -d cursor=cursor \
     -d page_size=1 \
     -d search=search \
     -d show_only_owned_agents=true \
     -d sort_by=name \
     -d sort_direction=asc \
     -d tags=tags

{
  "agents": [
    {
      "agent_id": "J3Pbu5gP6NNKBscdCdwB",
      "name": "My Agent",
      "voice_id": "UCaNsl8F6Xh4GALkVMLS",
      "tags": [
        "Customer Support",
        "Technical Help",
        "Eleven"
      ],
      "created_at_unix_secs": 1716153600,
      "access_info": {
        "is_creator": true,
        "creator_name": "John Doe",
        "creator_email": "john@example.com",
        "role": "admin"
      },
      "last_call_time_unix_secs": 1,
      "archived": false
    }
  ],
  "has_more": false,
  "next_cursor": "123"
}

Devuelve una lista de tus agentes y sus metadatos.

Parámetros de consulta

page_sizeintegerOpcional1-100Valor predeterminado: 30

Número máximo de agentes que se devolverán. No puede superar 100; el valor predeterminado es 30.

searchstringOpcional

Busca por nombre de agente.

archivedbooleanOpcional

Filtra agentes por estado de archivado

show_only_owned_agentsbooleanOpcionalValor predeterminado: falseDeprecated

Si se establece en true, la ruta de API omitirá los agentes que otra persona haya compartido contigo e incluirá solo los que te pertenecen. Obsoleto: usa created_by_user_id en su lugar.

created_by_user_idstringOpcional

Filtra agentes por ID de usuario creador. Cuando se establece, solo se devuelven los agentes creados por este usuario. Tiene prioridad sobre show_only_owned_agents. Utiliza ‘@me’ para hacer referencia al usuario autenticado.

tagsstringOpcional

Filtra agentes por etiqueta. Repite el parámetro para que coincida con cualquiera de varias etiquetas.

sort_directionenumOpcional

La dirección para ordenar los resultados

Valores permitidos:

sort_byenumOpcional

El campo por el que se ordenarán los resultados

Valores permitidos:

cursorstringOpcional

Se usa para obtener la página siguiente. El cursor se devuelve en la respuesta.

Respuesta

Respuesta correcta.

agentslist of objects

Una lista de agentes y sus metadatos.

has_moreboolean

Indica si hay más agentes que paginar

next_cursorstringOpcional

El siguiente cursor para paginar los agentes

Errores

422

Agents List Request Unprocessable Entity Error

Encabezados

Parámetros de consulta

Respuesta

Errores