Skip to main content
POST
/
context-documents
/
digest
Generate a daily company digest
curl --request POST \
  --url https://api.hyperspell.com/context-documents/digest \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "period": "daily",
  "window_start": "2023-11-07T05:31:56Z",
  "window_end": "2023-11-07T05:31:56Z",
  "sources": [
    "<string>"
  ]
}
'
{
  "tree_id": "<string>",
  "status": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}

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.

Body

application/json

Request body for POST /context-documents/digest.

​
period
string
default:daily

Digest cadence: 'daily' or 'weekly'. Sets the default window when none is given.

​
window_start
string<date-time> | null

Inclusive lower bound of the digest window. Defaults to midnight UTC today (paired with window_end=now) when omitted. Both bounds must be supplied together.

​
window_end
string<date-time> | null

Exclusive upper bound of the digest window. Defaults to now.

​
sources
string[] | null

Integration sources to include (e.g., ['slack', 'github']). Defaults to all.

Response

Successful Response

​
tree_id
string
required
​
status
string
required
​
created_at
string<date-time>
required