Skip to main content
GET
Use this endpoint to read an agent’s change history: every recorded settings change, newest first, with who made it, when, where it came from, and each field’s old and new value. It is the same record the Change History tab shows in the Portal and in Connect. Each entry has a permanent id. Pass it to Revert Agent to a Version to put the agent back to how it was at that point.

Path Parameters

string
required
The unique identifier of the agent (UUID format)

Query Parameters

integer
default:"1"
Page number for pagination (1-indexed). Page 1 holds the newest changes. A value that is not a whole number of 1 or more falls back to 1, and a page past the end returns an empty list. Invalid values never return 400.
integer
default:"50"
Number of versions per page (max 100). A value that is not a whole number of 1 or more falls back to 50, and a value over 100 is capped at 100.

Response Fields

Behavior

Only what changed. Each entry lists the fields that changed in that version, not the whole agent. Settings stored as one object (such as config) are split per key, so a change shows as config.dtmf_enabled rather than the whole object. A field that did not exist before (or was removed) has before (or after) set to null. Values are returned as stored, so a prompt change carries the full old and new prompt. Newest first. Page 1 holds the most recent changes. Use pagination.hasNext to walk back through older versions. A page past the end returns an empty data array with the real total. Recorded a few seconds after the save. A change made through the Portal, Connect or the API appears here a few seconds after it is saved, not instantly. What is recorded. The agent’s main settings: name and description, instructions and greeting, AI model, language and timezone, voice and speech settings, call transfer and warm transfer settings, recording settings, call, echo and automated-caller detection, the email tool, knowledge base settings, pronunciations, the notification email, the failover destination, and the config settings (such as config.dtmf_enabled). Not recorded: agent status (active / inactive), functions, outbound and voicemail greetings, AMD/IVR, web transfer, screenshare, email server, call limits and retries, agent type, integrations and credentials, SIP, and knowledge base documents. LiveKit agents only. Agents on other providers have no recorded history and return an empty list.
Scoped API keys can use this endpoint for agents inside their reseller or organization. An agent outside the key’s scope returns 404, the same as an agent that does not exist.

Common Uses

See who changed an agent and when

Read the newest changes to find out who edited an agent’s prompt or greeting, and from which app:

Export the full history

Walk every page until hasNext is false:

Find a version to restore

Look for the last version before an unwanted change, then pass its id to Revert Agent to a Version.

Troubleshooting