Get a single task by ID

curl --request GET \
  --url https://api.avidoai.com/v0/tasks/{id} \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>'

{
  "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": "NORMAL",
    "passRate": 66,
    "inputExamples": [
      "I want to block my credit card"
    ],
    "evalDefinitions": [
      {
        "evalDefinition": {
          "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": {
            "criterion": "<string>"
          },
          "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"
          }
        },
        "config": {
          "expected": "<string>"
        }
      }
    ],
    "metadata": {
      "customerId": "1",
      "priority": "high"
    },
    "lastTest": "2024-01-01T00:00:00.000Z",
    "simulatedPromptSchema": {
      "type": "object",
      "properties": {
        "intent": {
          "type": "string"
        },
        "urgency": {
          "type": "string",
          "enum": [
            "low",
            "medium",
            "high"
          ]
        }
      },
      "required": [
        "intent"
      ]
    },
    "taskSchedule": {
      "taskId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "criticality": "LOW",
      "cron": "<string>",
      "nextRunAt": "2023-11-07T05:31:56Z",
      "lastRunAt": "2023-11-07T05:31:56Z"
    },
    "topicId": "789e4567-e89b-12d3-a456-426614174000"
  }
}

GET

tasks

{id}

Get a single task by ID

curl --request GET \
  --url https://api.avidoai.com/v0/tasks/{id} \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>'

