List issues

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

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orgId": "org_123456",
      "title": "Response quality degradation",
      "status": "OPEN",
      "source": "TEST",
      "priority": "HIGH",
      "applicationId": "456e7890-e89b-12d3-a456-426614174000",
      "createdAt": "2024-01-05T12:34:56.789Z",
      "modifiedAt": "2024-01-05T12:34:56.789Z",
      "issues": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "orgId": "org_123456",
          "title": "Response quality degradation",
          "status": "OPEN",
          "source": "TEST",
          "priority": "HIGH",
          "applicationId": "456e7890-e89b-12d3-a456-426614174000",
          "createdAt": "2024-01-05T12:34:56.789Z",
          "modifiedAt": "2024-01-05T12:34:56.789Z",
          "description": "The chatbot is providing incomplete responses to user queries",
          "summary": "The chatbot is providing incomplete responses to user queries",
          "impact": "The chatbot is providing incomplete responses to user queries",
          "comment": "Working as intended",
          "assignedTo": "user_789012",
          "topicId": "789e4567-e89b-12d3-a456-426614174000",
          "taskId": "789e4567-e89b-12d3-a456-426614174000",
          "testId": "789e4567-e89b-12d3-a456-426614174000",
          "evalDefinitionId": "789e4567-e89b-12d3-a456-426614174000",
          "annotationId": "890e5678-e89b-12d3-a456-426614174000",
          "traceId": "trace_abc123",
          "parentId": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "description": "The chatbot is providing incomplete responses to user queries",
      "summary": "The chatbot is providing incomplete responses to user queries",
      "impact": "The chatbot is providing incomplete responses to user queries",
      "comment": "Working as intended",
      "assignedTo": "user_789012",
      "topicId": "789e4567-e89b-12d3-a456-426614174000",
      "taskId": "789e4567-e89b-12d3-a456-426614174000",
      "testId": "789e4567-e89b-12d3-a456-426614174000",
      "evalDefinitionId": "789e4567-e89b-12d3-a456-426614174000",
      "annotationId": "890e5678-e89b-12d3-a456-426614174000",
      "traceId": "trace_abc123",
      "parentId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "skip": 0,
    "limit": 25,
    "total": 100,
    "totalPages": 4
  }
}

GET

issues

List issues

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

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orgId": "org_123456",
      "title": "Response quality degradation",
      "status": "OPEN",
      "source": "TEST",
      "priority": "HIGH",
      "applicationId": "456e7890-e89b-12d3-a456-426614174000",
      "createdAt": "2024-01-05T12:34:56.789Z",
      "modifiedAt": "2024-01-05T12:34:56.789Z",
      "issues": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "orgId": "org_123456",
          "title": "Response quality degradation",
          "status": "OPEN",
          "source": "TEST",
          "priority": "HIGH",
          "applicationId": "456e7890-e89b-12d3-a456-426614174000",
          "createdAt": "2024-01-05T12:34:56.789Z",
          "modifiedAt": "2024-01-05T12:34:56.789Z",
          "description": "The chatbot is providing incomplete responses to user queries",
          "summary": "The chatbot is providing incomplete responses to user queries",
          "impact": "The chatbot is providing incomplete responses to user queries",
          "comment": "Working as intended",
          "assignedTo": "user_789012",
          "topicId": "789e4567-e89b-12d3-a456-426614174000",
          "taskId": "789e4567-e89b-12d3-a456-426614174000",
          "testId": "789e4567-e89b-12d3-a456-426614174000",
          "evalDefinitionId": "789e4567-e89b-12d3-a456-426614174000",
          "annotationId": "890e5678-e89b-12d3-a456-426614174000",
          "traceId": "trace_abc123",
          "parentId": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "description": "The chatbot is providing incomplete responses to user queries",
      "summary": "The chatbot is providing incomplete responses to user queries",
      "impact": "The chatbot is providing incomplete responses to user queries",
      "comment": "Working as intended",
      "assignedTo": "user_789012",
      "topicId": "789e4567-e89b-12d3-a456-426614174000",
      "taskId": "789e4567-e89b-12d3-a456-426614174000",
      "testId": "789e4567-e89b-12d3-a456-426614174000",
      "evalDefinitionId": "789e4567-e89b-12d3-a456-426614174000",
      "annotationId": "890e5678-e89b-12d3-a456-426614174000",
      "traceId": "trace_abc123",
      "parentId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "skip": 0,
    "limit": 25,
    "total": 100,
    "totalPages": 4
  }
}

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"

applicationId

string<uuid>

Filter by application ID

Example:

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

status

enum<string>

Filter by issue status

Available options:

OPEN,

RESOLVED,

REJECTED

Example:

"OPEN"

priority

enum<string>

Filter by issue priority

Available options:

LOW,

MEDIUM,

HIGH

Example:

"HIGH"

source

enum<string>

Filter by issue source

Available options:

TEST,

TASK,

TOPIC,

SYSTEM,

MONITORING,

API

Example:

"TEST"

assignedTo

string

Filter by assignee user ID

Example:

"user_789012"

testId

string<uuid>

