Client App BuilderVersion: v3

Save the app's sandbox files as the point it restarts from.

POST/ai-builder-api/cli/projects/{projectId}/sandbox/checkpoint

Saves the sandbox's files so a sandbox that restarts comes back with them. Call it after a set of POST .../sandbox/edit calls and before starting the run that builds them: a sandbox that restarts in between otherwise comes back with the files as they were at the last save.

Authorizations

Authorizationstringheaderrequired

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

Scope:clientportal-ai.write

Auth methods:OAuthPrivate Integration

Token type:Sub-Account Token

Request

Headers

Versionstringrequired

The API version.

Available optionsv3

Example:v3

Path Parameters

projectIdstringrequired

Project identifier.

Possible values: Value must match regular expression ^prj_[A-Za-z0-9_-]+$

Example:prj_01HXQ8Z6J9K2

Body

application/json

reasonstring

turn_complete after a set of edits (the default); build_passed after a build that passed.

Available optionsturn_completebuild_passed

Example:turn_complete

Response

application/json

The save's result; ok says whether the files are saved.

okbooleanrequired

Whether the files were saved.

Example:true

outcomeobject

What the save did, in kind. Saved (ok true): ok, or skipped_clean when nothing changed since the last save. Not saved (ok false): skipped_concurrent, another save was running, so call again in about a minute; failed, with error; saving, the sandbox did not answer within 20s because a large app's save (a phone app's takes about a minute) is still running, and it finishes on its own.