Skip to main content
GET
List indexed website pages

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.

Headers

X-Hyperspell-Response-Profile
enum<string>
default:api
Available options:
api,
mcp
X-As-User
string | null

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

Query Parameters

url
string
required
Required string length: 1 - 2048
cursor
string | null
Maximum string length: 2048
limit
integer
default:30
Required range: 1 <= x <= 100

Response

Successful Response

items
DocumentResponse · object[]
required
next_cursor
string | null
required
notices
ResponseContentLimitedNotice · object[] | null