Skip to content
Handinger
Get started
Overview

API Reference

Libraries

TypeScript
0.10.1
npm install @ramensoft/handinger
Read Docs
Python
0.23.0
pip install handinger
Read Docs
Go
0.11.0
go get -u 'github.com/ramensoft/[email protected]'
Read Docs
Ruby
0.11.0
gem "handinger"
Read Docs
CLI tool
0.14.0
brew install ramensoft/tools/handinger
Read Docs

API Overview

Workers

Create, retrieve, and manage agent worker templates.

Create a worker template
POST/api/workers
Retrieve a worker
GET/api/workers/{workerId}
Update a worker template
PATCH/api/workers/{workerId}
Delete a worker template
DELETE/api/workers/{workerId}
Retrieve a worker email address
GET/api/workers/{workerId}/email

WorkersSchedules

Manage future and recurring worker tasks.

List worker schedules
GET/api/workers/{workerId}/schedules
Create a worker schedule
POST/api/workers/{workerId}/schedules
Cancel a worker schedule
DELETE/api/workers/{workerId}/schedules/{scheduleId}

WorkersWebhooks

Configure outbound webhooks delivered when a worker’s tasks complete.

Retrieve a worker webhook
GET/api/workers/{workerId}/webhook
Update a worker webhook
PUT/api/workers/{workerId}/webhook
Delete a worker webhook
DELETE/api/workers/{workerId}/webhook
Regenerate a worker webhook token
POST/api/workers/{workerId}/webhook/regenerate-token
List worker webhook executions
GET/api/workers/{workerId}/webhook/executions

Tasks

Run and inspect tasks against a worker.

Create a task
POST/api/tasks
Retrieve a task with its turns
GET/api/tasks/{taskId}
Archive a task
DELETE/api/tasks/{taskId}