Skip to main content
POST
Start from task spec and stream

Authorizations

Authorization
string
header
default:YOUR_AUTUMN_API_KEY
required

Use Authorization: Bearer YOUR_AUTUMN_API_KEY.

Body

application/json
task
object

task.json-style spec with brief, one optional output, skills, rules, and input files.

brief
string | null

Convenience field for direct starts without nesting task.

prompt
string | null

Optional instruction appended to the task brief, or used as the task brief when task is omitted.

clarify
boolean | null

Only affects starts that plan (a prompt or bare brief). If true, the agent may ask one blocking planning question before work begins; if false (default) it plans autonomously and starts executing. Has no effect when a full task spec is provided: that executes directly.

output
object | null

Optional single output hint. Include id, kind, path, name, and, for research outputs, schema, schema_order, and target_count.

version
enum<string>

Model tier for the task. ranger (default) is the most capable model with the deepest reasoning; scout is faster on a tuned harness. Set at start only and fixed for the life of the task.

Available options:
ranger,
scout
Example:

"scout"

Response

SSE stream of task, tool, text, error, and done events.

The response is of type string.