Skip to main content
POST
JavaScript

Authorizations

x-api-key
string
header
required

Your unique Avido API key

x-application-id
string
header
required

Your unique Avido Application ID

Body

application/json

Request body for creating a new task

title
string
required

The title of the task

Minimum string length: 1
Example:

"Credit Card Block"

description
string
required

A short description of the task

Minimum string length: 1
Example:

"The user wants to block their credit card"

type
enum<string>
default:NORMAL

The type of task

Available options:
STATIC,
NORMAL
Example:

"NORMAL"

topicId
string<uuid>

ID of the topic this task belongs to

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"789e4567-e89b-12d3-a456-426614174000"

quickstartId
string<uuid>

ID of the quickstart this task was generated from

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"789e4567-e89b-12d3-a456-426614174000"

metadata
object

Optional metadata to associate with the task when creating it (e.g., external identifiers).

Example:
simulatedPromptSchema
object

JSON schema that defines the structure for user prompts that should be generated for tests

Example:
inputExamples
string[]

Static user prompts for the task. Required when type is STATIC.

Required array length: 1 - 10000 elements
Required string length: 1 - 10000
Example:

Response

Successfully created task

Successful response containing the task data

task
Task · object
required

A task that represents a specific job-to-be-done by the LLM in the user application.