Skip to main content
POST
/
api
/
v1
/
workspaces
/
{workspace_id}
/
sync
/
checkpoint-download-url
Get Checkpoint Download Urls
curl --request POST \
  --url https://api.example.com/api/v1/workspaces/{workspace_id}/sync/checkpoint-download-url \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "checkpoint_id": "<string>"
}
'
{
  "head_bundle_url": "<string>",
  "checkpoint_bundle_url": "<string>",
  "head_sha": "<string>",
  "exists": true,
  "error": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
workspace_id
string
required

Body

application/json

Request for presigned download URLs to restore a checkpoint.

The checkpoint_id is used to look up the checkpoint metadata from the database (worktree.checkpoint_metadata), which contains the head_sha needed to download the HEAD bundle.

​
checkpoint_id
string
required

Response

Successful Response

Response containing presigned download URLs for checkpoint restoration.

To restore a checkpoint remotely:

  1. Download and apply head_bundle_url (if provided) - contains commits up to HEAD
  2. Download and apply checkpoint_bundle_url - contains incremental checkpoint data

For checkpoints created in empty repos (no HEAD), head_bundle_url will be null.

​
head_bundle_url
string | null
required
​
checkpoint_bundle_url
string | null
required
​
head_sha
string | null
required
​
exists
boolean
required
​
error
string | null