Skip to main content
GET
/
context-documents
/
data-summary
Preview available data for context document generation
curl --request GET \
  --url https://api.hyperspell.com/context-documents/data-summary \
  --header 'Authorization: Bearer <token>'
{
  "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

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
total_resources
integer
required
pipeline_mode
string
required