> ## Documentation Index
> Fetch the complete documentation index at: https://docs.threetone.in/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Knowledge Base Summaries By Ids

> Gets multiple knowledge base document summaries by their IDs.



## OpenAPI

````yaml https://api.threetone.in/openapi.json get /v1/voiceai/knowledge-base/summaries
openapi: 3.1.0
info:
  title: Threetone API Documentation
  version: 1.0.0
servers:
  - url: https://api.threetone.in
    description: Production
security: []
paths:
  /v1/voiceai/knowledge-base/summaries:
    get:
      tags:
        - Knowledge Base
      summary: Get Knowledge Base Summaries By Ids
      description: Gets multiple knowledge base document summaries by their IDs.
      operationId: get_agent_knowledge_base_summaries_route
      parameters:
        - name: document_ids
          in: query
          required: true
          schema:
            type: array
            items:
              type: string
            minItems: 1
            maxItems: 100
            description: The ids of knowledge base documents.
            title: Document Ids
          description: The ids of knowledge base documents.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  anyOf:
                    - $ref: >-
                        #/components/schemas/KnowledgeBaseSummaryBatchSuccessfulResponseModel
                    - $ref: '#/components/schemas/BatchFailureResponseModel'
                title: Response Get Agent Knowledge Base Summaries Route
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
        - HTTPBearer: []
