Outropy home page

Dashboard
Support
Dashboard

Endpoints

Execute Task

API Documentation

Introduction

Endpoints

POST
Create new Task
POST
Execute Task
GET
Get Task Run
GET
Get Run Inputs
POST
Upload Data
GET
Download Data
GET
Get Data Metadata

Endpoints

Execute Task

Execute a task with the given input. Tasks are executed asynchronously, this will return a URN for the task run which can be used to retrieve the results later.

POST

api

tasks

execute

object

task_urn

string

task_urn

Required

string

The URN of the task to run

subject_urns

array

subject_urns

Required

array

The URN of the subjects for the request, at least one is required

directives

object

directives

object

(Optional) The directives to apply to this request, overriding the task defaults

session_id

string

session_id

string

The current session ID if this belongs to a session

latency

integer

latency

integer

How the server should prioritize low latency, from 0 to 100. If not specified, the server will infer the best value.

accuracy

integer

accuracy

integer

How the server should prioritize high accuracy of the results, from 0 to 100. If not specified, the server will infer the best value.

cost

integer

cost

integer

How the server should prioritize minimizing costs, from 0 to 100. If not specified, the server will infer the best value.

reproducibility

integer

reproducibility

integer

How the server should prioritize returning the same result as previous queries of similar nature, from 0 to 100. If not specified, the server will infer the best value.

freshness

integer

freshness

integer

How the server should prioritize freshness, from 0 to 100. If not specified, the server will infer the best value.

personalization

integer

personalization

integer

How the server should prioritize personalization, from 0 to 100. If not specified, the server will infer the best value.

recall

integer

recall

integer

How the server should prioritize recall in future queries for the same session, from 0 to 100. If not specified, the server will infer the best value.

creativity

integer

creativity

integer

How the server should prioritize creativity in the results, from 0 to 100. If not specified, the server will infer the best value.

reference_data

array

reference_data

array

(Optional) Additional reference data sources to use for this request

Body

application/json

task_urn

string

required

The URN of the task to run

subject_urns

string[]

required

The URN of the subjects for the request, at least one is required

directives

object | null

(Optional) The directives to apply to this request, overriding the task defaults

directives.session_id

string | null

The current session ID if this belongs to a session

directives.latency

integer

default: -999999999

How the server should prioritize low latency, from 0 to 100. If not specified, the server will infer the best value.

directives.accuracy

integer

default: -999999999

How the server should prioritize high accuracy of the results, from 0 to 100. If not specified, the server will infer the best value.

directives.cost

integer

default: -999999999

How the server should prioritize minimizing costs, from 0 to 100. If not specified, the server will infer the best value.

directives.reproducibility

integer

default: -999999999

How the server should prioritize returning the same result as previous queries of similar nature, from 0 to 100. If not specified, the server will infer the best value.

directives.freshness

integer

default: -999999999

How the server should prioritize freshness, from 0 to 100. If not specified, the server will infer the best value.

directives.personalization

integer

default: -999999999

How the server should prioritize personalization, from 0 to 100. If not specified, the server will infer the best value.

directives.recall

integer

default: -999999999

How the server should prioritize recall in future queries for the same session, from 0 to 100. If not specified, the server will infer the best value.

directives.creativity

integer

default: -999999999

How the server should prioritize creativity in the results, from 0 to 100. If not specified, the server will infer the best value.

reference_data

string[] | null

(Optional) Additional reference data sources to use for this request

Response

200 - application/json

urn

string

required

The unique URN of the task run, can be used to retrieve its status and results later.

href

string

required

URL that can be used to visualize the task run

Create new Task Get Task Run

github linkedin