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.

GET /context-documents/data-summary

Preview available data for context document generation

cURL

curl --request GET \
  --url https://api.hyperspell.com/context-documents/data-summary \
  --header 'Authorization: Bearer <token>'

200

{
  "sources": [
    {
      "source": "<string>",
      "count": 123,
      "oldest": "2023-11-07T05:31:56Z",
      "newest": "2023-11-07T05:31:56Z",
      "sample_titles": [
        "<string>"
      ]
    }
  ],
  "total_resources": 123,
  "pipeline_mode": "<string>"
}

Authorizations

APIKeyAsUser

Authorization · string · header · required

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.

Response

200 - application/json

Successful Response

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.

sources · SourceSummary · object[] · required

Show child attributes

total_resources · integer · required

pipeline_mode · string · required