Installation & Usage

Install this tool and use it with the AI SDK

1. Install the package

npm install @tpmjs/tools-sprites-delete

pnpm add @tpmjs/tools-sprites-delete

yarn add @tpmjs/tools-sprites-delete

bun add @tpmjs/tools-sprites-delete

deno add npm:@tpmjs/tools-sprites-delete

2. Import the tool

import { spritesDeleteTool } from '@tpmjs/tools-sprites-delete';

3. Use with AI SDK

import { generateText } from 'ai';
import { openai } from '@ai-sdk/openai';
import { spritesDeleteTool } from '@tpmjs/tools-sprites-delete';

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

console.log(result.text);

Parameters

Available configuration options

Auto-extracted

name

Required

Type: string

Name of the sprite to delete

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

README

@tpmjs/sprites-delete

Delete a sprite and all its associated data including checkpoints.

Installation

npm install @tpmjs/sprites-delete

Requirements

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

Usage

import { spritesDeleteTool } from '@tpmjs/sprites-delete';

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

console.log(result);
// {
//   deleted: true,
//   name: 'my-sandbox'
// }

Input Parameters

Parameter	Type	Required	Description
`name`	`string`	Yes	Name of the sprite to delete

Output

Field	Type	Description
`deleted`	`boolean`	Whether deletion was successful
`name`	`string`	Name of the deleted sprite

Warning

This action is irreversible. All data associated with the sprite, including:

Filesystem contents
All checkpoints
Execution history

will be permanently deleted.

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

spritesDeleteTool

Interactive Playground