> ## Documentation Index
> Fetch the complete documentation index at: https://docs.surfais.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API changelog

> Changes to the Surfais API, newest first.

What's changed in the Surfais API, newest first. Additive changes arrive within `/v1` — [Versioning and changes](/api/versioning) explains what that covers. For changes to the Surfais app itself, see the [product changelog](/resources/changelog).

<Update label="September 2026" description="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](/api/introduction) or the [quickstart](/api/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](/api/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](/api/data-model).
  * **Write endpoints.** Create, update and deactivate prompts; [sync a brand's whole prompt set](/api/guides/sync-prompts) in one declarative call; [provision a property](/api/guides/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](/api/guides/run-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](/api/webhooks/overview).
  * **Conventions.** [Cursor pagination](/api/pagination) on every list, [idempotency keys](/api/idempotency) on every write, and [rate limits](/api/rate-limits) set per key.
</Update>

## Related pages

<CardGroup cols={2}>
  <Card title="Versioning and changes" href="/api/versioning">
    Which changes arrive within a version, and how to build a client that absorbs them.
  </Card>

  <Card title="Support" href="/api/support">
    How to get help, and what to send with a question.
  </Card>
</CardGroup>