Skip to main content
GET
/
context-documents
List context documents
curl --request GET \
  --url https://api.hyperspell.com/context-documents \
  --header 'Authorization: Bearer <token>'
{
  "documents": [
    {
      "document_id": "<string>",
      "status": "<string>",
      "sources": [
        "<string>"
      ],
      "model": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "token_count": 123
    }
  ],
  "next_cursor": "<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.

Query Parameters

​
limit
integer
default:20
​
cursor
string | null
​
status
enum<string> | null
Available options:
processing,
completed,
failed

Response

Successful Response

​
documents
ContextDocumentSummary · object[]
required
​
next_cursor
string | null
required