@taskrun/sdk

TypeScript SDK for the taskrun AI Task Orchestration Platform.

Installation

npm install @taskrun/sdk

Usage

import { TaskRunSDK } from '@taskrun/sdk';

// Initialize the SDK
const taskrun = new TaskRunSDK({
  baseUrl: 'https://api.taskrun.dev',
  getHeaders: () => ({
    'x-api-key': 'your-api-key'
  })
});

// Create a run
const run = await taskrun.runs.create({
  prompt: 'Write a hello world function',
  agent: {
    name: 'my-agent',
    adapter: 'claude-code'
  }
});

// Get run status
const status = await taskrun.runs.get(run.id);

// List runs
const runs = await taskrun.runs.list();

Features

• ✅ Type-safe - Full TypeScript support with generated types
• ✅ Modern - ESM and CJS support
• ✅ Flexible Auth - Support for API keys, Bearer tokens, and custom headers
• ✅ Complete - Full API coverage for runs, tasks, templates, volumes, and more

API Reference

Runs

• runs.create(data) - Create a new run
• runs.get(id) - Get run details
• runs.list(params) - List runs with filters
• runs.cancel(id) - Cancel a running run
• runs.sendMessage(id, data) - Send a message to a run
• runs.getMessages(id, params) - Get run messages
• runs.getRunStats(params) - Get run statistics

Tasks

• tasks.create(data) - Create a new task
• tasks.get(id) - Get task details
• tasks.list(params) - List tasks
• tasks.cancel(id) - Cancel a task

Templates

• templates.create(data) - Create agent template
• templates.get(id) - Get template
• templates.list(params) - List templates
• templates.update(id, data) - Update template
• templates.delete(id) - Delete template

Volumes

• volumes.create(data) - Create volume
• volumes.get(id, includeStats, includeTasks) - Get volume
• volumes.list(type, isShared, limit, offset) - List volumes
• volumes.update(id, data) - Update volume
• volumes.delete(id) - Delete volume
• volumes.getTasks(id, limit, offset) - Get volume tasks

Configuration

new TaskRunSDK({
  baseUrl: string;           // API base URL (routes include /api/v1 prefix)
  timeout?: number;          // Request timeout in ms (default: 30000)
  getHeaders?: () => Record<string, string>; // Dynamic headers (recommended)
  getToken?: () => string;   // Bearer token (legacy)
})

License

Apache-2.0 - Copyright 2025 Filipe Labs LTDA

Links

• Documentation
• GitHub
• Website