Skip to main content
POST
Start a task and stream

Authorizations

X-API-Key
string
header
default:YOUR_AUTUMN_API_KEY
required

Your Autumn API key.

Body

application/json
task_id
string | null

Continue this task instead of creating one.

name
string | null

Display name. Derived from the prompt when omitted.

clarify
boolean
default:false

Allow one blocking planning question before work starts. Default false: plan and execute without asking.

input_files
string[] | null

Task-local filenames returned by POST /validate-upload.

output
Output · object | null

The output artifact to collect: id, kind, path, name; for research also schema, schema_order, target_count.

outputs
Outputs · object[] | null

Alternative to output. Only the first entry is used.

Maximum array length: 1
input_schema
Input Schema · object | null

Column types of input_rows.

input_rows
Input Rows · object[] | null

Rows to enrich, one object per row.

rules
Rules · object | null

Task rules the agent must follow.

count
integer | null

Target row count.

Required range: x >= 1
target_count
integer | null

Alternative to count.

Required range: x >= 1
version
enum<string> | null

Model tier. scout (default): faster. ranger: most capable. Fixed for the life of the task.

Available options:
ranger,
scout
Example:

"scout"

source_data
Source Data · object | null

Caller metadata stored on the task and returned with it.

prompt
string | null

Natural-language task for Autumn. One of prompt or message is required.

Example:

"Find 10 Series A AI security companies and return name, website, funding stage, and source URLs."

message
string | null

Alias of prompt.

Response

Server-sent events: task, tool, text, error, done. A failure after the stream opens is an error event.

The response is of type string.