snapshot

Restore the personal workspace to a snapshot, or preview it with dryRun

Changed on Nov 8, 2026

post/api/preview/snapshots/{id}/restore

Request

Base URL
https://symbol.chat (the document declares no server; this is the origin it was published from)
Auth
- HTTP bearer
- or API key in cookie __Secure-next-auth.session-token
- or OAuth 2
  Authorization codehttps://mcp.symbol.chat/authorize
  Token URLhttps://mcp.symbol.chat/token
TypeScript
https://skmtc.dev/symbol-chat/apis/symbol-api/docs/api/preview/snapshots/:id/restore/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

UUID v4 string

Request body

confirmation_tokenstring

The token a dry run of this snapshot returned, within 15 minutes of it. A real restore without a valid one is refused with dry_run_required: from the start for Symbol's assistant tools and CLI (requests sending x-symbol-ai-client) and for a token that is sent but does not verify, and for any other API key or organization key from the effective date in the API changelog (issue #2522). A browser session does not send one.

dryRunboolean

Preview the restore without writing anything.

Response

Successful response

confirmation_expires_atstring

Present on a dry run: when confirmation_token stops being accepted (ISO 8601).

confirmation_tokenstring

Present on a dry run. Send it as confirmation_token with dryRun: false to restore this snapshot. A restore without it is refused with dry_run_required: from the start for Symbol's assistant tools and CLI, and for any other API key or organization key from the effective date in the API changelog.

Changes

Nov 8, 2026fd7b0a7085e4 Revision changes
- info
  added the optional property / to the response with the status
Oct 19, 20265778844d1f9e Revision changes
- info
  added the new optional request property
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property /// to the response with the status
- info
  added the required property /// to the response with the status

Operation history (3 revisions)