Create a draft task - Autumn AI

Create a draft task

curl --request POST \
  --url https://api.autumn.ai/tasks/draft \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "output": {},
  "source_data": {}
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', output: {}, source_data: {}})
};

fetch('https://api.autumn.ai/tasks/draft', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.autumn.ai/tasks/draft"

payload = {
    "name": "<string>",
    "output": {},
    "source_data": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "task_id": "8fab6f34",
  "name": "Series A AI security companies",
  "status": "execute",
  "phase": "execute",
  "activity": "executing",
  "output_count": 10,
  "credits_used": 123,
  "created_at": "<string>",
  "updated_at": "<string>",
  "poll_after_s": 5,
  "status_url": "/task/8fab6f34/state",
  "task_url": "/task/8fab6f34",
  "output_url": "/task/8fab6f34/output",
  "stream_url": "/task/8fab6f34/stream"
}

POST

/

tasks

/

draft

Create a draft task

curl --request POST \
  --url https://api.autumn.ai/tasks/draft \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "output": {},
  "source_data": {}
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', output: {}, source_data: {}})
};

fetch('https://api.autumn.ai/tasks/draft', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.autumn.ai/tasks/draft"

payload = {
    "name": "<string>",
    "output": {},
    "source_data": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "task_id": "8fab6f34",
  "name": "Series A AI security companies",
  "status": "execute",
  "phase": "execute",
  "activity": "executing",
  "output_count": 10,
  "credits_used": 123,
  "created_at": "<string>",
  "updated_at": "<string>",
  "poll_after_s": 5,
  "status_url": "/task/8fab6f34/state",
  "task_url": "/task/8fab6f34",
  "output_url": "/task/8fab6f34/output",
  "stream_url": "/task/8fab6f34/stream"
}

Authorizations

Authorization

string

header

required

A signed-in platform session; only the upload routes accept it.

Body

application/json

name

string | null

output

Output · object | null

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

source_data

Source Data · object | null

Response

The empty task. Store task_id.

task_id

string

required

Example:

"8fab6f34"

name

string | null

Example:

"Series A AI security companies"

status

string | null

plan (idle, or finished), execute (working), accepted (queued), deleted.

Example:

"execute"

phase

enum<string> | null

Available options:

plan,

execute

Example:

"execute"

activity

string | null

idle, planning, executing or thinking. Finished is idle.

Example:

"executing"

output_count

integer | null

Example:

10

credits_used

integer | null

created_at

string | null

updated_at

string | null

poll_after_s

integer | null

Seconds to wait before polling status again.

Example:

5

status_url

string | null

Example:

"/task/8fab6f34/state"

task_url

string | null

Example:

"/task/8fab6f34"

output_url

string | null

Example:

"/task/8fab6f34/output"

stream_url

string | null

Example:

"/task/8fab6f34/stream"