Summarix developer docs

Base URL #

https://api.summarix.co.za

All endpoints are versioned under /v1, use JSON, and require HTTPS. API access is included on the Starter, Professional and Business plans. Import every endpoint into Postman in one step with the Postman collection. There is also an OpenAPI 3.1 spec for Insomnia or code generators.

Quickstart #

1. In Dashboard → API keys, create a key and choose its scopes. You get a secret key (smx_sk_live_…, shown once) and a public key (smx_pk_live_…).
2. Check the key works:

   export SUMMARIX_SECRET_KEY=smx_sk_live_…
   
   curl https://api.summarix.co.za/v1/whoami -H "Authorization: Bearer $SUMMARIX_SECRET_KEY"

3. Send some data:

   curl https://api.summarix.co.za/v1/datasets \
     -H "Authorization: Bearer $SUMMARIX_SECRET_KEY" \
     -H "Content-Type: application/json" \
     -d '{"name":"Sales","rows":[{"month":"2026-07","region":"Gauteng","revenue":410000},
                                {"month":"2026-08","region":"Gauteng","revenue":452000}]}'

4. Generate an AI report and collect the result:

   curl https://api.summarix.co.za/v1/reports -H "Authorization: Bearer $SUMMARIX_SECRET_KEY" \
     -H "Content-Type: application/json" -d '{"datasetId":"DATASET_ID"}'
   # → 202 {"data":{"id":"REPORT_ID","status":"QUEUED"}}
   
   curl https://api.summarix.co.za/v1/reports/REPORT_ID -H "Authorization: Bearer $SUMMARIX_SECRET_KEY"
   # poll until status is COMPLETED — or subscribe to the report.completed webhook

Node.js and Python #

const res = await fetch("https://api.summarix.co.za/v1/reports", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.SUMMARIX_SECRET_KEY}`, "Content-Type": "application/json" },
  body: JSON.stringify({ datasetId: "DATASET_ID", prompt: "Focus on margin by region" }),
});
const { data } = await res.json(); // { id, status: "QUEUED" }

import os, requests

r = requests.post("https://api.summarix.co.za/v1/reports",
    headers={"Authorization": f"Bearer {os.environ['SUMMARIX_SECRET_KEY']}"},
    json={"datasetId": "DATASET_ID"})
r.raise_for_status()
print(r.json()["data"])

Core concepts #