Skip to main content
POST
Create worker

Authorizations

Authorization
string
header
required

API token from cargo-ai login. Send as Authorization: Bearer <token>.

Headers

Idempotency-Key
string

Client-generated key that makes this write safe to retry. Reusing the same key with the same request returns the original response instead of creating a second record. Reusing it with a different request returns 422. A concurrent retry while the first request is still running returns 409. Keys expire after 24 hours. Not accepted on multipart file uploads. Optional: a request without one is processed as it always was.

Maximum string length: 255
Example:

"8e03978e-40d5-43e8-bc93-6894a57f9324"

Body

application/json

Request body schema.

name
string
required

Worker name.

Required string length: 1 - 255
slug
string
required

Worker URL slug.

Pattern: ^[a-z][a-z0-9-]{2,30}$
folderUuid
string<uuid>

Folder identifier for the worker.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$
description
string

Worker description.

Required string length: 1 - 1000
triggers
Triggers · object[]

Cron triggers for the worker. Each trigger calls the worker's URL at the given path on the schedule.

Maximum array length: 10

Response

Create worker

worker
Worker · object
required

Created worker details.