Introduction

Base URL

Current deployed API URL in this workspace:

https://2dr03s75sl.execute-api.us-west-2.amazonaws.com

Client-facing routes require the x-api-key header.

x-api-key: your-api-key

If the header is missing or invalid, the API returns 401.

Every successful response is wrapped in:

{
  "ok": true,
  "data": {}
}

Every error response is wrapped in:

{
  "ok": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Human readable message"
  }
}

Method	Path	Purpose
`POST`	`/cases`	Create a new asynchronous coordination case
`GET`	`/cases/{id}`	Retrieve the current case status
`POST`	`/cases/{id}/input`	Resume a case that is waiting for human input

Status	Meaning
`CREATED`	Accepted and persisted, waiting for async processing
`RUNNING`	Outreach or follow-up is in progress
`INPUT_NEEDED`	Offload is paused and waiting for your answer
`COMPLETED`	Goal achieved and structured result is available
`FAILED`	Workflow could not complete

If clientWebhookUrl is set on case creation, Offload sends outbound POST requests when a case:

See Webhook events for payloads.

The raw specification lives at openapi.json.