---
seo:
  description: >-
    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…
sidebar:
  label: Overview
title: Zaraftis Public 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 paid work is charged in prepaid credits.

Every route follows the shared conventions at
https://docs.zaraftis.com/conventions: the response envelope with a
request id, the error format and code list, page tokens,
Idempotency-Key on POSTs that create work, compact and detailed views,
billing payloads, and rate limit headers.

Besides the responses listed on each route, any route can answer `401`,
`403`, `429`, or `500` in the shared error format. The common errors and
what to do about each are at https://docs.zaraftis.com/errors.

Version 1.0.0

Base URL: `https://api.zaraftis.com/v1`

## Identity

- [`GET /me`](/api/identity/get-me) — Get the current credential.
- [`GET /capabilities`](/api/identity/get-capabilities) — List platforms, prices, and limits.

## Workspace

- [`GET /workspace`](/api/workspace/get-workspace) — Get the workspace.

## Brands

- [`POST /brands`](/api/brands/create-brand) — Create a brand.
- [`GET /brands`](/api/brands/get-brands) — List brands.
- [`GET /brands/{brand_id}`](/api/brands/get-brand) — Get a brand.
- [`GET /brands/{brand_id}/topics`](/api/brands/list-brand-topics) — List a brand's topics.
- [`GET /brands/{brand_id}/prompts`](/api/brands/list-brand-prompts) — List a brand's prompts.
- [`GET /brands/{brand_id}/competitors`](/api/brands/list-brand-competitors) — List a brand's competitors.

## Visibility setups

- [`POST /visibility-setups`](/api/visibility-setups/create-visibility-setup) — Create a visibility setup.
- [`GET /visibility-setups/{setup_id}`](/api/visibility-setups/get-visibility-setup) — Get a visibility setup.
- [`PATCH /visibility-setups/{setup_id}`](/api/visibility-setups/patch-visibility-setup) — Update a visibility setup.
- [`DELETE /visibility-setups/{setup_id}`](/api/visibility-setups/delete-visibility-setup) — Archive a visibility setup.
- [`POST /visibility-setups/{setup_id}:copy`](/api/visibility-setups/copy-visibility-setup) — Copy a visibility setup.

## Visibility

- [`POST /visibility/checks`](/api/visibility/create-visibility-checks) — Run a visibility check.

## Scans

- [`POST /scans`](/api/scans/create-scans) — Start a scan.
- [`GET /scans`](/api/scans/get-scans) — List scans.
- [`GET /scans/{scan_id}`](/api/scans/get-scan) — Get a scan.
- [`GET /scans/{scan_id}/observations`](/api/scans/list-scan-observations) — List a scan's observations.
- [`GET /observations/{observation_id}`](/api/scans/get-observations) — Get an observation.
- [`GET /scans/{scan_id}/citations`](/api/scans/list-scan-citations) — List a scan's citations.
- [`GET /scans/{scan_id}/metrics`](/api/scans/get-scan-metrics) — Get a scan's metrics.

## Site audits

- [`POST /site-audits`](/api/site-audits/create-siteaudits) — Start a site audit.
- [`GET /site-audits`](/api/site-audits/list-site-audits) — List site audits.
- [`GET /site-audits/{audit_id}`](/api/site-audits/get-site-audit) — Get a site audit.

## Integration snapshots

- [`GET /integration-snapshots/{snapshot_id}`](/api/integration-snapshots/get-integration-snapshot) — Get an integration snapshot.

## Scan reports

- [`POST /scan-reports`](/api/scan-reports/create-scanreports) — Create a scan report.
- [`GET /scan-reports`](/api/scan-reports/list-scan-reports) — List scan reports.
- [`GET /scan-reports/{report_id}`](/api/scan-reports/get-scan-report) — Get a scan report.

## Exports

- [`POST /exports`](/api/exports/create-exports) — Create an export.
- [`GET /exports`](/api/exports/get-exports) — List exports.
- [`GET /exports/{export_id}`](/api/exports/list-exports) — Get an export.
- [`GET /exports/{export_id}/download`](/api/exports/download-export) — Get an export download URL.

## Tasks

- [`GET /tasks/{task_id}`](/api/tasks/get-tasks) — Get a task.

## Billing

- [`GET /billing/wallet`](/api/billing/get-billing-wallet) — Get the wallet.
- [`PATCH /billing/wallet`](/api/billing/patch-billing-wallet) — Update auto-reload settings.
- [`GET /billing/wallet-history`](/api/billing/get-wallet-history) — List wallet history.

## Third-party connections

- [`POST /third-party-connections`](/api/third-party-connections/create-thirdpartyconnections) — Connect a third-party account.
- [`GET /third-party-connections`](/api/third-party-connections/get-third-party-connection) — List third-party connections.
- [`POST /third-party-connections/{third_party_connection_id}:sync`](/api/third-party-connections/sync-third-party-connection) — Sync a third-party connection.

## Schedules

- [`POST /schedules`](/api/schedules/create-schedules) — Create a schedule.
- [`GET /schedules`](/api/schedules/get-schedule) — List schedules.
- [`GET /schedules/{schedule_id}`](/api/schedules/list-schedules) — Get a schedule.
- [`PATCH /schedules/{schedule_id}`](/api/schedules/patch-schedules) — Update a schedule.
- [`DELETE /schedules/{schedule_id}`](/api/schedules/delete-schedules) — Delete a schedule.