Checkpoints API

Overview

The Checkpoints API treats git commits as workspace checkpoints. You can list the checkpoint history, create a new checkpoint by committing the current working tree, tag a checkpoint, and restore the workspace to a previous checkpoint. This is file-system checkpointing for local or VM-bound workspaces, distinct from run/job cursor state.

Base URL

https://api.allternit.com/api/checkpoints

All endpoints require authentication via a Bearer token in the Authorization header unless the route is otherwise noted. See Authentication for details.

Endpoints

Method	Path	Description
GET	`/api/checkpoints`	List checkpoints for a working directory.
POST	`/api/checkpoints`	Create a checkpoint by committing the working tree.
POST	`/api/checkpoints/commit`	Alias for creating a checkpoint.
POST	`/api/checkpoints/tag`	Tag an existing checkpoint.
POST	`/api/checkpoints/:id/restore`	Restore the workspace to a checkpoint.

List checkpoints

GET /api/checkpoints?workdir=/path/to/repo

Query parameters:

Parameter	Type	Description
`workdir`	string	Optional absolute path to the git working directory. Defaults to the server process current directory.

Response when inside a git repository:

{
  "checkpoints": [
    {
      "id": "a1b2c3d4e5f6",
      "hash": "a1b2c3d4e5f6",
      "message": "WIP: refactor auth module",
      "author": "Gizzi Code",
      "timestamp": "2026-08-13T10:00:00Z",
      "tags": ["release-v1.2"],
      "branch": "main"
    }
  ],
  "currentBranch": "main",
  "initialized": true
}

Response when not inside a git repository:

{
  "checkpoints": [],
  "currentBranch": "main",
  "initialized": false
}

Create checkpoint

POST /api/checkpoints

Request body:

{
  "message": "WIP: refactor auth module",
  "workdir": "/path/to/repo"
}

Response:

{
  "hash": "a1b2c3d4e5f6",
  "id": "a1b2c3d4e5f6",
  "author": "Gizzi Code",
  "status": "created"
}

The endpoint stages all changes (git add -A) and creates a commit with the provided message. An empty message returns 400 Bad Request.

Tag checkpoint

POST /api/checkpoints/tag

Request body:

{
  "checkpointId": "a1b2c3d4e5f6",
  "tagName": "release-v1.2",
  "workdir": "/path/to/repo"
}

Response:

{
  "status": "tagged",
  "checkpointId": "a1b2c3d4e5f6",
  "tagName": "release-v1.2"
}

Restore checkpoint

POST /api/checkpoints/a1b2c3d4e5f6/restore

Before restoring, any uncommitted work is stashed with the message pre-restore-<checkpointId>. The current branch is then reset hard to the target commit. Response:

{
  "restored": true,
  "checkpointId": "a1b2c3d4e5f6"
}

Error codes

Status	Code	Description
200	—	Success.
400	`message is required`	Checkpoint creation request is missing a message.
400	`tagName is required`	Tag request is missing a tag name.
401	`unauthorized`	Missing or invalid authentication.
404	`unknown checkpoint`	The requested checkpoint hash does not exist.
409	`workdir is not a git repository`	The target directory is not inside a git working tree.
500	`internal_error`	Unexpected server error.

Overview

LLM Gateway

Agents & Runtime

Work Queue & Deployments

Files, Webhooks & Sandbox

Tools & Connectors

Collaboration & Workflows

Infrastructure & Platform

Canvases

Onboarding

A Labs

Playground

Users & Profiles

Overview

Base URL

Endpoints

List checkpoints

Create checkpoint

Tag checkpoint

Restore checkpoint

Error codes

​Overview

​Base URL

​Endpoints

​List checkpoints

​Create checkpoint

​Tag checkpoint

​Restore checkpoint

​Error codes

​Related links

Overview

Base URL

Endpoints

List checkpoints

Create checkpoint

Tag checkpoint

Restore checkpoint

Error codes

Related links