Skip to main content
PUT
Update a topic

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