Installation & Usage

Install this tool and use it with the AI SDK

1. Install the package

npm install @tpmjs/tools-sprites-checkpoint-list

pnpm add @tpmjs/tools-sprites-checkpoint-list

yarn add @tpmjs/tools-sprites-checkpoint-list

bun add @tpmjs/tools-sprites-checkpoint-list

deno add npm:@tpmjs/tools-sprites-checkpoint-list

2. Import the tool

import { spritesCheckpointListTool } from '@tpmjs/tools-sprites-checkpoint-list';

3. Use with AI SDK

import { generateText } from 'ai';
import { openai } from '@ai-sdk/openai';
import { spritesCheckpointListTool } from '@tpmjs/tools-sprites-checkpoint-list';

const result = await generateText({
  model: openai('gpt-4o'),
  tools: { spritesCheckpointListTool },
  prompt: 'Your prompt here...',
});

console.log(result.text);

Parameters

Available configuration options

Auto-extracted

name

Required

Type: string

Name of the sprite to list checkpoints for

Schema extracted: 1/16/2026, 3:45:35 AM

README

@tpmjs/sprites-checkpoint-list

List all checkpoints for a sprite ordered by creation time.

Installation

npm install @tpmjs/sprites-checkpoint-list

Requirements

SPRITES_TOKEN environment variable - Get your token from https://sprites.dev

Usage

import { spritesCheckpointListTool } from '@tpmjs/sprites-checkpoint-list';

const result = await spritesCheckpointListTool.execute({
  name: 'my-sandbox'
});

console.log(result);
// {
//   checkpoints: [
//     { id: 'chk_abc123', name: 'before-experiment', createdAt: '2024-01-15T10:30:00Z', size: 52428800 },
//     { id: 'chk_def456', name: 'initial-setup', createdAt: '2024-01-14T08:00:00Z', size: 10485760 }
//   ],
//   count: 2
// }

Input Parameters

Parameter	Type	Required	Description
`name`	`string`	Yes	Name of the sprite to list checkpoints for

Output

Field	Type	Description
`checkpoints`	`Checkpoint[]`	Array of checkpoints ordered by creation time
`count`	`number`	Total number of checkpoints

Checkpoint Object

Field	Type	Description
`id`	`string`	Unique checkpoint identifier (use this for restore)
`name`	`string?`	Optional human-readable name
`createdAt`	`string`	ISO 8601 timestamp of creation
`size`	`number?`	Checkpoint size in bytes

Use Cases

Find checkpoint IDs for restoration
Review available restore points
Audit checkpoint history
Clean up old checkpoints

Error Handling

The tool throws errors in these cases:

SPRITES_TOKEN environment variable is not set
Sprite not found (HTTP 404)
Invalid or expired API token (HTTP 401)
Network timeout (30 second limit)
API errors with descriptive messages

License

MIT

spritesCheckpointListTool

Interactive Playground