POST
/
api
/
tasks
/
create
{
  "urn": "<string>",
  "href": "<string>"
}

Body

application/json
task_type
enum<string>
required

The task you want to perform

Available options:
transform_with_ref_data,
extract,
transform,
recommend,
ingest_reference_data,
ingest_document,
text_to_text,
index_document
name
string
required

The unique name of the task

Example:

"recommend-meal-with-preferences"

input_type
object | null

A json schema describing the input type for requests to the task

output_type
object | null

The output type for requests to the task

examples
array

Examples of expected input and output for the task

reference_data
string[]

The data sources that should be used as reference data for the task

prompt
string | null

The prompt for the task

directives
object | null

The default directives to be applied when running the task

collection_name
string | null

The name of the collection to use if this task end up creating one

Response

200
application/json
Successful Response
urn
string
required
href
string
required