Skip to main content
GET
Retrieve run logs by AI contact or by voice call

Overview

Retrieve the AI run logs (assistant execution traces) associated with a specific AI contact. Each run log is returned as a full tree with its descendants, ordered from the most recent root run to the oldest. Use this endpoint to inspect what the AI did during a conversation: which assistants were used, which tools were called, what predefined behaviours triggered, and the input/output of each step.

Use Cases

  • Debug Assistant Behaviour: Inspect tool calls, context retrieval, and decisions step-by-step
  • Audit & Compliance: Build an audit trail of AI actions taken per contact
  • Analytics: Compute per-contact metrics about AI runs, tool usage, latency
  • Customer Support: Understand why the assistant replied in a certain way to a given contact

Authentication

This endpoint requires authentication using an API key. Include your API key in the request header:

Query Parameters

Pagination applies to the root run logs only. Each root is returned together with its full descendant tree.

Response Structure

Run Log Object

Example Request

Error Responses

Headers

x-api-key
string
required

API key required to authorize the request

Query Parameters

ai_contact_id
string<uuid>

UUID of the AI contact to fetch run logs for. Mutually exclusive with voice_call_id.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
voice_call_id
string

Id of the voice call to fetch run logs for. Mutually exclusive with ai_contact_id. Not necessarily a UUID: it falls back to the provider conversation id when the call was placed without one.

Minimum string length: 1
page
integer

Page number (defaults to 1)

Required range: -9007199254740991 <= x <= 9007199254740991
page_size
integer

Page size (max 100; defaults to 20 by contact, 50 by voice call)

Required range: -9007199254740991 <= x <= 9007199254740991

Response

Run logs retrieved successfully.