{
  "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": "NORMAL",
    "passRate": 66,
    "inputExamples": [
      "I want to block my credit card"
    ],
    "evalDefinitions": [
      {
        "evalDefinition": {
          "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": {
            "criterion": "<string>"
          },
          "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"
          }
        },
        "config": {
          "expected": "<string>"
        }
      }
    ],
    "metadata": {
      "customerId": "1",
      "priority": "high"
    },
    "lastTest": "2024-01-01T00:00:00.000Z",
    "simulatedPromptSchema": {
      "type": "object",
      "properties": {
        "intent": {
          "type": "string"
        },
        "urgency": {
          "type": "string",
          "enum": [
            "low",
            "medium",
            "high"
          ]
        }
      },
      "required": [
        "intent"
      ]
    },
    "taskSchedule": {
      "taskId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "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

x-application-id

string

header

required

Your unique Avido Application ID

Path Parameters

string<uuid>

required

The unique identifier of the task

Example:

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

Response

Successfully retrieved 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.

Show child attributes

task.id

string<uuid>

required

The unique identifier of the task

Example:

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

task.createdAt

string<date-time>

required

When the task was created

Example:

"2024-01-05T12:34:56.789Z"

task.modifiedAt

string<date-time>

required

When the task was last modified

Example:

"2024-01-05T12:34:56.789Z"

task.title

string

required

The title of the task

Example:

"Credit Card Block"

task.description

string

required

The task description

Example:

"Wants to block their credit card"

task.type

enum<string>

default:NORMAL

required

The type of task. Normal tasks have a dynamic user prompt, while adversarial tasks have a fixed user prompt.

Available options:

STATIC,

NORMAL

Example:

"NORMAL"

task.passRate

number

required

The 30 day pass rate for the task measured in percentage

Example:

66

task.inputExamples

string[]

required

Example inputs for the task

Example:

["I want to block my credit card"]

task.evalDefinitions

object[]

required

Show child attributes

task.evalDefinitions.evalDefinition

object

required

Show child attributes

task.evalDefinitions.evalDefinition.id

string<uuid>

required

task.evalDefinitions.evalDefinition.createdAt

string<date-time>

required

When the eval definition was created

Example:

"2024-01-05T12:34:56.789Z"

task.evalDefinitions.evalDefinition.modifiedAt

string<date-time>

required

When the eval definition was last modified

Example:

"2024-01-05T12:34:56.789Z"

task.evalDefinitions.evalDefinition.type

enum<string>

required

The type of evaluation

Available options:

NATURALNESS,

STYLE,

RECALL,

CUSTOM,

FACT,

OUTPUT_MATCH

Example:

"NATURALNESS"

task.evalDefinitions.evalDefinition.name

string

required

task.evalDefinitions.evalDefinition.globalConfig

object

Option 1
Option 2
Option 3
Option 4

Show child attributes

task.evalDefinitions.evalDefinition.globalConfig.criterion

string

required

The criterion describes what our evaluation LLM must look for in the response. Remember that the answer to the criterion must be as a pass/fail.

Minimum string length: 1

task.evalDefinitions.evalDefinition.styleGuideId

string<uuid> | null

task.evalDefinitions.evalDefinition.application

Application · object

Application configuration and metadata

Show child attributes

task.evalDefinitions.evalDefinition.application.id

string<uuid>

required

Unique identifier of the application

Example:

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

task.evalDefinitions.evalDefinition.application.orgId

string

required

Organization ID that owns this application

Example:

"org_123456"

task.evalDefinitions.evalDefinition.application.title

string

required

Title of the application

Minimum string length: 1

Example:

"Customer Support Bot"

task.evalDefinitions.evalDefinition.application.slug

string

required

URL-friendly slug for the application

Minimum string length: 1

Example:

"customer-support-bot"

task.evalDefinitions.evalDefinition.application.description

string

required

Description of the application

Example:

"AI assistant for customer support inquiries"

task.evalDefinitions.evalDefinition.application.context

string

required

Context/instructions for the application

Example:

"You are a helpful customer support assistant..."

task.evalDefinitions.evalDefinition.application.language

string

required

Language of the application

Example:

"en"

task.evalDefinitions.evalDefinition.application.type

enum<string>

required

Type of the application. Valid values are CHATBOT or AGENT.

Available options:

CHATBOT,

AGENT

Example:

"CHATBOT"

task.evalDefinitions.evalDefinition.application.environment

enum<string>

default:DEV

required

Environment of the application. Defaults to DEV.

Available options:

DEV,

PROD

Example:

"DEV"

task.evalDefinitions.evalDefinition.application.createdAt

string<date-time>

required

When the application was created

Example:

"2024-01-05T12:34:56.789Z"

task.evalDefinitions.evalDefinition.application.modifiedAt

string<date-time>

required

When the application was last modified

Example:

"2024-01-05T12:34:56.789Z"

task.evalDefinitions.config

object

Show child attributes

task.evalDefinitions.config.expected

required

task.metadata

object

required

Optional metadata associated with the task. Returns null when no metadata is stored.

Show child attributes

task.metadata.{key}

any

Example:

{ "customerId": "1", "priority": "high" }

task.lastTest

string<date-time>

The date and time this task was last tested

Example:

"2024-01-01T00:00:00.000Z"

task.simulatedPromptSchema

object

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

Show child attributes

task.simulatedPromptSchema.{key}

any

Example:

{
  "type": "object",
  "properties": {
    "intent": { "type": "string" },
    "urgency": {
      "type": "string",
      "enum": ["low", "medium", "high"]
    }
  },
  "required": ["intent"]
}

task.taskSchedule

TaskSchedule · object

Task schedule schema

Show child attributes

task.taskSchedule.taskId

string<uuid>

required

task.taskSchedule.criticality

enum<string>

required

Available options:

LOW,

MEDIUM,

HIGH

task.taskSchedule.cron

string

required

task.taskSchedule.nextRunAt

string<date-time>

task.taskSchedule.lastRunAt

string<date-time>

task.topicId

string<uuid>

The ID of the topic this task belongs to

Example:

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

Get task IDs Update an existing task

⌘I

Webhook

Applications

Threads

Ingestion

Tasks

Task Schedules

Eval Definitions

Experiments

Inference Steps

Evals

Tests

Topics

Annotations

Issues

Runs

Style Guides

Documents

Document Chunks

Document Versions

Tags

Document Tags

Task Tags

Scrape Jobs

Quickstarts

Get a single task by ID

Authorizations

Path Parameters

Response