# Zaraftis API

> Public reference for the Zaraftis v1 API: routes, conventions, error catalog, credits, and billing rules.

## Docs

- [Quickstart](https://docs.zaraftis.com/): Get an API key, make your first call, and run your first scan with the Zaraftis v1 API.
- [How requests work](https://docs.zaraftis.com/conventions): Authentication, response shapes, paging, retries, long-running work, and rate limits in the Zaraftis v1 API.
- [Errors](https://docs.zaraftis.com/errors): Every Zaraftis v1 API error code, what it means, and what to do about it.
- [Credits and billing](https://docs.zaraftis.com/credits): What paid work costs in the Zaraftis v1 API, and how reservations settle.
- [Production checklist](https://docs.zaraftis.com/best-practices): Keys, retries, polling, credits, and logging to set up before you run the Zaraftis v1 API in production.
- [Changelog](https://docs.zaraftis.com/changelog): Changes to the Zaraftis v1 API that affect your code, newest first.

## API

- [Zaraftis Public API](https://docs.zaraftis.com/api): Measure how brands appear in AI search answers. Requests and responses are JSON over https://api.zaraftis.com/v1, authenticated with a bearer API key, and…

### Identity

- [Get the current credential](https://docs.zaraftis.com/api/identity/get-me): Returns the credential that made the request (never its secret) and its workspace. A free call… Reference for the GET /me endpoint in the Zaraftis Public API.
- [List platforms, prices, and limits](https://docs.zaraftis.com/api/identity/get-capabilities): Returns the AI platforms a scan can use, the credit price of each paid operation,… Reference for the GET /capabilities endpoint in the Zaraftis Public API.

### Workspace

- [Get the workspace](https://docs.zaraftis.com/api/workspace/get-workspace): Returns the name and organization_id of the credential's workspace. Reference for the GET /workspace endpoint in the Zaraftis Public API.

### Brands

- [Create a brand](https://docs.zaraftis.com/api/brands/create-brand): Creates a brand and starts reading its website to fill in its details. Returns 201 with… Reference for the POST /brands endpoint in the Zaraftis Public API.
- [List brands](https://docs.zaraftis.com/api/brands/get-brands): List brands. Reference for the GET /brands endpoint in the Zaraftis Public API.
- [Get a brand](https://docs.zaraftis.com/api/brands/get-brand): Get a brand. Reference for the GET /brands/{brand_id} endpoint in the Zaraftis Public API.
- [List a brand's topics](https://docs.zaraftis.com/api/brands/list-brand-topics): List a brand's topics. Reference for the GET /brands/{brand_id}/topics endpoint in the Zaraftis Public API.
- [List a brand's prompts](https://docs.zaraftis.com/api/brands/list-brand-prompts): List a brand's prompts. Reference for the GET /brands/{brand_id}/prompts endpoint in the Zaraftis Public API.
- [List a brand's competitors](https://docs.zaraftis.com/api/brands/list-brand-competitors): List a brand's competitors. Reference for the GET /brands/{brand_id}/competitors endpoint in the Zaraftis Public API.

### Visibility setups

- [Create a visibility setup](https://docs.zaraftis.com/api/visibility-setups/create-visibility-setup): Saves the brand, prompts, platforms, and competitors that scans measure. The… Reference for the POST /visibility-setups endpoint in the Zaraftis Public API.
- [Get a visibility setup](https://docs.zaraftis.com/api/visibility-setups/get-visibility-setup): Returns the saved setup with its current immutable version contents:… Reference for the GET /visibility-setups/{setup_id} endpoint in the Zaraftis Public API.
- [Update a visibility setup](https://docs.zaraftis.com/api/visibility-setups/patch-visibility-setup): Records an edit as a NEW immutable setup version and returns the… Reference for the PATCH /visibility-setups/{setup_id} endpoint in the Zaraftis Public API.
- [Archive a visibility setup](https://docs.zaraftis.com/api/visibility-setups/delete-visibility-setup): Destructive. Requires confirm: true in the body. Archives the… Reference for the DELETE /visibility-setups/{setup_id} endpoint in the Zaraftis Public API.
- [Copy a visibility setup](https://docs.zaraftis.com/api/visibility-setups/copy-visibility-setup): Creates a new saved setup with the same stored configuration… Reference for the POST /visibility-setups/{setup_id}:copy endpoint in the Zaraftis Public API.

### Visibility

- [Run a visibility check](https://docs.zaraftis.com/api/visibility/create-visibility-checks): Measures one prompt on one or more platforms and waits for the answers.… Reference for the POST /visibility/checks endpoint in the Zaraftis Public API.

### Scans

- [Start a scan](https://docs.zaraftis.com/api/scans/create-scans): Starts a paid scan of the chosen prompts on the chosen platforms and returns 202 right… Reference for the POST /scans endpoint in the Zaraftis Public API.
- [List scans](https://docs.zaraftis.com/api/scans/get-scans): Scan history for the workspace, newest first, with headline metric values for each scan.… Reference for the GET /scans endpoint in the Zaraftis Public API.
- [Get a scan](https://docs.zaraftis.com/api/scans/get-scan): Get a scan. Reference for the GET /scans/{scan_id} endpoint in the Zaraftis Public API.
- [List a scan's observations](https://docs.zaraftis.com/api/scans/list-scan-observations): List a scan's observations. Reference for the GET /scans/{scan_id}/observations endpoint in the Zaraftis Public API.
- [Get an observation](https://docs.zaraftis.com/api/scans/get-observations): Get an observation. Reference for the GET /observations/{observation_id} endpoint in the Zaraftis Public API.
- [List a scan's citations](https://docs.zaraftis.com/api/scans/list-scan-citations): Page tokens on this route are offset-based, so rows added or removed… Reference for the GET /scans/{scan_id}/citations endpoint in the Zaraftis Public API.
- [Get a scan's metrics](https://docs.zaraftis.com/api/scans/get-scan-metrics): Get a scan's metrics. Reference for the GET /scans/{scan_id}/metrics endpoint in the Zaraftis Public API.

### Site audits

- [Start a site audit](https://docs.zaraftis.com/api/site-audits/create-siteaudits): Starts a paid one-page Site audit of the brand's input landing-page URL (the audit… Reference for the POST /site-audits endpoint in the Zaraftis Public API.
- [List site audits](https://docs.zaraftis.com/api/site-audits/list-site-audits): Keyset-paginated Site-audit history, newest first. Filters brand_id, status, and… Reference for the GET /site-audits endpoint in the Zaraftis Public API.
- [Get a site audit](https://docs.zaraftis.com/api/site-audits/get-site-audit): Returns one audit: request, brand, status, and timestamps, the collected… Reference for the GET /site-audits/{audit_id} endpoint in the Zaraftis Public API.

### Integration snapshots

- [Get an integration snapshot](https://docs.zaraftis.com/api/integration-snapshots/get-integration-snapshot): Returns one immutable snapshot by its exact id: the stored… Reference for the GET /integration-snapshots/{snapshot_id} endpoint in the Zaraftis Public API.

### Scan reports

- [Create a scan report](https://docs.zaraftis.com/api/scan-reports/create-scanreports): Creates a report that cannot change later from exact source ids. Free: the scan was… Reference for the POST /scan-reports endpoint in the Zaraftis Public API.
- [List scan reports](https://docs.zaraftis.com/api/scan-reports/list-scan-reports): Keyset-paginated Scan Report history, newest first (compact list items: identity,… Reference for the GET /scan-reports endpoint in the Zaraftis Public API.
- [Get a scan report](https://docs.zaraftis.com/api/scan-reports/get-scan-report): Returns the stored report in the view you ask for: summary (default)… Reference for the GET /scan-reports/{report_id} endpoint in the Zaraftis Public API.

### Exports

- [Create an export](https://docs.zaraftis.com/api/exports/create-exports): Writes a scan report to a JSON or JSONL file in the background. Free. Body: { report_id,… Reference for the POST /exports endpoint in the Zaraftis Public API.
- [List exports](https://docs.zaraftis.com/api/exports/get-exports): Keyset-paginated export list, newest first. Items carry the export identity, source… Reference for the GET /exports endpoint in the Zaraftis Public API.
- [Get an export](https://docs.zaraftis.com/api/exports/list-exports): Returns the export's status and, once completed, its finalized file facts:… Reference for the GET /exports/{export_id} endpoint in the Zaraftis Public API.
- [Get an export download URL](https://docs.zaraftis.com/api/exports/download-export): Returns a short-lived URL for the stored export file. An unknown,… Reference for the GET /exports/{export_id}/download endpoint in the Zaraftis Public API.

### Tasks

- [Get a task](https://docs.zaraftis.com/api/tasks/get-tasks): Returns the status of asynchronous work and references to what it produced. Every… Reference for the GET /tasks/{task_id} endpoint in the Zaraftis Public API.

### Billing

- [Get the wallet](https://docs.zaraftis.com/api/billing/get-billing-wallet): Returns the workspace's credit balance and wallet state. A workspace that has no… Reference for the GET /billing/wallet endpoint in the Zaraftis Public API.
- [Update auto-reload settings](https://docs.zaraftis.com/api/billing/patch-billing-wallet): Changes the wallet's auto-reload settings. Needs the billing:write scope. Reference for the PATCH /billing/wallet endpoint in the Zaraftis Public API.
- [List wallet history](https://docs.zaraftis.com/api/billing/get-wallet-history): The wallet's credit history, newest first. Each entry has a wh_ id, a… Reference for the GET /billing/wallet-history endpoint in the Zaraftis Public API.

### Third-party connections

- [Connect a third-party account](https://docs.zaraftis.com/api/third-party-connections/create-thirdpartyconnections): Body: { provider: google, brand_id }. Every provider authorization… Reference for the POST /third-party-connections endpoint in the Zaraftis Public API.
- [List third-party connections](https://docs.zaraftis.com/api/third-party-connections/get-third-party-connection): Keyset-paginated list, newest first: connection identity, provider,… Reference for the GET /third-party-connections endpoint in the Zaraftis Public API.
- [Sync a third-party connection](https://docs.zaraftis.com/api/third-party-connections/sync-third-party-connection): Pulls fresh reports from the provider… Reference for the POST /third-party-connections/{third_party_connection_id}:sync endpoint in the Zaraftis Public API.

### Schedules

- [Create a schedule](https://docs.zaraftis.com/api/schedules/create-schedules): Body: { setup_id, frequency (daily|weekly|every_two_weeks|monthly), timezone (IANA),… Reference for the POST /schedules endpoint in the Zaraftis Public API.
- [List schedules](https://docs.zaraftis.com/api/schedules/get-schedule): Keyset-paginated list, newest first: one schedule's setup, brand, frequency, local… Reference for the GET /schedules endpoint in the Zaraftis Public API.
- [Get a schedule](https://docs.zaraftis.com/api/schedules/list-schedules): Get a schedule. Reference for the GET /schedules/{schedule_id} endpoint in the Zaraftis Public API.
- [Update a schedule](https://docs.zaraftis.com/api/schedules/patch-schedules): Body (any subset): frequency, timezone, local_time, start_date (edits… Reference for the PATCH /schedules/{schedule_id} endpoint in the Zaraftis Public API.
- [Delete a schedule](https://docs.zaraftis.com/api/schedules/delete-schedules): Destructive. A DELETE without the body { confirm: true } answers 400… Reference for the DELETE /schedules/{schedule_id} endpoint in the Zaraftis Public API.

## Agent resources

- [llms-full.txt](https://docs.zaraftis.com/llms-full.txt): The full Markdown of every page in one file.
- [Page Markdown](https://docs.zaraftis.com/index.md): Append `.md` to any page URL to fetch that page as raw Markdown.
- [JSON API](https://docs.zaraftis.com/api/docs/pages.json): Page index of the JSON docs API; each entry links the page's JSON and Markdown forms. Described by the OpenAPI document at https://docs.zaraftis.com/openapi.json.
- [API catalog](https://docs.zaraftis.com/.well-known/api-catalog): RFC 9727 linkset of the APIs documented here.
- [agent-readability.json](https://docs.zaraftis.com/agent-readability.json): Manifest of every agent-facing artifact on this site.
- [Sitemap](https://docs.zaraftis.com/sitemap.xml): Every indexable page URL with its last-modified date.