Diff an agent version
Get a record-level diff for this version. By default it shows what changed in this version compared with the version before it. Use `against=current` to compare with the agent's live config (what restoring this version would change), or `against=<number>` to compare with another version.
agent_idrequiredversion_numberrequireduser_idintegerReseller keys only: act as one of your clients by its user id. Omit it to act on your own account. [How acting for a client works](/docs/reseller/your-clients/acting-as-clients).
againststringWhat to compare against. Omit or previous for the version before this one (the default). current for the agent's live config. A version number to compare with that version.
curl -X GET 'https://omnidim.io/api/v1/agents/{agent_id}/versions/{version_number}/diff' \ -H 'Authorization: Bearer YOUR_API_KEY'
{ "changed": true, "first": false, "from": { "version_number": 4, "name": "Before pricing tweak" }, "to": { "version_number": 5, "name": "Working pricing script" }, "groups": [ { "area": "Settings", "changes": [ { "field": "llm_service", "label": "Model", "old": "gpt-4.1-mini", "new": "gpt-4o-mini" } ] }, { "area": "Knowledge", "records": [ { "op": "added", "label": "pricing-sheet.pdf" } ] } ] }
BearerAuthAuthorizationBearer <token>Bearer token authentication. Obtain your API key from the OmniDimension dashboard.
agent_id*integerThe ID of the agent.
version_number*integerThe version number, as returned in version_number from the list or save endpoints.
user_id?integerReseller keys only: act as one of your clients by its user id. Omit it to act on your own account. How acting for a client works.
against?stringWhat to compare against. Omit or previous for the version before this one (the default). current for the agent's live config. A version number to compare with that version.
Response body
application/jsonDiff between the two versions.
application/jsonchanged?booleanWhether there is any difference between the two sides.
first?booleanTrue when this is the earliest version and there is nothing before it to compare (only for the default previous-version comparison).
from?The version being compared from, or null when first is true.
to?The comparison target: an object with the version number and name for a version, or a text label such as current setup.
groups?Was this page helpful?
Delete an agent version
Delete a saved version.
Restore an agent version
Restore a version onto the live agent. Your current setup is saved first as a backup version, so restoring is undoable. Configuration is brought back; any knowledge files or integrations that were deleted since this version was saved can't be re-linked, and are reported in `skipped`.
