Skip to main content
GET
/
context-documents
/
{document_id}
Get a context document
curl --request GET \
  --url https://api.hyperspell.com/context-documents/{document_id} \
  --header 'Authorization: Bearer <token>'
{
  "document_id": "<string>",
  "status": "<string>",
  "sources": [
    "<string>"
  ],
  "user_id": "<string>",
  "model": "<string>",
  "content": "<string>",
  "prompt": "<string>",
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "error": "<string>",
  "token_usage": {}
}

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.

Path Parameters

​
document_id
string
required

Response

Successful Response

​
document_id
string
required
​
status
string
required
​
sources
string[]
required
​
user_id
string | null
required
​
model
string
required
​
content
string | null
required
​
prompt
string | null
required
​
metadata
Metadata · object
required
​
created_at
string<date-time>
required
​
completed_at
string<date-time> | null
required
​
error
string | null
required
​
token_usage
Token Usage · object
required