Docs
Sign in

Add a task to a running or paused crew.

POST/api/v1/crews/{id}/tasks

Scopecrews

No query parameters.

Path parameters.

idstringrequired

The crew's id.

Headers.

Idempotency-Keystring

Makes a retry safe: the same key with the same request returns the first answer and does nothing else.

Body.

titlestringrequired

A short name for the task, shown on the timeline and the pull request. At least 1 character.

instructionsstringrequired

What the agent should do: the whole brief it is given for this task. At least 1 character.

roleenum

The kind of agent that does it. One of manager, builder, tester, reviewer, researcher, integrator. Default builder.

requiresobject

What the machine must have to run it. Left out, any machine the crew may use. Default {"tools":[]}.

ShowHide 3 fields

osenum

Only machines with this operating system. One of macos, linux.

xcodeboolean

Only machines with Xcode installed.

toolsarray

Command names the machine must have (as the node reports them), such as xcodebuild or docker. Default empty.

Response.

201 Created: a Task. The example has placeholder values.

422 validation_failed
The body does not match its schema; each problem is in details.