Skip to main content
GET
/
v0
/
quickstarts
/
{id}
/
document-topics
List topics for a quickstart with document statistics
curl --request GET \
  --url https://api.avidoai.com/v0/quickstarts/{id}/document-topics \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>'
{
  "data": [
    {
      "id": "789e4567-e89b-12d3-a456-426614174000",
      "orgId": "org_123456",
      "applicationId": "456e4567-e89b-12d3-a456-426614174000",
      "title": "Code Quality",
      "baseline": 0.85,
      "status": "ACTIVE",
      "isTasksVerified": false,
      "isDocumentsVerified": false,
      "isKnowledgeBaseVerified": false,
      "isPoliciesVerified": false,
      "createdAt": "2024-01-05T12:34:56.789Z",
      "modifiedAt": "2024-01-05T12:34:56.789Z",
      "taskCount": 5,
      "documentCount": 8,
      "documentPercentage": 25,
      "factCount": 3,
      "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>"
          }
        }
      ]
    }
  ],
  "pagination": {
    "skip": 0,
    "limit": 25,
    "total": 100,
    "totalPages": 4,
    "totalTaskCount": 45,
    "totalFactCount": 12,
    "totalDocumentCount": 30,
    "totalPoliciesVerifiedCount": 10,
    "totalKnowledgeBaseVerifiedCount": 8,
    "totalVerifiedFactCount": 25,
    "totalCount": 100
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.avidoai.com/llms.txt

Use this file to discover all available pages before exploring further.

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 quickstart

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"

Query Parameters

​
skip
integer
default:0

Number of items to skip before starting to collect the result set.

Required range: 0 <= x <= 9007199254740991
Example:

0

​
limit
integer

Number of items to include in the result set.

Required range: 1 <= x <= 100
Example:

25

​
orderBy
enum<string>
default:createdAt

Field to order the result set by. 'taskCount' is sorted in-memory after enrichment in the route handler, so its ordering may change once the full page is materialised.

Available options:
createdAt,
modifiedAt,
title,
status,
id,
taskCount
Example:

"createdAt"

​
orderDir
enum<string>
default:desc

Order direction.

Available options:
asc,
desc
Example:

"desc"

​
title
string

Filter by topic title (case-insensitive)

Example:

"code quality"

​
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 quickstart document topics

Paginated response containing topics with document statistics and aggregate totals

​
data
object[]
required
​
pagination
PaginationWithAggregateTotals · object
required

Pagination metadata with aggregate totals across all topics in the quickstart