Skip to main content
GET
/
v0
/
topics
/
ids
Get topic IDs
curl --request GET \
  --url https://api.avidoai.com/v0/topics/ids \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>'
{
  "topicIds": [
    "123e4567-e89b-12d3-a456-426614174000",
    "223e4567-e89b-12d3-a456-426614174001"
  ]
}

Authorizations

​
x-api-key
string
header
required

Your unique Avido API key

​
x-application-id
string
header
required

Your unique Avido Application ID

Query Parameters

​
title
string

Filter by topic title (case-insensitive)

Example:

"code quality"

​
isInScope
string

Filter topics by scope status. When true, only returns in-scope topics. When false, only returns out-of-scope topics.

Example:

"true"

​
isTasksVerified
string

Filter topics by task verification status. When true, only returns topics where all tasks are verified. When false, only returns unverified topics.

Example:

"false"

​
isKnowledgeBaseVerified
string

Filter topics by knowledge base verification status. When true, only returns topics where the knowledge base has been verified. When false, only returns unverified topics.

Example:

"false"

​
isPoliciesVerified
string

Filter topics by policies verification status. When true, only returns topics where the policies have been verified. When false, only returns unverified topics.

Example:

"false"

Response

Successfully retrieved topic IDs

Response containing an array of topic IDs

​
topicIds
string<uuid>[]
required

Array of topic IDs

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",
  "223e4567-e89b-12d3-a456-426614174001"
]