Installation & Usage

Install this tool and use it with the AI SDK

1. Install the package

npm install @tpmjs/tools-sprites-get

pnpm add @tpmjs/tools-sprites-get

yarn add @tpmjs/tools-sprites-get

bun add @tpmjs/tools-sprites-get

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

2. Import the tool

import { spritesGetTool } from '@tpmjs/tools-sprites-get';

3. Use with AI SDK

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

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

console.log(result.text);

Parameters

Available configuration options

Auto-extracted

name

Required

Type: string

Name of the sprite to retrieve

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

README

@tpmjs/sprites-get

Retrieve details of a specific sprite by name including status and configuration.

Installation

npm install @tpmjs/sprites-get

Requirements

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

Usage

import { spritesGetTool } from '@tpmjs/sprites-get';

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

console.log(result);
// {
//   name: 'my-sandbox',
//   status: 'running',
//   createdAt: '2024-01-15T10:30:00Z',
//   runtime: 'node:20'
// }

Input Parameters

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

Output

Field	Type	Description
`name`	`string`	Name of the sprite
`status`	`'creating' \| 'running' \| 'stopped' \| 'error'`	Current status
`createdAt`	`string`	ISO 8601 timestamp of creation
`runtime`	`string?`	Optional runtime configuration
`metadata`	`object?`	Optional custom metadata

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

spritesGetTool

Interactive Playground