Skip to main content
PUT
/
v0
/
issues
/
{id}
Update an issue
curl --request PUT \
  --url https://api.avidoai.com/v0/issues/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>' \
  --data '
{
  "title": "Response quality degradation - Critical",
  "summary": "The chatbot is consistently providing incomplete responses",
  "comment": "Duplicate report",
  "status": "RESOLVED",
  "priority": "LOW",
  "assignedTo": "user_345678",
  "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_xyz789",
  "parentId": "123e4567-e89b-12d3-a456-426614174000"
}
'
{
  "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

​
id
string<uuid>
required

The unique identifier of the issue

Example:

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

Body

application/json

Request body for updating an existing issue

​
title
string

Updated title of the issue

Example:

"Response quality degradation - Critical"

​
summary
string | null

Updated summary of the issue

Example:

"The chatbot is consistently providing incomplete responses"

​
comment
string | null

Reason for resolving or dismissing the issue

Example:

"Duplicate report"

​
status
enum<string>

Updated status of the issue

Available options:
OPEN,
RESOLVED,
REJECTED
Example:

"RESOLVED"

​
priority
enum<string>

Updated priority level

Available options:
LOW,
MEDIUM,
HIGH
Example:

"LOW"

​
assignedTo
string | null

Reassign the issue to a different user

Example:

"user_345678"

​
topicId
string<uuid> | null

Update associated topic ID

Example:

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

​
taskId
string<uuid> | null

Update associated task ID

Example:

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

​
testId
string<uuid> | null

Update associated test ID

Example:

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

​
evalDefinitionId
string<uuid> | null

Update associated evaluation definition ID

Example:

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

​
annotationId
string<uuid> | null

Update associated annotation ID

Example:

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

​
traceId
string | null

Update associated trace ID

Example:

"trace_xyz789"

​
parentId
string<uuid> | null

Update parent issue ID for sub-issues

Example:

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

Response

Successfully updated issue

Successful response containing the issue data

​
data
Issue · object
required

An issue tracking problems or improvements in the AI application