List tasks

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

{
  "data": [],
  "pagination": {
    "skip": 0,
    "limit": 25,
    "total": 0,
    "totalPages": 0
  }
}

GET

tasks

List tasks

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

{
  "data": [],
  "pagination": {
    "skip": 0,
    "limit": 25,
    "total": 0,
    "totalPages": 0
  }
}

Authorizations

x-api-key

string

header

required

Your unique Avido API key

x-application-id

string

header

required

Your unique Avido Application ID

Query Parameters

skip

integer

default:0

Number of items to skip before starting to collect the result set.

Required range: x >= 0

Example:

0

limit

integer

default:25

Number of items to include in the result set.

Required range: 1 <= x <= 100

Example:

25

orderBy

string

default:createdAt

Field to order by in the result set.

Example:

"createdAt"

orderDir

enum<string>

default:desc

Order direction.

Available options:

asc,

desc

Example:

"desc"

topicId

string<uuid>[]

Filter tasks by topic ID

Example:

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

status

enum<string>[]

Filter tasks by status

Available options:

success,

warning,

error,

no-tests

Example:

["success", "warning"]

evalDefinitionId

string<uuid>[]

Filter tasks by eval definition ID

Example:

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

tagId

string[]

Filter tasks by tag ID

Example:

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

Response

Successfully retrieved tasks

Paginated response containing tasks

data

Task · object[]

required

Show child attributes

data.id

string<uuid>

required

The unique identifier of the task

Example:

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

data.createdAt

string<date-time>

required

When the task was created

Example:

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

data.modifiedAt

string<date-time>

required

When the task was last modified

Example:

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

data.title

string

required

The title of the task

Example:

"Credit Card Block"

data.description

string

required

The task description

Example:

"Wants to block their credit card"

data.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"

data.passRate

number

required

The 30 day pass rate for the task measured in percentage

Example:

66

data.inputExamples

string[]

required

Example inputs for the task

Example:

["I want to block my credit card"]

data.evalDefinitions

object[]

required

Show child attributes

data.evalDefinitions.id

string<uuid>

required

data.evalDefinitions.createdAt

string<date-time>

required

When the eval definition was created

Example:

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

data.evalDefinitions.modifiedAt

string<date-time>

required

When the eval definition was last modified

Example:

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

data.evalDefinitions.type

enum<string>

required

The type of evaluation

Available options:

NATURALNESS,

STYLE,

RECALL,

CUSTOM,

FACT,

OUTPUT_MATCH

Example:

"NATURALNESS"

data.evalDefinitions.name

string

required

data.evalDefinitions.globalConfig

object

Option 1
Option 2
Option 3
Option 4

Show child attributes

data.evalDefinitions.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

data.evalDefinitions.styleGuideId

string<uuid> | null

data.evalDefinitions.application

Application · object

Application configuration and metadata

Show child attributes

data.evalDefinitions.application.id

string<uuid>

required

Unique identifier of the application

Example:

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

data.evalDefinitions.application.orgId

string

required

Organization ID that owns this application

Example:

"org_123456"

data.evalDefinitions.application.title

string

required

Title of the application

Minimum string length: 1

Example:

"Customer Support Bot"

data.evalDefinitions.application.slug

string

required

URL-friendly slug for the application

Minimum string length: 1

Example:

"customer-support-bot"

data.evalDefinitions.application.description

string

required

Description of the application

Example:

"AI assistant for customer support inquiries"

data.evalDefinitions.application.context

string

required

Context/instructions for the application

Example:

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

data.evalDefinitions.application.language

string

required

Language of the application

Example:

"en"

data.evalDefinitions.application.type

enum<string>

required

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

Available options:

CHATBOT,

AGENT

Example:

"CHATBOT"

data.evalDefinitions.application.environment

enum<string>

default:DEV

required

Environment of the application. Defaults to DEV.

Available options:

DEV,

PROD

Example:

"DEV"

data.evalDefinitions.application.createdAt

string<date-time>

required

When the application was created

Example:

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

data.evalDefinitions.application.modifiedAt

string<date-time>

required

When the application was last modified

Example:

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

data.metadata

object

required

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

Show child attributes

data.metadata.{key}

any

Example:

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

data.tags

object[]

required

Show child attributes

data.tags.id

string<uuid>

required

Unique identifier of the tag

Example:

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

data.tags.name

string

required

Name of the tag

Example:

"API Documentation"

data.tags.color

string

required

Hex color code for the tag

Example:

"#3B82F6"

data.lastTest

string<date-time>

The date and time this task was last tested

Example:

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

data.simulatedPromptSchema

object

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

Show child attributes

data.simulatedPromptSchema.{key}

any

Example:

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

data.taskSchedule

TaskSchedule · object

Task schedule schema

Show child attributes

data.taskSchedule.taskId

string<uuid>

required

data.taskSchedule.criticality

enum<string>

required

Available options:

LOW,

MEDIUM,

HIGH

data.taskSchedule.cron

string

required

data.taskSchedule.nextRunAt

string<date-time>

data.taskSchedule.lastRunAt

string<date-time>

data.topicId

string<uuid>

The ID of the topic this task belongs to

Example:

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

pagination

PaginationResponse · object

required

Pagination metadata returned in a paginated response.

Show child attributes

pagination.skip

integer

required

Number of items skipped.

Required range: x >= 0

Example:

0

pagination.limit

integer

required

Number of items per page.

Required range: x >= 1

Example:

25

pagination.total

integer

required

Total number of items available.

Required range: x >= 0

Example:

100

pagination.totalPages

integer

required

Total number of pages available.

Required range: x >= 0

Example:

4

Ingest events Create a new 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

List tasks

Authorizations

Query Parameters

Response