Filter by associated test ID

Example:

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

annotationId

string<uuid>

Filter by associated annotation ID

Example:

"890e5678-e89b-12d3-a456-426614174000"

start

string<date-time>

Start date (ISO8601) for filtering issues by creation date

Example:

"2025-01-01T00:00:00Z"

end

string<date-time>

End date (ISO8601) for filtering issues by creation date

Example:

"2025-01-31T23:59:59Z"

Response

Successfully retrieved issues

Paginated response containing grouped issues

data

Issue · object[]

required

Show child attributes

data.id

string<uuid>

required

Unique identifier of the issue

Example:

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

data.orgId

string

required

Organization ID that owns this issue

Example:

"org_123456"

data.title

string

required

Title of the issue

Example:

"Response quality degradation"

data.status

enum<string>

required

Current status of the issue

Available options:

OPEN,

RESOLVED,

REJECTED

Example:

"OPEN"

data.source

enum<string>

required

Where the issue originated from

Available options:

TEST,

TASK,

TOPIC,

SYSTEM,

MONITORING,

API

Example:

"TEST"

data.priority

enum<string>

required

Priority level of the issue

Available options:

LOW,

MEDIUM,

HIGH

Example:

"HIGH"

data.applicationId

string<uuid>

required

The application this issue belongs to

Example:

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

data.createdAt

string<date-time>

required

When the issue was created

Example:

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

data.modifiedAt

string<date-time>

required

When the issue was last modified

Example:

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

data.issues

Issue · object[]

required

list of sub issues

Show child attributes

data.issues.id

string<uuid>

required

Unique identifier of the issue

Example:

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

data.issues.orgId

string

required

Organization ID that owns this issue

Example:

"org_123456"

data.issues.title

string

required

Title of the issue

Example:

"Response quality degradation"

data.issues.status

enum<string>

required

Current status of the issue

Available options:

OPEN,

RESOLVED,

REJECTED

Example:

"OPEN"

data.issues.source

enum<string>

required

Where the issue originated from

Available options:

TEST,

TASK,

TOPIC,

SYSTEM,

MONITORING,

API

Example:

"TEST"

data.issues.priority

enum<string>

required

Priority level of the issue

Available options:

LOW,

MEDIUM,

HIGH

Example:

"HIGH"

data.issues.applicationId

string<uuid>

required

The application this issue belongs to

Example:

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

data.issues.createdAt

string<date-time>

required

When the issue was created

Example:

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

data.issues.modifiedAt

string<date-time>

required

When the issue was last modified

Example:

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

data.issues.description

string

Detailed description of the issue

Example:

"The chatbot is providing incomplete responses to user queries"

data.issues.summary

string

Detailed summary of the issue

Example:

"The chatbot is providing incomplete responses to user queries"

data.issues.impact

string

Detailed impact of the issue

Example:

"The chatbot is providing incomplete responses to user queries"

data.issues.comment

string

Optional comment explaining resolution or dismissal

Example:

"Working as intended"

data.issues.assignedTo

string

User ID of the person assigned to this issue

Example:

"user_789012"

data.issues.topicId

string<uuid>

Associated topic ID if issue came from a topic

Example:

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

data.issues.taskId

string<uuid>

Associated task ID if issue came from a task

Example:

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

data.issues.testId

string<uuid>

Associated test ID if issue came from a test

Example:

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

data.issues.evalDefinitionId

string<uuid>

Associated evaluation definition ID if issue came from an evaluation

Example:

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

data.issues.annotationId

string<uuid>

Associated annotation ID if related to an annotation

Example:

"890e5678-e89b-12d3-a456-426614174000"

data.issues.traceId

string

Associated trace ID for monitoring/debugging

Example:

"trace_abc123"

data.issues.parentId

string<uuid>

Parent issue ID for sub-issues

Example:

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

data.description

string

Detailed description of the issue

Example:

"The chatbot is providing incomplete responses to user queries"

data.summary

string

Detailed summary of the issue

Example:

"The chatbot is providing incomplete responses to user queries"

data.impact

string

Detailed impact of the issue

Example:

"The chatbot is providing incomplete responses to user queries"

data.comment

string

Optional comment explaining resolution or dismissal

Example:

"Working as intended"

data.assignedTo

string

User ID of the person assigned to this issue

Example:

"user_789012"

data.topicId

string<uuid>

Associated topic ID if issue came from a topic

Example:

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

data.taskId

string<uuid>

Associated task ID if issue came from a task

Example:

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

data.testId

string<uuid>

Associated test ID if issue came from a test

Example:

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

data.evalDefinitionId

string<uuid>

Associated evaluation definition ID if issue came from an evaluation

Example:

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

data.annotationId

string<uuid>

Associated annotation ID if related to an annotation

Example:

"890e5678-e89b-12d3-a456-426614174000"

data.traceId

string

Associated trace ID for monitoring/debugging

Example:

"trace_abc123"

data.parentId

string<uuid>

Parent issue ID for sub-issues

Example:

"123e4567-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

Delete an annotation Create a new issue

⌘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 issues

Authorizations

Query Parameters

Response