Skip to main content
POST
/
v0
/
issues
curl --request POST \
  --url https://api.avidoai.com/v0/issues \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>' \
  --data '{
  "title": "Response quality degradation",
  "summary": "The chatbot is providing incomplete responses",
  "source": "TEST",
  "priority": "HIGH",
  "applicationId": "456e7890-e89b-12d3-a456-426614174000"
}'
This response does not have an example.

Authorizations

​
x-api-key
string
header
required

Your unique Avido API key

​
x-application-id
string
header
required

Your unique Avido Application ID

Body

application/json

Request body for creating a new issue

​
title
string
required

Title of the issue

Example:

"Response quality degradation"

​
source
enum<string>
required

Where the issue originated from The source where the issue was created from

Available options:
TEST,
TASK,
TOPIC,
SYSTEM,
MONITORING,
API
Example:

"TEST"

​
priority
enum<string>
default:MEDIUM
required

Priority level of the issue The priority level of the issue

Available options:
LOW,
MEDIUM,
HIGH
Example:

"MEDIUM"

​
applicationId
string<uuid>
required

The ID of the application this issue belongs to

Example:

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

​
description
string | null

Detailed description of the issue

Example:

"The chatbot is providing incomplete responses to user queries"

​
topicId
string<uuid>

Associated topic ID if issue came from a topic

Example:

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

​
taskId
string<uuid>

Associated task ID if issue came from a task

Example:

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

​
testId
string<uuid>

Associated test ID if issue came from a test

Example:

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

​
evalDefinitionId
string<uuid>

Associated evaluation definition ID if issue came from an evaluation

Example:

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

​
annotationId
string<uuid>

Associated annotation ID if related to an annotation

Example:

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

​
traceId
string

Associated trace ID for monitoring/debugging

Example:

"trace_abc123"

​
parentId
string<uuid>

Parent issue ID for creating sub-issues

Example:

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

Response

Successfully created issue