Execute a task - Autumn AI

Execute a task

curl --request POST \
  --url https://api.autumn.ai/task/{task_id}/execute \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "message": "<string>",
  "input_files": [
    "<string>"
  ],
  "wait": false
}
'

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({message: '<string>', input_files: ['<string>'], wait: false})
};

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

import requests

url = "https://api.autumn.ai/task/{task_id}/execute"

payload = {
    "message": "<string>",
    "input_files": ["<string>"],
    "wait": False
}
headers = {
    "X-API-Key": "<api-key>",
    "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

/

task

/

{task_id}

/

execute

Execute a task

curl --request POST \
  --url https://api.autumn.ai/task/{task_id}/execute \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "message": "<string>",
  "input_files": [
    "<string>"
  ],
  "wait": false
}
'

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({message: '<string>', input_files: ['<string>'], wait: false})
};

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

import requests

url = "https://api.autumn.ai/task/{task_id}/execute"

payload = {
    "message": "<string>",
    "input_files": ["<string>"],
    "wait": False
}
headers = {
    "X-API-Key": "<api-key>",
    "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

X-API-Key

string

header

default:YOUR_AUTUMN_API_KEY

required

Your Autumn API key.

Path Parameters

task_id

string

required

The task_id returned by POST /task or POST /task/start.

Example:

"8fab6f34"

Body

application/json

message

string | null

Instruction to include with the execution.

input_files

string[] | null

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

wait

boolean

default:false

Wait for the turn to finish (200). Default false: queue and return (202).

Response

Turn finished (wait: true).

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"