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: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });

console.log(run.id);
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "task_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "arguments": {},
  "success": true,
  "result_json": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z",
  "secret_bindings": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.indices.io/llms.txt

Use this file to discover all available pages before exploring further.

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<uuid>
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 UUIDs. Each slot defined in the task's required_secrets must be mapped to a user-owned secret.

Response

Successful response

​
id
string<uuid>
required

Unique identifier for the object.

​
task_id
string<uuid>
required

ID of the task executed in this run.

​
arguments
object
required

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

​
success
boolean
required

Whether the run was successful.

​
result_json
string | null
required

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

​
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 UUIDs.