Versions

Sync a version

Schedules a sync for a Bubble branch and waits briefly for completion. Returns HTTP 200 when the sync completed in the wait window or failed in the wait window, and HTTP 202 when the sync is still running and should be polled with GET /api/public/v1/versions/status?appId=...&versionId=....

POST /api/public/v1/versions/sync

Sync a version

curl --request POST \
  --url 'https://api.buildprint.ai/api/public/v1/versions/sync' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "value"
}'
{
  "ok": true,
  "status": "in_progress",
  "stage": "pending",
  "versionId": "<string>",
  "version": "<string>",
  "appVersion": "<string>",
  "message": "<string>",
  "error": "<string>"
}

The sync completed or failed during the wait window.

Authorizations

  • Authorization string required header

    Workspace REST API token prefixed with bp_

Request Body

application/json
  • appId string required

    Bubble app ID for the project to sync.

  • version string required

    Bubble branch selector to sync. Accepts a branch ID or display label.

Response

application/json
  • ok boolean

    Always true when the request was accepted.

  • status string enum enum

    High-level sync status derived from the stage. Allowed values: in_progress, completed, failed.

  • stage string enum enum

    Lifecycle stage of the synced version. Allowed values: pending, stored, indexing, completed, failed.

  • versionId string

    Exact Buildprint synced version ID created for this sync run.

  • version string

    Canonical Bubble branch ID that was synced.

  • appVersion string

    Alias of version for compatibility.

  • message string

    Human-readable status guidance.

  • error string

    Failure message when the sync status is failed.