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>"
  ]
}
'
import requests

url = "https://api.hyperspell.com/context-documents/digest"

payload = {
"period": "daily",
"window_start": "2023-11-07T05:31:56Z",
"window_end": "2023-11-07T05:31:56Z",
"sources": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
period: 'daily',
window_start: '2023-11-07T05:31:56Z',
window_end: '2023-11-07T05:31:56Z',
sources: ['<string>']
})
};

fetch('https://api.hyperspell.com/context-documents/digest', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hyperspell.com/context-documents/digest",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'period' => 'daily',
'window_start' => '2023-11-07T05:31:56Z',
'window_end' => '2023-11-07T05:31:56Z',
'sources' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.hyperspell.com/context-documents/digest"

payload := strings.NewReader("{\n \"period\": \"daily\",\n \"window_start\": \"2023-11-07T05:31:56Z\",\n \"window_end\": \"2023-11-07T05:31:56Z\",\n \"sources\": [\n \"<string>\"\n ]\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.hyperspell.com/context-documents/digest")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"period\": \"daily\",\n \"window_start\": \"2023-11-07T05:31:56Z\",\n \"window_end\": \"2023-11-07T05:31:56Z\",\n \"sources\": [\n \"<string>\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.hyperspell.com/context-documents/digest")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"period\": \"daily\",\n \"window_start\": \"2023-11-07T05:31:56Z\",\n \"window_end\": \"2023-11-07T05:31:56Z\",\n \"sources\": [\n \"<string>\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "tree_id": "<string>",
  "status": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<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.

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