Skip to main content
POST
Start from prompt

Authorizations

Authorization
string
header
default:YOUR_AUTUMN_API_KEY
required

Use Authorization: Bearer YOUR_AUTUMN_API_KEY.

Body

application/json
prompt
string
required

Natural-language task for Autumn.

Example:

"Find 10 Series A AI security companies"

output
object | null

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

clarify
boolean | null

If true, the agent may ask one blocking planning question before execution. Defaults to false for public API starts.

input_files
string[] | null

Optional task-local input filenames or storage paths already available to Autumn.

source_data
object | null

Optional caller metadata.

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

Task accepted. Store task_id.

task_id
string
Example:

"8fab6f34"

name
string | null
Example:

"Series A AI security companies"

type
string | null
Example:

"research"

status
enum<string>

A completed or stopped run reports plan; execute means the task is currently working.

Available options:
plan,
execute,
deleted
Example:

"execute"

phase
enum<string> | null
Available options:
plan,
execute
Example:

"execute"

activity
string | null

Fine-grained state: idle, planning, executing, thinking. A finished task is idle.

Example:

"executing"

output_count
integer | null
Example:

10

poll_after_s
integer

Suggested seconds to wait before polling status again.

Example:

5

status_url
string
Example:

"/task/8fab6f34"

output_url
string
Example:

"/task/8fab6f34/output"

stream_url
string
Example:

"/task/8fab6f34/stream"