Skip to content

Restore an agent definition version

POST
/api/agent-definitions/{id}/versions/{versionId}/restore

Restores a previous version of an agent definition by publishing its configuration as a new version. History is preserved: the prior published version is superseded rather than overwritten. When the restored configuration already matches the current configuration, no new version is created.

id
required
string format: uuid

The unique identifier of the agent definition.

versionId
required
string format: uuid

The unique identifier of the version to restore.

The version was restored and a new published version was recorded, or the restore was a no-op.

The result of restoring a version. A restore creates a new published version rather than mutating history. When the restored content matches the current content, no new version is created.

object
versionId
required

Identifier of the newly published version, or of the existing current version when the restore was a no-op.

string format: uuid
Example
v9a8b7c6-5432-10fe-dcba-0987654321ab
created
required

Whether a new version was created. False when the restored content already matched the current content.

boolean
Example
true
restoredFrom
required

The version number that was restored.

integer
Example
2

No agent definition or version exists with the given ID in the authenticated tenant.

Standard error response returned by all endpoints on failure.

object
error
required

A human-readable error message describing what went wrong.

string
Example
Conversation not found