Skip to main content
PUT
/
v0
/
topics
/
{id}
Update a topic
curl --request PUT \
  --url https://api.avidoai.com/v0/topics/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>' \
  --data '
{
  "title": "Code Quality",
  "assignedTo": "user_789012",
  "isInScope": true,
  "isTasksVerified": true,
  "isDocumentsVerified": true,
  "isKnowledgeBaseVerified": true,
  "isPoliciesVerified": true,
  "status": "ACTIVE"
}
'
{
  "data": {
    "id": "789e4567-e89b-12d3-a456-426614174000",
    "orgId": "org_123456",
    "applicationId": "456e4567-e89b-12d3-a456-426614174000",
    "title": "Code Quality",
    "baseline": 0.85,
    "status": "ACTIVE",
    "isInScope": true,
    "isTasksVerified": false,
    "isDocumentsVerified": false,
    "isKnowledgeBaseVerified": false,
    "isPoliciesVerified": false,
    "createdAt": "2024-01-05T12:34:56.789Z",
    "modifiedAt": "2024-01-05T12:34:56.789Z",
    "assignedTo": "user_789012",
    "assignedUser": {
      "id": "user_789012",
      "name": "John Doe",
      "email": "john@example.com",
      "image": "https://example.com/avatar.jpg"
    },
    "evalDefinitions": [
      {
        "topicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "evalDefinition": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "createdAt": "2024-01-05T12:34:56.789Z",
          "modifiedAt": "2024-01-05T12:34:56.789Z",
          "name": "<string>",
          "globalConfig": {
            "criterion": "<string>"
          },
          "styleGuideId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "application": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "orgId": "org_123456",
            "title": "Customer Support Bot",
            "slug": "customer-support-bot",
            "description": "AI assistant for customer support inquiries",
            "context": "You are a helpful customer support assistant...",
            "language": "en",
            "type": "CHATBOT",
            "environment": "DEV",
            "humanAnnotationEnabled": false,
            "createdAt": "2024-01-05T12:34:56.789Z",
            "modifiedAt": "2024-01-05T12:34:56.789Z"
          },
          "topics": [
            "456e4567-e89b-12d3-a456-426614174000"
          ]
        },
        "config": {
          "expected": "<string>"
        }
      }
    ],
    "taskCount": 5,
    "documentCount": 3
  }
}

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 topic

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"

Body

application/json

Request body for updating a topic

​
title
string

Title of the topic

Minimum string length: 1
Example:

"Code Quality"

​
assignedTo
string · null · null

User ID to assign the topic to, or null to unassign

Example:

"user_789012"

​
isInScope
boolean

Whether the topic is in scope for knowledge tests and KB generation.

Example:

true

​
isTasksVerified
boolean

Whether all tasks in the topic are verified. Setting this will update isVerified on all tasks in the topic scoped to the calling application. Note: individual task updates trigger recalculation, which may override this value (e.g., a topic with no tasks will revert to false on the next task mutation). Deduced tasks are excluded from recalculation.

Example:

true

​
isDocumentsVerified
boolean

Whether all documents assigned to the topic are verified. Setting this will update isVerified on all documents in the topic, including global documents (applicationId: null).

Example:

true

​
isKnowledgeBaseVerified
boolean

Whether the knowledge base for this topic has been fully verified (facts and coverage reviewed).

Example:

true

​
isPoliciesVerified
boolean

Whether the policies for this topic (eval definitions and style guide) have been fully verified.

Example:

true

​
status
enum<string>

Status of the topic

Available options:
DRAFT,
ACTIVE
Example:

"ACTIVE"

Response

Successfully updated topic

Successful response containing the topic data

​
data
Topic · object
required

Details about a single Topic