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 '
{
  "status": "RESOLVED"
}
'

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "title": "Response quality degradation",
    "createdAt": "2024-01-05T12:34:56.789Z",
    "orgId": "org_123456",
    "status": "OPEN",
    "source": "TEST",
    "priority": "HIGH",
    "type": "BUG",
    "applicationId": "456e7890-e89b-12d3-a456-426614174000",
    "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",
    "assignedUser": {
      "id": "user_789012",
      "name": "John Doe",
      "email": "john@example.com",
      "image": "https://example.com/avatar.jpg"
    },
    "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",
    "experimentId": "789e4567-e89b-12d3-a456-426614174000",
    "parentId": "123e4567-e89b-12d3-a456-426614174000",
    "hasSuggestedTask": true
  }
}

{
  "message": "Resource not found"
}

{
  "message": "Resource not found"
}

{
  "message": "Resource not found"
}

{
  "message": "Issue not found"
}

{
  "message": "Invalid request data",
  "issues": [
    {
      "code": "invalid_string",
      "message": "Invalid UUID",
      "path": [
        "id"
      ]
    }
  ]
}

{
  "message": "Resource not found"
}

PUT

issues

{id}

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 '
{
  "status": "RESOLVED"
}
'

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "title": "Response quality degradation",
    "createdAt": "2024-01-05T12:34:56.789Z",
    "orgId": "org_123456",
    "status": "OPEN",
    "source": "TEST",
    "priority": "HIGH",
    "type": "BUG",
    "applicationId": "456e7890-e89b-12d3-a456-426614174000",
    "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",
    "assignedUser": {
      "id": "user_789012",
      "name": "John Doe",
      "email": "john@example.com",
      "image": "https://example.com/avatar.jpg"
    },
    "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",
    "experimentId": "789e4567-e89b-12d3-a456-426614174000",
    "parentId": "123e4567-e89b-12d3-a456-426614174000",
    "hasSuggestedTask": true
  }
}

{
  "message": "Resource not found"
}

{
  "message": "Resource not found"
}

{
  "message": "Resource not found"
}

{
  "message": "Issue not found"
}

{
  "message": "Invalid request data",
  "issues": [
    {
      "code": "invalid_string",
      "message": "Invalid UUID",
      "path": [
        "id"
      ]
    }
  ]
}

{
  "message": "Resource not found"
}

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

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

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 · null

Updated summary of the issue

Example:

"The chatbot is consistently providing incomplete responses"

comment

string · null · 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"

type

enum<string>

Updated type/category

Available options:

BUG,

HUMAN_ANNOTATION,

SUGGESTED_TASK,

USER_SIGNAL

Example:

"HUMAN_ANNOTATION"

assignedTo

string · null · null

Reassign the issue to a different user

Example:

"user_345678"

topicId

string<uuid> | null

Update associated topic ID

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Example:

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

taskId

string<uuid> | null

Update associated task ID

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Example:

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

testId

string<uuid> · null · null

Update associated test ID

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Example:

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

evalDefinitionId

string<uuid> | null

Update associated evaluation definition ID

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Example:

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

annotationId

string<uuid> · null · null

Update associated annotation ID

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Example:

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

traceId

string · null · null

Update associated trace ID

Example:

"trace_xyz789"

experimentId

string<uuid> · null · null

Update associated experiment ID

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Example:

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

parentId

string<uuid> · null · null

Update parent issue ID for sub-issues

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

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

Show child attributes