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/v1Identity
Workspace
Brands
- POSTCreate a brand
/brands - GETList brands
/brands - GETGet a brand
/brands/{brand_id} - GETList a brand's topics
/brands/{brand_id}/topics - GETList a brand's prompts
/brands/{brand_id}/prompts - GETList a brand's competitors
/brands/{brand_id}/competitors
Visibility setups
- POSTCreate a visibility setup
/visibility-setups - GETGet a visibility setup
/visibility-setups/{setup_id} - PATCHUpdate a visibility setup
/visibility-setups/{setup_id} - DELETEArchive a visibility setup
/visibility-setups/{setup_id} - POSTCopy a visibility setup
/visibility-setups/{setup_id}:copy
Visibility
Scans
- POSTStart a scan
/scans - GETList scans
/scans - GETGet a scan
/scans/{scan_id} - GETList a scan's observations
/scans/{scan_id}/observations - GETGet an observation
/observations/{observation_id} - GETList a scan's citations
/scans/{scan_id}/citations - GETGet a scan's metrics
/scans/{scan_id}/metrics
Site audits
- POSTStart a site audit
/site-audits - GETList site audits
/site-audits - GETGet a site audit
/site-audits/{audit_id}
Integration snapshots
Scan reports
- POSTCreate a scan report
/scan-reports - GETList scan reports
/scan-reports - GETGet a scan report
/scan-reports/{report_id}
Exports
- POSTCreate an export
/exports - GETList exports
/exports - GETGet an export
/exports/{export_id} - GETGet an export download URL
/exports/{export_id}/download
Tasks
Billing
- GETGet the wallet
/billing/wallet - PATCHUpdate auto-reload settings
/billing/wallet - GETList wallet history
/billing/wallet-history
Third-party connections
- POSTConnect a third-party account
/third-party-connections - GETList third-party connections
/third-party-connections - POSTSync a third-party connection
/third-party-connections/{third_party_connection_id}:sync