Create a Task

GA
POST

Tasks are the core of the platform and define the prompts and models used to generate responses.

Path parameters

org_idstringRequired

The unique identifier of the organization.

project_idstringRequired

The unique identifier of the project.

Request

This endpoint expects an object.
system_promptstringRequired

The system prompt that is used to set the LLM context.

user_promptstringRequired

The description of the Task. It is not required to mention the outputs in the prompt, but it can help the model to understand the context better. Any input strings should be referenced with the dynamic {...} syntax, this informs the model to look for those values in the input data.

llm_modelenumRequired

The LLM model to use for the Task.

output_formatmap from strings to objects or "str" or "string" or "boolean" or "bool" or "int" or "integer" or "list"Required

This gives control over the structure of how the Task responds. Supports shorthand notation or an object with type can be specified for each attribute. In most instances, the LLM will be able to generate the desired output into the relevant property, but an optional description can be passed to provide it with additional context.

namestringRequired

A name or reference for the Task.

enabledbooleanRequired

When true the Task is active and callable. false denotes the Task is not yet operational.

llm_configobjectOptional

Specific configuration parameters for the LLM model.

task_forwarder_idstringOptional

The unique identifier for a valid Task Forwarder. It is used to forward the Task output to another system or service.

image_requiredbooleanOptional

When true it requires an image to be sent in the Task Run request.

descriptionstringOptional

A longer description of the Task for internal reference.

ragobjectOptionalBeta

Note: This is a Paid Tier feature. Provide additional domain specific input to the LLM so that it is able to reference user specific information when executing the Task. Examples of this could be a product catalogue, terms and conditions or a user manual.

Response

This endpoint returns an object.
namestring

A name or reference for the Task.

enabledboolean

When true the Task is active and callable. false denotes the Task is not yet operational.

idstring

The unique identifier of the Task.

project_idstring

The Project that the Task belongs to.

createddatetime

When the Task was created.

modifieddatetime

When the Task was last updated.

revisionslist of objects

Each update to a Task results in a new Revision being created. Task Revisions are a powerful concept that can be used to assist with A/B testing, comparing responses from different LLM’s, etc.

descriptionstringOptional

A longer description of the Task for internal reference.

access_tokenstringOptional

Task specific Bearer token that can be used to authenticated when executing this Task.

Built with