MCP is live.Set upAsk the community
OmniDimension
Dashboard
DocumentationAPI referenceSDKsMCP
Agents

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`.

POST/agents//versions//restore
Path parameters
agent_idrequired
version_numberrequired
Body

Reseller 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). 

curl -X POST 'https://omnidim.io/api/v1/agents/{agent_id}/versions/{version_number}/restore' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "user_id": 1234
}'
Example response
{
  "success": true,
  "restored_from": 5,
  "safety_version": 7,
  "skipped": [
    {
      "item": "knowledge_file",
      "label": "old-pricing-sheet.pdf",
      "reason": "deleted"
    }
  ]
}

Authorization

BearerAuth
headerAuthorizationBearer <token>

Bearer token authentication. Obtain your API key from the OmniDimension dashboard.

Path Parameters

agent_id*integer

The ID of the agent.

version_number*integer

The version number, as returned in version_number from the list or save endpoints.

Request Body

application/json
user_id?ClientUserId

Reseller 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.

Response body

application/json

Response Body

Version restored.

application/json
success?boolean
restored_from?integer

The version number that was restored.

safety_version?integer

Version number of the backup taken of the agent's setup right before this restore, or null if no backup was needed.

skipped?

References the restore could not bring back (e.g. a knowledge file or integration deleted since this version was saved).

Was this page helpful?

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.

List knowledge base files

List all knowledge-base files for the authenticated user.