provider Agents Platform GET
/v1/convai/conversations @utdk/elevenlabs
/v1/convai/conversations Get Conversations
Get all conversations of agents that user owns. With option to restrict to a specific agent.
- cursor query
- Used for fetching next page. Cursor is returned in the response.
- agent_id query
- Agent id (agent_…) or speech engine external id (seng_), resolved to the same underlying resource.
- call_successful query
- The result of the success evaluation
- call_start_before_unix query
- Unix timestamp (in seconds) to filter conversations up to this start date.
- call_start_after_unix query
- Unix timestamp (in seconds) to filter conversations after to this start date.
- call_duration_min_secs query
- Minimum call duration in seconds.
- call_duration_max_secs query
- Maximum call duration in seconds.
- rating_max query
- Maximum overall rating (1-5).
- rating_min query
- Minimum overall rating (1-5).
- has_feedback_comment query
- Filter conversations with user feedback comments.
- user_id query
- Filter conversations by the user ID who initiated them.
- evaluation_params query
- Evaluation filters. Repeat param. Format: criteria_id:result. Example: eval=value_framing:success
- data_collection_params query
- Data collection filters. Repeat param. Format: id:op:value where op is one of eq|neq|gt|gte|lt|lte|in|exists|missing. For in, pipe-delimit values.
- tool_names query
- Filter conversations by tool names used during the call.
- tool_names_successful query
- Filter conversations by tool names that had successful calls.
- tool_names_errored query
- Filter conversations by tool names that had errored calls.
- main_languages query
- Filter conversations by detected main language (language code).
- page_size query
- How many conversations to return at maximum. Can not exceed 100, defaults to 30.
- integer
- summary_mode query
- Whether to include transcript summaries in the response.
- enum: exclude, include
- search query
- Full-text or fuzzy search over transcript messages
- conversation_initiation_source query
- text_only query
- branch_id query
- Filter conversations by branch ID.
- topic_ids query
- Filter conversations by topic IDs assigned during topic discovery.
- exclude_statuses query
- Exclude conversations with the given statuses. Useful for hiding in-progress / processing conversations from list views.
- tag_ids query
- Filter conversations by conversation tag IDs assigned via the conversation-tags endpoints.
- workflow_node_entered_id query
- Filter conversations to only those that entered the given node.
- 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.getConversationHistoriesRoute({
"page_size": 30,
"summary_mode": "exclude"
})