Skip to content

List agent executions

View .md
GET

List recent agent executions with pagination.

An execution is one inbound message answered by the agent, so this covers the messaging channels only. Voice calls are never listed here regardless of how many the agent handled. Use GET /v1/calls (and GET /v1/calls/{callId} for the transcript) for voice.

Authorization

  • Authorizationheaderrequired

    Bearer YOUR_API_KEY. Create a key in the dashboard.

Path parameters

  • senderIdstringrequired

Query parameters

  • statusstring

    Status of an agent execution.

    One ofsuccesserrorfilteredrate_limitedbalance_insufficient
  • limitinteger
    Default50
    Limitsmax 100
  • cursorstring

Responses

200List of executions.
  • itemsobject[]required
    14 properties
    • idstringrequired
    • agentIdstringrequired
    • inboundMessageIdstring
    • responseMessageIdstringnullable
    • responseTextstringnullable
    • statusstringrequired

      Status of an agent execution.

      One ofsuccesserrorfilteredrate_limitedbalance_insufficient
    • errorMessagestringnullable
    • inputTokensintegerrequired
    • outputTokensintegerrequired
    • latencyMsintegerrequired
    • costnumberrequired

      Cost in USD.

    • createdAtstring<date-time>required
    • knowledgeChunksUsedintegernullable

      Knowledge-base chunks retrieved for this answer. Zero on an agent that has documents attached means the reply was not grounded in them, which is otherwise indistinguishable from a correct answer in this record. Absent on executions recorded before this field existed, which is not the same as zero.

    • toolCallsintegernullable

      Tools the agent called while producing this reply. Zero on an agent that has tools configured means it answered without calling any — the case where a reply says it will look something up and nothing ever reaches your endpoint. Absent on executions recorded before this field existed, which is not the same as zero.

  • nextCursorstringnullable
400Invalid query parameters, such as a `status` that is not an execution status.
  • codestringrequired
  • messagestringrequired
  • detailsobject
401Unauthorized.
  • codestringrequired
  • messagestringrequired
  • detailsobject
404Agent not found.
  • codestringrequired
  • messagestringrequired
  • detailsobject