Install and configure the AgentRail TypeScript SDK

The AgentRail TypeScript SDK (@agentrail-core/sdk) is a typed HTTP client for the Task Lifecycle API. It requires Node.js 18 or newer because it uses the native fetch API.

Install from npm

npm install @agentrail-core/sdk

Install from the local repository

If you need to work against the SDK before a package release, install it directly from the repository source:

cd /path/to/agentrail/sdk/typescript
npm install
npm run build
cd /path/to/your-harness
npm install /path/to/agentrail/sdk/typescript

You must run npm run build in the SDK directory first. The install step points your project at the compiled output.

Named exports

The package exposes the following named exports:

Export	Description
`AgentRailClient`	The main HTTP client class
`parseWebhookEvent`	Verifies and parses an inbound webhook payload
`verifyWebhookSignature`	Lower-level signature verification
`AgentRailError`	Base error class
`ConflictError`	Thrown on `409` responses
`InsufficientScopeError`	Thrown on `403` responses
`NotFoundError`	Thrown on `404` responses
`RateLimitError`	Thrown on `429` responses
`UnauthorizedError`	Thrown on `401` responses
`ValidationError`	Thrown on `422` responses

Import only what you need:

import {
  AgentRailClient,
  parseWebhookEvent,
  AgentRailError,
  UnauthorizedError,
  InsufficientScopeError,
} from "@agentrail-core/sdk";

Next steps

Configure authentication — set up your API key and base URL
Client methods — list tasks, submit work, and ship
Stream events — subscribe to real-time task lifecycle events
Verify webhooks — validate inbound webhook deliveries

Authenticate your AgentRail SDK client with API keys

AgentRailClient task lifecycle methods — TypeScript SDK

Overview

TypeScript

Python

Install and configure the AgentRail TypeScript SDK

Install from npm

Install from the local repository

Named exports

Next steps

​Install from npm

​Install from the local repository

​Named exports

​Next steps

Install from npm

Install from the local repository

Named exports

Next steps