AUautumn-ai
Tasks

Start from a task spec and stream

Start from a task spec and stream the turn.

post/task/start/stream

Request

  • Base URL
    https://api.autumn.ai
  • URL
    https://api.autumn.ai/task/start/stream
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Request body

waitboolean

Accepted for compatibility; starting a task always returns immediately.

task_idstring nullable

Continue this task instead of creating one.

namestring nullable

Display name. Derived from the prompt when omitted. Applies only when the task is created; ignored on an existing task_id.

clarifyboolean

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

input_filesstring[] nullable

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

outputobject nullable

The output artifact to collect: id, kind, path, name; for research also schema, schema_order, target_count. Applies only when the task is created; ignored on an existing task_id.

input_schemaobject nullable

Column types of input_rows. Applies only when the task is created; ignored on an existing task_id.

input_rowsobject[] nullable

Rows to enrich, one object per row. Applies only when the task is created; ignored on an existing task_id.

rulesobject nullable

Each value is a rule in plain language; the key names it. Applies only when the task is created; ignored on an existing task_id.

countinteger nullable

Target row count. Applies only when the task is created; ignored on an existing task_id.

target_countinteger nullable

Alternative to count. Applies only when the task is created; ignored on an existing task_id.

versionstring nullable

Model tier. ranger (default): most capable. scout: faster. wren: cheapest, admin plans only. Fixed for the life of the task. Admin-plan keys may also pin a build with ranger@v-<sha12>, a variant name, or a version id.

source_dataobject nullable

Caller metadata stored on the task and returned with it.

taskobject nullable

A task.json spec: brief, output, rules, input_schema, input_rows. Top-level fields apply only when task is omitted. skills is ignored.

promptstring nullable

Appended to the brief, or used as the brief when task is omitted. One of task, prompt or message is required.

messagestring nullable

Alias of prompt.

Example request

{
  "task": {
    "brief": "Find 10 Series A AI security companies in the US.",
    "output": {
      "id": "ai-security-companies",
      "kind": "research",
      "path": "outputs/ai-security-companies.jsonl",
      "schema": {
        "company_name": "string",
        "funding_stage": "string",
        "source_urls": "array[string]",
        "website": "string"
      },
      "schema_order": [
        "company_name",
        "website",
        "funding_stage",
        "source_urls"
      ],
      "target_count": 10
    }
  }
}

Response

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

Changes

No recorded changes to this operation across all 1 revision of this API.