Create checkpoint

This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.

Saves the app’s current state as a new checkpoint, so you can return to it later with Restore checkpoint.

A checkpoint records the app’s committed code, its entity schemas and its backend functions. Nothing is saved when the app has not changed since its most recent checkpoint: you get a 200 with created set to false and reason set to no_changes, and the checkpoint you already have stands.

That check is not a guarantee against duplicates. Two requests in flight at the same time can both find nothing changed and both save a checkpoint, so retrying before the first request has finished can leave you with two. Send one at a time, and read List checkpoints rather than retrying blind.

Saving a checkpoint starts its preview build in the background. Poll List checkpoints and watch the new checkpoint’s preview_status to see when the preview is ready.

Set branch_id to work with a branch’s checkpoints instead of main’s. A branch has its own checkpoints and starts with none, so main’s checkpoints from before the branch was created aren’t included. A branch’s checkpoints can’t be deployed: Deploy an app works from main only. On a branch, a checkpoint records the branch’s code, and the “has not changed” check compares it with the branch’s own latest checkpoint, so a branch’s first checkpoint is always saved.

This endpoint accepts a personal API key. A read-only key is refused, and workspace API keys are not accepted.

POST /api/apps/{app_id}/app-checkpoints

Create checkpoint

cURL

curl --request POST \
  --url https://app.base44.com/api/apps/{app_id}/app-checkpoints \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Manual Edits"
}
'

200

{
  "created": true,
  "checkpoint_id": "6886b8d390dc7e2f4a2c91b3",
  "reason": "no_changes"
}

Authorizations

Authorization · string · header · required

Personal access token, sent as Authorization: Bearer <token>. Each operation lists the permission it needs: read_only or full_access. A full-access token can call every operation. A read-only token can call only the operations that list read_only; anything else returns 403 read_only_credential_route_not_allowed.

Path Parameters

app_id · string · required

ID of the app.

Query Parameters

branch_id · string

ID of the branch to work on, as returned by List branches. Omit it to work on the app's main branch.

Body

application/json

name · string · default: Manual Edits

Name for the checkpoint, shown in the app's version history. Send a non-empty value: an empty string is not stored, and the checkpoint is named after the app's most recent chat message instead.

Example:

"Before pricing rework"

Response

200

application/json

Whether a checkpoint was saved, and its ID if one was.

created · boolean · required

Whether a checkpoint was saved. false means the app has not changed since its most recent checkpoint, so there was nothing to save.

Example:

true

checkpoint_id · string | null

ID of the checkpoint that was saved, or null when created is false. Pass it as checkpoint_id to Deploy an app to publish this version, or as checkpoint_id to Restore checkpoint to return to it.

Example:

"6886b8d390dc7e2f4a2c91b3"

reason · string | null

Why nothing was saved. no_changes is the only value, and it is null when created is true.

Example:

"no_changes"