Workflows platform

REST API

83 endpoints across 7 services, generated from each service's source.

Services

Each service mounts its own paths. Several of them expose overlapping /v1/... routes, so a path on its own does not tell you which service answers it. Send the request to the host running the service you want.

Authentication

Every service takes an API credential as a bearer token. A few endpoints are public and are marked as such on their own entry. Assume a call needs the header unless the endpoint says otherwise.

Authorization header
curl https://<service-host>/v1/apps \
  -H "Authorization: Bearer $AWEE_TOKEN"

Base URL

Every path on these pages is relative to the host running that service. Each deployment chooses its own hosts, so no base URL is published here.

Errors

A failure returns the HTTP status and a JSON body with a single error field. The shape is the same on every endpoint of every service.

Error body
{
  "error": "app not found"
}