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.

Request

Version stringrequired

The API version.

Available optionsv3

projectId stringrequired

Project identifier.

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

application/json

application/json

Body

Body

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

Example (auto)

{
  "reason": "turn_complete"
}

application/json

The files were saved.

application/json

Schema

Schema

okbooleanrequired

Whether the files were saved.

outcomeobject

What the save did, as the sandbox reports it: ok, or skipped_clean when nothing changed since the last save.

Example (auto)

{
  "ok": true,
  "outcome": {
    "kind": "ok"
  }
}