Skip to main content
POST
/
api
/
v1
/
workers
/
register
Error
A valid request URL is required to generate request examples
{
  "worker_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request to register a worker

​
project_id
string
required

Project ID

​
capabilities
any

Worker capabilities

​
deployment_id
string | null

Deployment ID (optional, uses latest if not provided)

​
max_concurrent_executions
integer<int32> | null

Maximum concurrent executions

​
mode
string | null

Worker mode (push)

​
push_endpoint_url
string | null

Push endpoint URL for receiving work

Response

Worker registered

Response after registering a worker

​
worker_id
string
required

Assigned worker ID