> ## 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. # List topics for a quickstart with document statistics > Retrieves a paginated list of topics belonging to a specific quickstart, enriched with document count and coverage statistics. ## OpenAPI ````yaml https://app.stainless.com/api/spec/documented/avido/openapi.documented.yml get /v0/quickstarts/{id}/document-topics openapi: 3.1.1 info: title: Avido API description: >- Avido's API for LLM usage events, tool calls, trace management, webhook validation, and more. See each endpoint's request/response schema for details. version: 0.1.0 contact: name: Avido Support email: support@avidoai.com url: https://avidoai.com/support servers: - url: https://api.avidoai.com description: Production API security: - ApiKey: [] ApplicationId: [] paths: /v0/quickstarts/{id}/document-topics: get: tags: - QuickstartsV2 summary: List topics for a quickstart with document statistics description: >- Retrieves a paginated list of topics belonging to a specific quickstart, enriched with document count and coverage statistics. operationId: listQuickstartDocumentTopics parameters: - in: path name: id schema: type: string format: uuid 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)$ description: The unique identifier of the quickstart example: 123e4567-e89b-12d3-a456-426614174000 required: true description: The unique identifier of the quickstart - in: query name: skip schema: description: Number of items to skip before starting to collect the result set. example: 0 default: 0 type: integer minimum: 0 maximum: 9007199254740991 description: Number of items to skip before starting to collect the result set. - in: query name: limit schema: description: Number of items to include in the result set. example: 25 type: integer minimum: 1 maximum: 100 description: Number of items to include in the result set. - in: query name: orderBy schema: description: >- 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. example: createdAt default: createdAt type: string enum: - createdAt - modifiedAt - title - status - id - taskCount description: >- 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. - in: query name: orderDir schema: description: Order direction. example: desc default: desc type: string enum: - asc - desc description: Order direction. - in: query name: title schema: description: Filter by topic title (case-insensitive) example: code quality type: string description: Filter by topic title (case-insensitive) - in: query name: isInScope schema: description: >- Filter topics by scope status. When true, only returns in-scope topics. When false, only returns out-of-scope topics. example: 'true' type: string description: >- Filter topics by scope status. When true, only returns in-scope topics. When false, only returns out-of-scope topics. - in: query name: isTasksVerified schema: description: >- Filter topics by task verification status. When true, only returns topics where all tasks are verified. When false, only returns unverified topics. example: 'false' type: string description: >- Filter topics by task verification status. When true, only returns topics where all tasks are verified. When false, only returns unverified topics. - in: query name: isKnowledgeBaseVerified schema: description: >- 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' type: string description: >- 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. - in: query name: isPoliciesVerified schema: description: >- 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' type: string description: >- Filter topics by policies verification status. When true, only returns topics where the policies have been verified. When false, only returns unverified topics. responses: '200': description: Successfully retrieved quickstart document topics content: application/json: schema: $ref: '#/components/schemas/PaginatedTopicWithDocumentStatsResponse' '400': description: bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: invalid input content: application/json: schema: $ref: '#/components/schemas/ValidationErrorResponse' '500': description: internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' components: schemas: PaginatedTopicWithDocumentStatsResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/TopicWithDocumentStatsOutput' pagination: $ref: '#/components/schemas/PaginationWithAggregateTotalsOutput' required: - data - pagination additionalProperties: false title: PaginatedTopicWithDocumentStats description: >- Paginated response containing topics with document statistics and aggregate totals ErrorResponse: type: object properties: message: type: string description: A human-readable error message explaining the error. example: Resource not found required: - message additionalProperties: false title: ErrorResponse description: Standard error format for failed API operations. ValidationErrorResponse: type: object properties: message: type: string description: A human-readable error message indicating what went wrong. example: Invalid request data issues: type: array items: type: object properties: code: type: string message: type: string path: type: array items: type: string required: - code - message - path additionalProperties: false description: Array of detailed validation error objects. example: - code: invalid_string message: Invalid UUID path: - id required: - message - issues additionalProperties: false title: ValidationErrorResponse description: Details about validation errors in incoming requests. TopicWithDocumentStatsOutput: type: object properties: id: type: string format: uuid 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)$ description: Unique identifier of the topic example: 789e4567-e89b-12d3-a456-426614174000 orgId: type: string description: Organization ID that owns this topic example: org_123456 applicationId: type: string format: uuid 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)$ description: Application ID this topic belongs to example: 456e4567-e89b-12d3-a456-426614174000 title: type: string description: Title of the topic example: Code Quality baseline: anyOf: - type: number - type: 'null' description: Optional baseline score for this topic example: 0.85 nullable: true status: type: string enum: - DRAFT - ACTIVE - ARCHIVED description: Status of the topic (DRAFT or ACTIVE) example: ACTIVE assignedTo: description: User ID of the assigned user example: user_789012 type: string assignedUser: $ref: '#/components/schemas/AssignedUserInfoOutput' description: Information about the assigned user isInScope: type: boolean description: >- Whether the topic is in scope for knowledge tests and KB generation. Out-of-scope topics are excluded from MECE, coverage tests, and KB generation. example: true isTasksVerified: type: boolean description: Whether all tasks in the topic are verified (excludes deduced tasks) example: false isDocumentsVerified: type: boolean description: Whether all documents assigned to the topic are signed off example: false isKnowledgeBaseVerified: type: boolean description: >- Whether the knowledge base for this topic has been fully verified (facts and coverage reviewed) example: false isPoliciesVerified: type: boolean description: >- Whether the policies for this topic (eval definitions and style guide) have been fully verified example: false evalDefinitions: description: Evaluation definitions linked to this topic type: array items: type: object properties: topicId: type: string format: uuid 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)$ evalDefinition: $ref: '#/components/schemas/EvalDefinitionOutput' config: type: object properties: expected: anyOf: - type: string - type: array items: type: string required: - expected additionalProperties: false required: - topicId - evalDefinition additionalProperties: false createdAt: description: When the topic was created example: '2024-01-05T12:34:56.789Z' type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ modifiedAt: description: When the topic was last modified example: '2024-01-05T12:34:56.789Z' type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ taskCount: type: integer minimum: 0 maximum: 9007199254740991 description: Number of tasks assigned to this topic within the quickstart example: 5 documentCount: type: integer minimum: 0 maximum: 9007199254740991 description: Number of documents assigned to this topic within the quickstart example: 8 documentPercentage: type: integer minimum: 0 maximum: 100 description: >- Percentage of total quickstart documents assigned to this topic (0-100). May not sum to 100 across all topics if some documents are not yet assigned to a topic. example: 25 factCount: type: integer minimum: 0 maximum: 9007199254740991 description: Number of facts assigned to this topic within the quickstart example: 3 generatedArticleCount: description: >- Number of successfully generated and activated KB articles for this topic. Only present when generateKbFromMaterials is enabled. example: 4 type: integer minimum: 0 maximum: 9007199254740991 refusedArticleCount: description: >- Number of articles the enrichment agent refused to write for this topic. Only present when generateKbFromMaterials is enabled. example: 1 type: integer minimum: 0 maximum: 9007199254740991 deniedArticleCount: description: >- Number of articles the review agent denied for this topic. Only present when generateKbFromMaterials is enabled. example: 0 type: integer minimum: 0 maximum: 9007199254740991 inScopeTaskCount: description: >- Number of tasks belonging to in-scope topics for this topic. Only present when generateKbFromMaterials is enabled. example: 5 type: integer minimum: 0 maximum: 9007199254740991 required: - id - orgId - applicationId - title - baseline - status - isInScope - isTasksVerified - isDocumentsVerified - isKnowledgeBaseVerified - isPoliciesVerified - createdAt - modifiedAt - taskCount - documentCount - documentPercentage - factCount additionalProperties: false PaginationWithAggregateTotalsOutput: type: object properties: skip: type: integer minimum: 0 maximum: 9007199254740991 description: Number of items skipped. example: 0 limit: type: integer minimum: 1 maximum: 9007199254740991 description: Number of items per page. example: 25 total: type: integer minimum: 0 maximum: 9007199254740991 description: Total number of items available. example: 100 totalPages: type: integer minimum: 0 maximum: 9007199254740991 description: Total number of pages available. example: 4 totalCount: description: >- Total number of items without filters applied. Used to distinguish between truly empty results and empty filtered results. example: 100 type: integer minimum: 0 maximum: 9007199254740991 totalTaskCount: type: integer minimum: 0 maximum: 9007199254740991 description: >- Total number of tasks across all topics in the quickstart (independent of pagination) example: 45 totalFactCount: type: integer minimum: 0 maximum: 9007199254740991 description: >- Total number of topic-scoped facts across all topics in the quickstart (independent of pagination) example: 12 totalDocumentCount: type: integer minimum: 0 maximum: 9007199254740991 description: >- Total number of knowledge documents in the quickstart (independent of pagination) example: 30 totalPoliciesVerifiedCount: type: integer minimum: 0 maximum: 9007199254740991 description: >- Total count of topics with isPoliciesVerified = true (unfiltered across all pages) example: 10 totalKnowledgeBaseVerifiedCount: type: integer minimum: 0 maximum: 9007199254740991 description: >- Total count of topics with isKnowledgeBaseVerified = true (unfiltered across all pages) example: 8 totalVerifiedFactCount: type: integer minimum: 0 maximum: 9007199254740991 description: Total count of facts with isVerified = true across the quickstart example: 25 totalGeneratedArticleCount: description: >- Total number of successfully generated and activated KB articles across all topics. Only present when generateKbFromMaterials is enabled. example: 20 type: integer minimum: 0 maximum: 9007199254740991 totalRefusedArticleCount: description: >- Total number of articles the enrichment agent refused to write across all topics. Only present when generateKbFromMaterials is enabled. example: 3 type: integer minimum: 0 maximum: 9007199254740991 totalDeniedArticleCount: description: >- Total number of articles the review agent denied across all topics. Only present when generateKbFromMaterials is enabled. example: 1 type: integer minimum: 0 maximum: 9007199254740991 totalInScopeTaskCount: description: >- Total number of tasks belonging to in-scope topics across the quickstart. Only present when generateKbFromMaterials is enabled. example: 30 type: integer minimum: 0 maximum: 9007199254740991 required: - skip - limit - total - totalPages - totalTaskCount - totalFactCount - totalDocumentCount - totalPoliciesVerifiedCount - totalKnowledgeBaseVerifiedCount - totalVerifiedFactCount additionalProperties: false title: PaginationWithAggregateTotals description: >- Pagination metadata with aggregate totals across all topics in the quickstart AssignedUserInfoOutput: type: object properties: id: type: string description: User ID example: user_789012 name: type: string description: User full name example: John Doe email: type: string format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ description: User email example: john@example.com image: description: User profile image URL example: https://example.com/avatar.jpg type: string required: - id - name - email additionalProperties: false title: AssignedUserInfo description: Information about the user assigned to an issue EvalDefinitionOutput: type: object properties: id: type: string format: uuid 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)$ createdAt: description: When the eval definition was created example: '2024-01-05T12:34:56.789Z' type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ modifiedAt: description: When the eval definition was last modified example: '2024-01-05T12:34:56.789Z' type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ type: $ref: '#/components/schemas/EvalType' name: type: string globalConfig: anyOf: - type: object properties: criterion: type: string minLength: 1 description: >- The criterion describes what our evaluation LLM must look for in the response. Remember that the answer to the criterion must be as a pass/fail. required: - criterion additionalProperties: false - oneOf: - $ref: '#/components/schemas/OutputMatchStringConfigOutput' - $ref: '#/components/schemas/OutputMatchListConfigOutput' type: object discriminator: propertyName: type mapping: string: $ref: '#/components/schemas/OutputMatchStringConfigOutput' list: $ref: '#/components/schemas/OutputMatchListConfigOutput' styleGuideId: anyOf: - type: string format: uuid 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)$ - type: 'null' application: anyOf: - $ref: '#/components/schemas/ApplicationOutput' - type: 'null' topics: description: Topic IDs this eval definition is linked to (for topic-scoped evals) example: - 456e4567-e89b-12d3-a456-426614174000 type: array items: type: string format: uuid 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)$ required: - id - createdAt - modifiedAt - type - name additionalProperties: false EvalType: type: string enum: - NATURALNESS - STYLE - RECALL - CUSTOM - OUTPUT_MATCH OutputMatchStringConfigOutput: type: object properties: type: type: string const: string extract: $ref: '#/components/schemas/OutputMatchExtractConfigOutput' required: - type additionalProperties: false OutputMatchListConfigOutput: type: object properties: type: type: string const: list matchMode: type: string enum: - exact_unordered - contains scoreMetric: type: string enum: - f1 - precision - recall passThreshold: type: number minimum: 0 maximum: 1 extract: $ref: '#/components/schemas/OutputMatchExtractConfigOutput' required: - type - matchMode additionalProperties: false ApplicationOutput: type: object properties: id: type: string format: uuid 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)$ description: Unique identifier of the application example: 123e4567-e89b-12d3-a456-426614174000 orgId: type: string description: Organization ID that owns this application example: org_123456 title: type: string minLength: 1 description: Title of the application example: Customer Support Bot slug: type: string minLength: 1 description: URL-friendly slug for the application example: customer-support-bot description: type: string description: Description of the application example: AI assistant for customer support inquiries context: type: string description: Context/instructions for the application example: You are a helpful customer support assistant... language: default: en description: Language of the application. example: en type: string enum: - da - de - en - es - fr - it - nl - pt - sv type: type: string enum: - CHATBOT - AGENT description: Type of the application. Valid values are CHATBOT or AGENT. example: CHATBOT environment: default: DEV description: Environment of the application. Defaults to DEV. example: DEV type: string enum: - DEV - PROD humanAnnotationEnabled: type: boolean description: Whether human annotation is enabled for this application example: false createdAt: description: When the application was created example: '2024-01-05T12:34:56.789Z' type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ modifiedAt: description: When the application was last modified example: '2024-01-05T12:34:56.789Z' type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ required: - id - orgId - title - slug - description - context - language - type - environment - humanAnnotationEnabled - createdAt - modifiedAt additionalProperties: false title: Application description: Application configuration and metadata OutputMatchExtractConfigOutput: type: object properties: pattern: type: string minLength: 1 flags: type: string pattern: ^[gimsuy]*$ group: anyOf: - type: integer minimum: 0 maximum: 9007199254740991 - minItems: 1 type: array items: type: integer minimum: 0 maximum: 9007199254740991 required: - pattern - flags - group additionalProperties: false securitySchemes: ApiKey: type: apiKey in: header name: x-api-key description: Your unique Avido API key ApplicationId: type: apiKey in: header name: x-application-id description: Your unique Avido Application ID ````