For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Connect
BlogHelp CenterAPI PricingSign up
OverviewElevenCreativeElevenAgentsElevenAPIReception AIAPI referenceChangelog
OverviewElevenCreativeElevenAgentsElevenAPIReception AIAPI referenceChangelog
  • Get started
    • Overview
    • Quickstart
  • Configure
    • Overview
    • Voice & language
    • Knowledge base
    • Tools
    • Personalization
    • Authentication
  • Deploy
    • Overview
    • Environment variables
    • WhatsApp
    • Batch calls
  • Monitor
    • Overview
    • Users
    • Testing
    • Experiments
    • Versioning
    • Conversation Analysis
    • Analytics
    • Real-time monitoring
    • OpenTelemetry traces
    • Privacy
    • Cost optimization
    • CLI
  • Advanced
    • Events
    • Custom models
    • LLM cascading
    • Post-call webhooks
  • Resources
    • UI components
  • Guides
    • Chat Mode
    • Burst pricing
    • ElevenLabs' docs agent
    • Scaling user interviews
    • Simulate Conversations
        • WSSAgent WebSockets
          • GETList tools
          • GETGet tool
          • POSTCreate tool
          • PATCHUpdate tool
          • DELDelete tool
          • GETGet dependent agents
          • GETGet tool executions
LogoLogo
Login
Login
Connect
BlogHelp CenterAPI PricingSign up
API referenceTools

Get tool executions

GET
/v1/convai/tools/:tool_id/executions
GET
/v1/convai/tools/:tool_id/executions
$curl https://api.elevenlabs.io/v1/convai/tools/tool_id/executions \
> -H "Content-Type: application/json"
1{
2 "executions": [
3 {
4 "tool_id": "tool_9f8b7c6d5e4a3b2c1d0e",
5 "tool_request_id": "req_1234567890abcdef",
6 "conversation_id": "conv_abcdef1234567890",
7 "agent_id": "agent_0011223344556677",
8 "timestamp": 1686787200,
9 "latency_secs": 2.35,
10 "id": "exec_0987654321fedcba",
11 "branch_id": "branch_main",
12 "is_error": false,
13 "request_payload": "{\"query\":\"Get user info\",\"user_id\":\"user_789\"}",
14 "response_payload": "{\"status\":\"success\",\"data\":{\"name\":\"John Doe\",\"age\":30}}",
15 "error_message": null,
16 "error_type": null,
17 "tool_call_details": {
18 "type": "webhook",
19 "method": "POST",
20 "url": "https://api.external-service.com/v1/userinfo",
21 "body": "{\"user_id\":\"user_789\"}",
22 "headers": {
23 "Authorization": "Bearer abcdef1234567890",
24 "Content-Type": "application/json"
25 },
26 "path_params": {
27 "user_id": "user_789"
28 },
29 "query_params": {
30 "verbose": "true"
31 }
32 }
33 }
34 ],
35 "has_more": true,
36 "next_cursor": "cursor_abcdef123456"
37}
Get paginated list of tool executions for a specific tool.
Was this page helpful?
Previous

List knowledge base documents

Next
Built with

Path parameters

tool_idstringRequired
ID of the requested tool.

Headers

xi-api-keystringOptional

Query parameters

cursorstring or nullOptional
Used for fetching next page. Cursor is returned in the response.
page_sizeintegerOptional1-100Defaults to 30
How many documents to return at maximum. Can not exceed 100, defaults to 30.
is_errorboolean or nullOptional
Filter by error status. If not provided, returns all executions.
agent_idstring or nullOptional
Filter by agent ID.
branch_idstring or nullOptional
Filter by agent branch ID.
start_timedouble or nullOptional

Filter executions from this Unix timestamp (inclusive).

end_timedouble or nullOptional

Filter executions until this Unix timestamp (inclusive).

Response

Successful Response
executionslist of objects
has_moreboolean
next_cursorstring or null

Errors

422
Unprocessable Entity Error