Skip to main content

​
Requests

Send Authorization: Bearer <access token> with every request. The token must be issued for the API origin plus /api/v1. See authentication for how to get one.

​
Calling operations by name

POST /api/v1/operations/{name} takes all of an operation’s inputs as one JSON object, including the ones that would normally go in the path. It works for every operation, including reads.

​
OpenAPI and discovery

The schema is OpenAPI 3.1, and works with most API clients and code generators.

​
Pagination

List operations return a limited number of items. Respect each operation’s limit range, and pass back the nextCursor it returns as cursor. Treat these values as opaque, and only reuse them with the same operation and filters. Long fields, such as task descriptions, handbook entries and run output, can also be paged with field and a character offset. If the response includes nextOffset, there’s more to read.

​
Retries

Read errors and retries before you add automatic retries. A request that timed out may still have created a task or reminder, or queued an action, so check before you send it again. Test with your own client, in a workspace you don’t mind changing.