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

# Preview available data for context document generation

> Show what data is available before generating a context document.

Returns per-source breakdowns with counts, date ranges, and sample
titles so callers (humans or agents) can understand what's in the
system and decide what to include.

This is the "menu" — show them what we have, let them pick.



## OpenAPI

````yaml https://app.stainlessapi.com/api/spec/documented/hyperspell.yaml get /context-documents/data-summary
openapi: 3.1.0
info:
  title: Hyperspell API
  summary: >-
    Hyperspell is the memory layer for AI apps and agents. Through the API, you
    can add memories, connect data sources to index them in real-time, and
    search memories with our natural language query engine.
  termsOfService: https://hyperspell.com/blog/tos
  contact:
    name: Hyperspell
    url: https://hyperspell.com/
    email: hello@hyperspell.com
  version: 0.32.1
servers:
  - url: https://api.hyperspell.com
    description: Production
security:
  - APIKey: []
    AsUser: []
paths:
  /context-documents/data-summary:
    get:
      tags:
        - Context Documents
      summary: Preview available data for context document generation
      description: |-
        Show what data is available before generating a context document.

        Returns per-source breakdowns with counts, date ranges, and sample
        titles so callers (humans or agents) can understand what's in the
        system and decide what to include.

        This is the "menu" — show them what we have, let them pick.
      operationId: data_summary_context_documents_data_summary_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSummaryResponse'
      security:
        - APIKey: []
        - AsUser: []
components:
  schemas:
    DataSummaryResponse:
      properties:
        sources:
          items:
            $ref: '#/components/schemas/SourceSummary'
          type: array
          title: Sources
        total_resources:
          type: integer
          title: Total Resources
        pipeline_mode:
          type: string
          title: Pipeline Mode
      type: object
      required:
        - sources
        - total_resources
        - pipeline_mode
      title: DataSummaryResponse
      description: |-
        What data is available for context document generation.

        This lets callers (and agents) understand what's in Hyperspell before
        deciding what to include. Show this in the UI so users can pick sources,
        or expose it to agents so they can self-select relevant data.
    SourceSummary:
      properties:
        source:
          type: string
          title: Source
        count:
          type: integer
          title: Count
        oldest:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Oldest
        newest:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Newest
        sample_titles:
          items:
            type: string
          type: array
          title: Sample Titles
      type: object
      required:
        - source
        - count
        - oldest
        - newest
        - sample_titles
      title: SourceSummary
      description: Summary of available data for one integration source.
  securitySchemes:
    APIKey:
      type: http
      description: >-
        API Key or JWT User Token. If using an API Key, set the X-As-User header
        to act as a specific user. A JWT User Token is always scoped to a
        specific user.
      scheme: bearer
      bearerFormat: Bearer <token>
    AsUser:
      type: apiKey
      description: >-
        Optionally set this header to act as a specific user when using an API
        Key, equivalent to first exchanging the API Key for a User Token
      in: header
      name: X-As-User

````