components:
  schemas:
    KnowledgeBaseSummaryBatchSuccessfulResponseModel:
      properties:
        status:
          type: string
          const: success
          title: Status
          description: Status indicator
          default: success
        data:
          oneOf:
            - $ref: '#/components/schemas/GetKnowledgeBaseSummaryURLResponseModel'
            - $ref: '#/components/schemas/GetKnowledgeBaseSummaryFileResponseModel'
            - $ref: '#/components/schemas/GetKnowledgeBaseSummaryTextResponseModel'
            - $ref: '#/components/schemas/GetKnowledgeBaseSummaryFolderResponseModel'
          title: Data
          description: Document summary data
          discriminator:
            propertyName: type
            mapping:
              file:
                $ref: '#/components/schemas/GetKnowledgeBaseSummaryFileResponseModel'
              folder:
                $ref: >-
                  #/components/schemas/GetKnowledgeBaseSummaryFolderResponseModel
              text:
                $ref: '#/components/schemas/GetKnowledgeBaseSummaryTextResponseModel'
              url:
                $ref: '#/components/schemas/GetKnowledgeBaseSummaryURLResponseModel'
      type: object
      required:
        - data
      title: KnowledgeBaseSummaryBatchSuccessfulResponseModel
      description: Successful response for a single batch summary item
    BatchFailureResponseModel:
      properties:
        status:
          type: string
          const: failure
          title: Status
          description: Status indicator
          default: failure
        error_code:
          type: integer
          title: Error Code
          description: HTTP error code
        error_status:
          type: string
          title: Error Status
          description: Error status string
        error_message:
          type: string
          title: Error Message
          description: Error message
      type: object
      required:
        - error_code
        - error_status
        - error_message
      title: BatchFailureResponseModel
      description: Failure response for a single batch item
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    GetKnowledgeBaseSummaryURLResponseModel:
      properties:
        id:
          type: string
          title: Id
          description: Document ID
        name:
          type: string
          title: Name
          description: Document name
        metadata:
          $ref: '#/components/schemas/KnowledgeBaseDocumentMetadataResponseModel'
          description: Document metadata
        supported_usages:
          items:
            $ref: '#/components/schemas/DocumentUsageModeEnum'
          type: array
          title: Supported Usages
          description: Supported usage modes for this document
        access_info:
          $ref: '#/components/schemas/ResourceAccessInfo'
          description: Access information for the requesting user
        folder_parent_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Folder Parent Id
          description: >-
            The ID of the parent folder, or null if the document is at the root
            level
        folder_path:
          items:
            $ref: '#/components/schemas/KnowledgeBaseFolderPathSegmentResponseModel'
          type: array
          title: Folder Path
          description: >-
            The folder path segments leading to this entity, from root to parent
            folder.
        rag_summary:
          anyOf:
            - $ref: '#/components/schemas/RAGSummaryResponseModel'
            - type: 'null'
          description: >-
            Latest RAG index status for this document (None if never indexed or
            folder)
        type:
          type: string
          const: url
          title: Type
          description: Document type discriminator
          default: url
        url:
          type: string
          title: Url
          description: The source URL
      type: object
      required:
        - id
        - name
        - metadata
        - access_info
        - url
      title: GetKnowledgeBaseSummaryURLResponseModel
      description: Knowledge base document summary for URL type
    GetKnowledgeBaseSummaryFileResponseModel:
      properties:
        id:
          type: string
          title: Id
          description: Document ID
        name:
          type: string
          title: Name
          description: Document name
        metadata:
          $ref: '#/components/schemas/KnowledgeBaseDocumentMetadataResponseModel'
          description: Document metadata
        supported_usages:
          items:
            $ref: '#/components/schemas/DocumentUsageModeEnum'
          type: array
          title: Supported Usages
          description: Supported usage modes for this document
        access_info:
          $ref: '#/components/schemas/ResourceAccessInfo'
          description: Access information for the requesting user
        folder_parent_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Folder Parent Id
          description: >-
            The ID of the parent folder, or null if the document is at the root
            level
        folder_path:
          items:
            $ref: '#/components/schemas/KnowledgeBaseFolderPathSegmentResponseModel'
          type: array
          title: Folder Path
          description: >-
            The folder path segments leading to this entity, from root to parent
            folder.
        rag_summary:
          anyOf:
            - $ref: '#/components/schemas/RAGSummaryResponseModel'
            - type: 'null'
          description: >-
            Latest RAG index status for this document (None if never indexed or
            folder)
        type:
          type: string
          const: file
          title: Type
          description: Document type discriminator
          default: file
      type: object
      required:
        - id
        - name
        - metadata
        - access_info
      title: GetKnowledgeBaseSummaryFileResponseModel
      description: Knowledge base document summary for file type
    GetKnowledgeBaseSummaryTextResponseModel:
      properties:
        id:
          type: string
          title: Id
          description: Document ID
        name:
          type: string
          title: Name
          description: Document name
        metadata:
          $ref: '#/components/schemas/KnowledgeBaseDocumentMetadataResponseModel'
          description: Document metadata
        supported_usages:
          items:
            $ref: '#/components/schemas/DocumentUsageModeEnum'
          type: array
          title: Supported Usages
          description: Supported usage modes for this document
        access_info:
          $ref: '#/components/schemas/ResourceAccessInfo'
          description: Access information for the requesting user
        folder_parent_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Folder Parent Id
          description: >-
            The ID of the parent folder, or null if the document is at the root
            level
        folder_path:
          items:
            $ref: '#/components/schemas/KnowledgeBaseFolderPathSegmentResponseModel'
          type: array
          title: Folder Path
          description: >-
            The folder path segments leading to this entity, from root to parent
            folder.
        rag_summary:
          anyOf:
            - $ref: '#/components/schemas/RAGSummaryResponseModel'
            - type: 'null'
          description: >-
            Latest RAG index status for this document (None if never indexed or
            folder)
        type:
          type: string
          const: text
          title: Type
          description: Document type discriminator
          default: text
      type: object
      required:
        - id
        - name
        - metadata
        - access_info
      title: GetKnowledgeBaseSummaryTextResponseModel
      description: Knowledge base document summary for text type
    GetKnowledgeBaseSummaryFolderResponseModel:
      properties:
        id:
          type: string
          title: Id
          description: Document ID
        name:
          type: string
          title: Name
          description: Document name
        metadata:
          $ref: '#/components/schemas/KnowledgeBaseDocumentMetadataResponseModel'
          description: Document metadata
        supported_usages:
          items:
            $ref: '#/components/schemas/DocumentUsageModeEnum'
          type: array
          title: Supported Usages
          description: Supported usage modes for this document
        access_info:
          $ref: '#/components/schemas/ResourceAccessInfo'
          description: Access information for the requesting user
        folder_parent_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Folder Parent Id
          description: >-
            The ID of the parent folder, or null if the document is at the root
            level
        folder_path:
          items:
            $ref: '#/components/schemas/KnowledgeBaseFolderPathSegmentResponseModel'
          type: array
          title: Folder Path
          description: >-
            The folder path segments leading to this entity, from root to parent
            folder.
        rag_summary:
          anyOf:
            - $ref: '#/components/schemas/RAGSummaryResponseModel'
            - type: 'null'
          description: >-
            Latest RAG index status for this document (None if never indexed or
            folder)
        type:
          type: string
          const: folder
          title: Type
          description: Document type discriminator
          default: folder
        children_count:
          type: integer
          title: Children Count
          description: Number of direct children in the folder
      type: object
      required:
        - id
        - name
        - metadata
        - access_info
        - children_count
      title: GetKnowledgeBaseSummaryFolderResponseModel
      description: Knowledge base document summary for folder type
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    KnowledgeBaseDocumentMetadataResponseModel:
      properties:
        created_at_unix_secs:
          type: integer
          title: Created At Unix Secs
          description: Document creation time in unix seconds
        last_updated_at_unix_secs:
          type: integer
          title: Last Updated At Unix Secs
          description: Document last update time in unix seconds
        size_bytes:
          type: integer
          title: Size Bytes
          description: Document size in bytes
      type: object
      required:
        - created_at_unix_secs
        - last_updated_at_unix_secs
        - size_bytes
      title: KnowledgeBaseDocumentMetadataResponseModel
      description: Metadata for knowledge base documents - matches enterprise schema
    DocumentUsageModeEnum:
      type: string
      enum:
        - prompt
        - auto
      title: DocumentUsageModeEnum
      description: |-
        How the document is used in agent context.
        - prompt: Always include full document in LLM context
        - auto: Use RAG to retrieve relevant chunks
    ResourceAccessInfo:
      properties:
        is_creator:
          type: boolean
          title: Is Creator
          description: Whether the user making the request is the creator of the resource
        creator_name:
          type: string
          title: Creator Name
          description: Name of the resource's creator
        creator_email:
          type: string
          title: Creator Email
          description: Email of the resource's creator
        role:
          $ref: '#/components/schemas/ResourceRole'
          description: The role of the user making the request
      type: object
      required:
        - is_creator
        - creator_name
        - creator_email
        - role
      title: ResourceAccessInfo
      description: Access information for a resource
    KnowledgeBaseFolderPathSegmentResponseModel:
      properties:
        id:
          type: string
          title: Id
          description: Folder ID
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
          description: Folder name
      type: object
      required:
        - id
      title: KnowledgeBaseFolderPathSegmentResponseModel
      description: Folder path segment for hierarchical navigation
    RAGSummaryResponseModel:
      properties:
        status:
          type: string
          title: Status
          description: created | processing | succeeded | failed
        progress_percentage:
          type: number
          title: Progress Percentage
          description: 0-100 indexing progress
          default: 0
      type: object
      required:
        - status
      title: RAGSummaryResponseModel
      description: Inline RAG indexing status included in list responses.
    ResourceRole:
      type: string
      enum:
        - admin
        - editor
        - commenter
        - viewer
      title: ResourceRole
      description: Role for resource access control
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      description: API key for programmatic access
      in: header
      name: x-api-key
    HTTPBearer:
      type: http
      description: JWT Bearer token for dashboard access
      scheme: bearer

````