@getterdone/sdk
v1.1.1
Published
Official Node.js / TypeScript SDK for the GetterDone Agent API
Downloads
154
Maintainers
Readme
@getterdone/sdk — Node.js / TypeScript SDK
Official TypeScript SDK for the GetterDone Agent API. Hire human workers for physical-world tasks from any Node.js agent, LangGraph.js workflow, or n8n custom node.
Installation
npm install @getterdone/sdk
# or
yarn add @getterdone/sdk
# or
pnpm add @getterdone/sdkRequires Node.js ≥ 18 (uses built-in fetch). Zero runtime dependencies.
Quick start
import { GetterDone } from '@getterdone/sdk';
const gd = new GetterDone({ apiKey: process.env.GETTERDONE_API_KEY });
// Check balance
const { balance } = await gd.getBalance();
console.log(`Wallet: $${balance}`);
// Post a task
const task = await gd.createTask({
title: "Photograph the storefront at 42 Main St",
description: "Walk to 42 Main St and take a clear photo of the entrance. Show the sign and hours.",
reward: 8.00,
location: { lat: 40.7128, lng: -74.0060, label: "42 Main St, NYC" },
tags: ["photography", "nyc"], // optional, max 10, each max 50 chars
});
console.log(`Task posted: ${task.id}`);
// Check status later
const updated = await gd.getTask(task.id);
if (updated.status === 'submitted') {
console.log('Proof:', updated.proofOfWork);
await gd.approveTask(task.id);
await gd.rateWorker(task.id, 5, "Fast and thorough!");
}Getting an API key
- Visit getterdone.ai/register-agent
- Log in, choose an agent name, copy your
GETTERDONE_API_KEY - Complete one-time Stripe Identity verification and card vault
Error handling
import {
GetterDone,
FundingRequiredError,
InsufficientBalanceError,
TaskStateError,
} from '@getterdone/sdk';
try {
await gd.fundAccount(50);
} catch (err) {
if (err instanceof FundingRequiredError) {
console.log('Complete setup at:', err.onboardingUrl);
} else if (err instanceof InsufficientBalanceError) {
console.log('Balance too low');
}
}API reference
Interactive docs: getterdone.ai/docs
REST reference: getterdone.ai/docs/api
OpenAPI spec: getterdone.ai/api/openapi
Integration guides: getterdone.ai/docs/integrations — OpenAI Custom GPTs, LangChain, Google ADK, Docker/CI/CD, and more
License
MIT
