Skip to main content
POST
/
v1beta
/
runs
JavaScript
import Indices from 'indicesio';

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

const run = await client.runs.run({ task_id: 'task_id' });

console.log(run.id);
import os
from indices import Indices

client = Indices(
api_key=os.environ.get("INDICES_API_KEY"), # This is the default and can be omitted
)
run = client.runs.run(
task_id="task_id",
)
print(run.id)
curl --request POST \
--url https://api.indices.io/v1beta/runs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"task_id": "<string>",
"arguments": {},
"secret_bindings": {},
"async": false,
"max_timeout_s": 300
}
'
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.indices.io/v1beta/runs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'task_id' => '<string>',
'arguments' => [

],
'secret_bindings' => [

],
'async' => false,
'max_timeout_s' => 300
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

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

curl_close($curl);

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

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

func main() {

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

payload := strings.NewReader("{\n \"task_id\": \"<string>\",\n \"arguments\": {},\n \"secret_bindings\": {},\n \"async\": false,\n \"max_timeout_s\": 300\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.indices.io/v1beta/runs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"task_id\": \"<string>\",\n \"arguments\": {},\n \"secret_bindings\": {},\n \"async\": false,\n \"max_timeout_s\": 300\n}")
.asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"task_id\": \"<string>\",\n \"arguments\": {},\n \"secret_bindings\": {},\n \"async\": false,\n \"max_timeout_s\": 300\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "task_id": "<string>",
  "arguments": {},
  "result_json": "<string>",
  "has_logs": true,
  "created_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z",
  "secret_bindings": {}
}
{
"id": "<string>",
"task_id": "<string>",
"arguments": {},
"result_json": "<string>",
"has_logs": true,
"created_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"secret_bindings": {}
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Authorizations

Authorization
string
header
required

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

Body

application/json
task_id
string
required

ID of the task to execute.

arguments
object

Arguments to pass to the task. Optional if the task does not require any arguments.

secret_bindings
object

Mapping of secret slot names to secret IDs. Each slot defined in the task's required_secrets must be mapped to a user-owned secret.

async
boolean
default:false

When true, return immediately with a pending run; poll retrieveRun for the result.

max_timeout_s
integer
default:300

Maximum execution time in seconds before the run is timed out.

Required range: 1 <= x <= 3600

Response

Successful response

id
string
required

Unique identifier for the object.

task_id
string
required

ID of the task executed in this run.

arguments
object
required

Arguments in this run for the task's input parameters.

status
enum<string>
required

Lifecycle status of the run: pending, running, success, failed, timed_out, result_too_large, or internal_error.

Available options:
pending,
running,
success,
failed,
timed_out,
result_too_large,
internal_error
result_json
string | null
required

Execution result of the run. In JSON, matching the task's output schema.

has_logs
boolean
required

Whether the run has associated logs

created_at
string<date-time>
required

Timestamp when the object was created.

finished_at
string<date-time> | null
required

Timestamp when the object was last updated.

secret_bindings
object

Secrets to use for this run. This dict must be a mapping of secret slot names to secret IDs.