Skip to main content
GET
/
public
/
v3
/
documents
/
transcripts
/
{id}
/
summary
Retrieve a transcript summary
curl --request GET \
  --url https://api.quartr.com/public/v3/documents/transcripts/{id}/summary \
  --header 'x-api-key: <api-key>'
import requests

url = "https://api.quartr.com/public/v3/documents/transcripts/{id}/summary"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.quartr.com/public/v3/documents/transcripts/{id}/summary', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
HttpResponse<String> response = Unirest.get("https://api.quartr.com/public/v3/documents/transcripts/{id}/summary")
.header("x-api-key", "<api-key>")
.asString();
package main

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

func main() {

url := "https://api.quartr.com/public/v3/documents/transcripts/{id}/summary"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-api-key", "<api-key>")

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

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

fmt.Println(string(body))

}
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.quartr.com/public/v3/documents/transcripts/{id}/summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);

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

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
{
  "data": {
    "id": 1343,
    "summary": "Q2 FY24 saw revenue decline and net loss, but IPO-driven debt reduction strengthened the balance sheet.<document-source>documentData_20677_20051795_17</document-source><document-source>documentData_20677_20051818_5</document-source>",
    "sources": [
      {
        "documentId": 3456,
        "typeId": 10,
        "sourceId": "documentData_4742_15110876_1",
        "page": 2,
        "timestamp": 110
      }
    ],
    "createdAt": "2025-01-01T00:00:00.000Z",
    "updatedAt": "2025-01-01T00:00:00.000Z"
  }
}
{
"message": "Unauthorized",
"statusCode": 401
}
{
"message": "Forbidden",
"statusCode": 403
}

Authorizations

x-api-key
string
header
required

Path Parameters

id
number
required

Query Parameters

length
enum<string>
default:short

Length preset for the summary.

Available options:
line,
short,
long
Example:

"long"

plain
boolean
default:false

Plain text summary without document sources embedded.

Example:

true

Response

data
object
required