Skip to main content
POST
Preview version restore

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

agent_id
string<uuid>
required

Voice agent ID.

Example:

"550e8400-e29b-41d4-a716-446655440000"

version_number
integer
required

Agent config version number.

Required range: x >= 1

Body

application/json
restore_historical_name
boolean
default:false

When true, also restore the agent name recorded in the version. By default the agent keeps its current name.

Response

Restore preview. Check stateready previews can be accepted; failed previews list blocking issues.

state
enum<string>
required
  • ready: the restore can be accepted with the returned hashes.
  • preparing: referenced organisation resources are still being resolved; retry the preview.
  • failed: the restore is blocked by the listed issues.
Available options:
ready,
preparing,
failed
restore_kind
enum<string>
required
Available options:
exact
target_version
integer
required

Version number being restored.

target_version_id
string<uuid>
required
Example:

"550e8400-e29b-41d4-a716-446655440000"

current_version
integer | null
required

The agent's latest version number.

current_version_id
string<uuid> | null
required
Example:

"550e8400-e29b-41d4-a716-446655440000"

current_config_hash
string
required

Content hash of the agent's current config.

target_config_hash
string
required

Content hash of the version being restored.

candidate_config_hash
string | null

Content hash of the config that would be applied.

acceptance_hash
string | null

Opaque hash binding this preview; pass it unchanged to the accept endpoint. Present when state is ready.

changed_fields
string[]

Top-level config fields that would change.

issues
object[]
preparation
object | null

Source of candidate_hash, resource_hash, and dependency_hash for the accept request.

candidate
object | null

The config document that would be applied.