Skip to main content
POST
Create checkpoint

Authorizations

api_key
string
header
required

Personal API key.

Path Parameters

app_id
string
required

ID of the app.

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

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"