Skip to main content
POST
Create a worker

Authorizations

Authorization
string
header
required

An organization-scoped API key, minted in control under Settings → API keys. Every failure to authenticate answers one identical 401: "Provide a valid organization-scoped API key or an active session." Each operation names the one scope it is filed under, <resource>:<read|write>, where the resource is the first path segment after /api/v1/; a key minted today carries all 22 of them. Scopes are RECORDED — on the key and on every audit row — and are not yet enforced: no request is refused for want of one.

Headers

Idempotency-Key
string

Any unique string.

Body

application/json
slug
string
required

Lowercase letters, digits and dashes. Unique within the organization.

displayName
string
required

The name the agent answers to. 80 characters or fewer.

roleTitle
string

The role it presents as.

description
string

What it is for.

responsibilities
string

Its responsibilities list, as Markdown (- per line), 2000 characters or fewer. The Worker holds itself to it.

reportsTo
object

Where it sits on the Company chart: {placementId} or {slackUserId}. Omit to leave it off the chart.

Response

Success.

data
object
required