Skip to main content
GET
/
v1beta
/
tasks
JavaScript
import Indices from 'indicesio';

const client = new Indices({
  apiKey: process.env['INDICES_API_KEY'], // This is the default and can be omitted
});

const tasks = await client.tasks.list();

console.log(tasks);
import os
from indices import Indices

client = Indices(
api_key=os.environ.get("INDICES_API_KEY"), # This is the default and can be omitted
)
tasks = client.tasks.list()
print(tasks)
curl --request GET \
--url https://api.indices.io/v1beta/tasks \
--header 'Authorization: Bearer <token>'
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.indices.io/v1beta/tasks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.indices.io/v1beta/tasks"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.indices.io/v1beta/tasks")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.indices.io/v1beta/tasks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
[
  {
    "id": "task_0R3kPq8mWxYz1aBcDeFgHi",
    "current_state": "ready",
    "display_name": "Recent store orders",
    "task": "Fetch the most recent orders from the signed-in user's account.",
    "website": "https://shop.example.com",
    "input_schema": {
      "properties": {
        "limit": {
          "type": "integer"
        }
      },
      "required": [],
      "type": "object"
    },
    "output_schema": {
      "properties": {
        "orders": {
          "items": {
            "properties": {
              "id": {
                "type": "string"
              },
              "total": {
                "type": "number"
              }
            },
            "type": "object"
          },
          "type": "array"
        }
      },
      "required": [
        "orders"
      ],
      "type": "object"
    },
    "creation": {
      "secrets": [
        {
          "secret_id": "sec_8kPq2mWxYz1aBcDeFgHi3J",
          "description": "Login credentials for the store account."
        }
      ],
      "secret_bindings": {
        "LOGIN": "sec_8kPq2mWxYz1aBcDeFgHi3J"
      }
    },
    "created_at": "2026-01-01T12:00:00Z",
    "updated_at": "2026-01-06T12:05:00Z",
    "required_secrets": [
      {
        "name": "LOGIN",
        "type": "login",
        "requires_totp": false
      }
    ],
    "failure_info": {
      "category": "authentication",
      "message": "The website requires a login we could not complete automatically."
    }
  }
]

Authorizations

Authorization
string
header
required

Enter your API key as the bearer token. Set header: Authorization to Bearer <api_key>

Response

200 - application/json

Successful response

id
string
required

Unique identifier for the object.

Example:

"task_0R3kPq8mWxYz1aBcDeFgHi"

current_state
enum<string>
required

Current state of the task, in particular whether it is ready to use.

Available options:
not_ready,
waiting_for_manual_completion,
ready,
failed
Example:

"ready"

display_name
string
required

Short title shown in the dashboard. Informational only.

Example:

"Recent store orders"

task
string
required

Detailed explanation of the task to be performed.

Example:

"Fetch the most recent orders from the signed-in user's account."

website
string<uri> | null
required

The primary URL the task targets. May be null while the task is not ready; non-null once generation completes.

Required string length: 1 - 2083
Example:

"https://shop.example.com"

input_schema
object | null
required

Task input schema as a JSON Schema object. May be null while the task is not ready (e.g. schema generation in progress). Guaranteed non-null when current_state is ready.

Example:
{
"properties": { "limit": { "type": "integer" } },
"required": [],
"type": "object"
}
output_schema
object | null
required

Task output schema as a JSON Schema object. May be null while the task is not ready (e.g. schema generation in progress). Guaranteed non-null when current_state is ready.

Example:
{
"properties": {
"orders": {
"items": {
"properties": {
"id": { "type": "string" },
"total": { "type": "number" }
},
"type": "object"
},
"type": "array"
}
},
"required": ["orders"],
"type": "object"
}
creation
TaskCreation · object
required

Parameters set during the creation of this task.

created_at
string<date-time>
required

Timestamp when the object was created.

Example:

"2026-01-01T12:00:00Z"

updated_at
string<date-time>
required

Timestamp when the object was last updated.

Example:

"2026-01-06T12:05:00Z"

required_secrets
SecretSlotDefinition · object[]

List of secrets that must be provided when running this task.

failure_info
TaskFailureInfo · object | null

Failure information if the task failed, including user-friendly explanation and suggestions