provider Agents Platform GET
/v1/convai/agents @utdk/elevenlabs
/v1/convai/agents List Agents
Returns a list of your agents and their metadata.
- page_size query
- How many Agents to return at maximum. Can not exceed 100, defaults to 30.
- integer
- search query
- Search by agents name.
- archived query
- Filter agents by archived status
- show_only_owned_agents query
- If set to true, the endpoint will omit any agents that were shared with you by someone else and include only the ones you own. Deprecated: use created_by_user_id instead.
- boolean
- created_by_user_id query
- Filter agents by creator user ID. When set, only agents created by this user are returned. Takes precedence over show_only_owned_agents. Use '@me' to refer to the authenticated user.
- sort_direction query
- The direction to sort the results
- enum: asc, desc
- sort_by query
- The field to sort the results by
- cursor query
- Used for fetching next page. Cursor is returned in the response.
- xi-api-key header
- 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.
Try it
Authentication
Configure credentials for ElevenLabs API Documentation
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.
Saved automatically to browser storage.
Code snippet
Updates live as you fill in the form above.
TypeScript
import elevenlabs from '@utdk/elevenlabs';
await elevenlabs.getAgentsRoute({
"page_size": 30,
"archived": "false",
"show_only_owned_agents": false
})