Get a single issue by ID

curl --request GET \
  --url https://api.avidoai.com/v0/issues/{id} \
  --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",
    "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"
  }
}

GET

issues

{id}

Get a single issue by ID

curl --request GET \
  --url https://api.avidoai.com/v0/issues/{id} \
  --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",
    "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"
  }
}

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 issue

Example:

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

Response

Successfully retrieved issue

Successful response containing the issue data

data

Issue · object

required

An issue tracking problems or improvements in the AI application

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

Create a new issue Update an 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

Get a single issue by ID

Authorizations

Path Parameters

Response