List tasks

curl --request GET \
  --url https://api.autumn.ai/task \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

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

[
  {
    "task_id": "<string>",
    "state": "<string>",
    "done": true,
    "rows": 123,
    "name": "<string>",
    "outcome": "<string>",
    "pinned": false,
    "mode": "<string>",
    "source": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "poll_after_s": 123,
    "status_url": "<string>",
    "task_url": "<string>",
    "output_url": "<string>",
    "stream_url": "<string>"
  }
]

GET

task

List tasks

curl --request GET \
  --url https://api.autumn.ai/task \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

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

[
  {
    "task_id": "<string>",
    "state": "<string>",
    "done": true,
    "rows": 123,
    "name": "<string>",
    "outcome": "<string>",
    "pinned": false,
    "mode": "<string>",
    "source": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "poll_after_s": 123,
    "status_url": "<string>",
    "task_url": "<string>",
    "output_url": "<string>",
    "stream_url": "<string>"
  }
]

Authorizations

X-API-Key

string

header

default:YOUR_AUTUMN_API_KEY

required

Your Autumn API key.

Query Parameters

limit

integer

default:50

Tasks per page.

Required range: 1 <= x <= 200

cursor

string

default:""

Value of X-Next-Cursor from the previous page.

string

default:""

Search names, IDs and status across your 500 most recent tasks, ranked like the app's search. Returns the best limit matches; no paging.

Maximum string length: 200

Response

Public task summaries with state, outcome and row count.

task_id

string

required

state

string

required

done

boolean

required

rows

integer

required

name

string | null

outcome

string | null

pinned

boolean

default:false

mode

string | null

source

string | null

created_at

string | null

updated_at

string | null

poll_after_s

integer | null

status_url

string | null

task_url

string | null

output_url

string | null

stream_url

string | null

Reference

Endpoints

List tasks

Authorizations

Query Parameters

Response