POST/workers

Create a project worker

Returns a one-time worker token and installation descriptor.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Request body

application/jsonrequired

project_idrequired

namestringrequired

descriptionstringoptional

countrystringrequired

worker_runtimestringrequired

specsrequired

Responses

201application/json

Worker created. Store the plaintext worker token immediately.

{
  "status": "success",
  "data": {
    "worker": {
      "id": "65f0c7a9a7d6b4e2c1234567",
      "name": "string",
      "display_name": "string",
      "description": "string",
      "worker_runtime": "kubernetes",
      "country": "string",
      "project_id": "65f0c7a9a7d6b4e2c1234567",
      "org_id": "65f0c7a9a7d6b4e2c1234567",
      "status": "created",
      "specs": {
        "max_parallel_jobs": 1
      },
      "capacity": {},
      "agent_image_digest": "string",
      "agent_install": {
        "agent_namespace": "string",
        "job_namespace": "string",
        "scratch_storage_class": "string"
      },
      "agent_update": "current",
      "created_at": "2026-01-01T00:00:00Z",
      "updated_at": "2026-01-01T00:00:00Z",
      "last_seen": "2026-01-01T00:00:00Z"
    },
    "worker_token": "string",
    "worker_api_url": "https://example.com",
    "worker_grpc_target": "string",
    "install": {}
  }
}

400application/json

The request body, parameter, filter, cursor, or project-scoping pattern is invalid.

{
  "status": "error",
  "message": "string",
  "code": "string",
  "detail": {},
  "quota": {
    "key": "string",
    "limit": 1,
    "used": 1
  },
  "feature": "string",
  "dependency": "string"
}

statusstringrequired

messagestringrequired

codestringoptional

Stable machine-readable code when the error defines one.

detailobjectoptional

quotaoptional

featurestringoptional

dependencystringoptional

401application/json

Authentication is missing or the credential is invalid, inactive, expired, or lacks the required scope.

{
  "status": "error",
  "message": "string",
  "code": "string",
  "detail": {},
  "quota": {
    "key": "string",
    "limit": 1,
    "used": 1
  },
  "feature": "string",
  "dependency": "string"
}

statusstringrequired

messagestringrequired

codestringoptional

Stable machine-readable code when the error defines one.

detailobjectoptional

quotaoptional

featurestringoptional

dependencystringoptional

403application/json

The authenticated caller is not allowed to perform this operation.

{
  "status": "error",
  "message": "string",
  "code": "string",
  "detail": {},
  "quota": {
    "key": "string",
    "limit": 1,
    "used": 1
  },
  "feature": "string",
  "dependency": "string"
}

statusstringrequired

messagestringrequired

codestringoptional

Stable machine-readable code when the error defines one.

detailobjectoptional

quotaoptional

featurestringoptional

dependencystringoptional

409application/json

The requested change conflicts with the resource's current state or dependencies.

{
  "status": "error",
  "message": "string",
  "code": "string",
  "detail": {},
  "quota": {
    "key": "string",
    "limit": 1,
    "used": 1
  },
  "feature": "string",
  "dependency": "string"
}

statusstringrequired

messagestringrequired

codestringoptional

Stable machine-readable code when the error defines one.

detailobjectoptional

quotaoptional

featurestringoptional

dependencystringoptional

503application/json

A required service is temporarily unavailable.

{
  "status": "error",
  "message": "string",
  "code": "string",
  "detail": {},
  "quota": {
    "key": "string",
    "limit": 1,
    "used": 1
  },
  "feature": "string",
  "dependency": "string"
}

statusstringrequired

messagestringrequired

codestringoptional

Stable machine-readable code when the error defines one.

detailobjectoptional

quotaoptional

featurestringoptional

dependencystringoptional