Skip to main content
POST
/
v0
/
tasks
Create a new task
curl --request POST \
  --url https://api.avidoai.com/v0/tasks \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "title": "Credit Card Block",
  "description": "The user wants to block their credit card",
  "type": "ADVERSARY",
  "applicationId": "456e4567-e89b-12d3-a456-426614174000",
  "topicId": "789e4567-e89b-12d3-a456-426614174000"
}'
{
  "task": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2024-01-05T12:34:56.789Z",
    "modifiedAt": "2024-01-05T12:34:56.789Z",
    "title": "Credit Card Block",
    "description": "Wants to block their credit card",
    "type": "ADVERSARY",
    "passRate": 66,
    "lastTest": "2024-01-01T00:00:00.000Z",
    "inputExamples": [
      "I want to block my credit card"
    ],
    "definitions": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2024-01-05T12:34:56.789Z",
        "modifiedAt": "2024-01-05T12:34:56.789Z",
        "type": "NATURALNESS",
        "name": "<string>",
        "globalConfig": "<any>",
        "styleGuideId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "application": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "orgId": "org_123456",
          "title": "Customer Support Bot",
          "slug": "customer-support-bot",
          "description": "AI assistant for customer support inquiries",
          "context": "You are a helpful customer support assistant...",
          "language": "en",
          "type": "CHATBOT",
          "environment": "DEV",
          "createdAt": "2024-01-05T12:34:56.789Z",
          "modifiedAt": "2024-01-05T12:34:56.789Z"
        }
      }
    ],
    "taskSchedule": {
      "criticality": "LOW",
      "cron": "<string>",
      "nextRunAt": "2023-11-07T05:31:56Z",
      "lastRunAt": "2023-11-07T05:31:56Z"
    },
    "topicId": "789e4567-e89b-12d3-a456-426614174000"
  }
}

Authorizations

​
x-api-key
string
header
required

Your unique Avido API key

Body

application/json

Request body for creating a new task

​
title
string
required

The title of the task

Minimum length: 1
Example:

"Credit Card Block"

​
description
string
required

A short description of the task

Minimum length: 1
Example:

"The user wants to block their credit card"

​
type
enum<string>
default:NORMAL
required

The type of task

Available options:
ADVERSARY,
NORMAL
Example:

"ADVERSARY"

​
applicationId
string<uuid>
required

ID of the application this task belongs to

Example:

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

​
topicId
string<uuid> | null

ID of the topic this task belongs to

Example:

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

Response

Successfully created task

Successful response containing the task data

​
task
object
required

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

⌘I