Skip to main content
What’s changed in the Surfais API, newest first. Additive changes arrive within /v1 — Versioning and changes explains what that covers. For changes to the Surfais app itself, see the product changelog.
​
API v1: keys, read and write endpoints, on-demand scans and signed webhooks
The first version of the Surfais API is available at https://api.surfais.com/v1. Start with the introduction or the quickstart.
  • Keys and scopes. Organisation keys reach one organisation. Partner keys reach every organisation linked to a platform partner. Each key carries the read scope, or read and write. See Authentication.
  • Read endpoints. Organisations and their usage against plan caps; brands, brand detail and the per-brand summary; prompts; per-prompt results and per-brand mentions; score history and share of voice; cited sources. See The data model.
  • Write endpoints. Create, update and deactivate prompts; sync a brand’s whole prompt set in one declarative call; provision a property with its competitors; add and remove competitors. Partners can also store their own reference on an organisation link.
  • On-demand scans. Request a scan for an own brand.
  • Signed webhooks for platform partners. scan.completed, score.threshold_crossed and sentiment.threshold_crossed, each signed so that you can verify the sender. See Webhooks.
  • Conventions. Cursor pagination on every list, idempotency keys on every write, and rate limits set per key.

Versioning and changes

Which changes arrive within a version, and how to build a client that absorbs them.

Support

How to get help, and what to send with a question.