Skip to content
ansvra.Documentation
Customer API
Customer API

Authentication

Create and use an access key with the right permissions.

Ansvra reference·5 min read

Send a Bearer key

Send Authorization: Bearer <access-key> on every request. Keys begin with ans_customer_. Browser sign-in cookies, crawler activity keys and platform-administration credentials do not authenticate the Customer API. Do not put a key in a query string, client-side website code or a public repository.

Choose permissions

ScopeAllows
data:readRead saved customer information and eligible downloads.
projects:writeCreate/edit projects and profile corrections. Current account Admin required.
prompts:writeCreate/edit/archive/restore prompts and create/rename categories.
competitors:writeCreate/edit/archive/restore competitors when the feature is enabled.

Permissions are independent: a write scope does not include data:read. Select only the permissions your integration needs. An account Admin creates keys; a key remains bound to that person’s membership. If their role changes, the key immediately follows the new role and project grants. Removing the membership invalidates its keys.

Restrict access to a project

A project key accesses only that project. An all-account key follows the owner’s current project permissions. Reading account usage, billing or invoices and creating projects requires an unrestricted key owned by a current account Admin. A Viewer cannot make configuration changes. A Member can change permitted prompts/categories/competitors only in assigned projects.

Expiration, rotation and revocation

Choose a 30-, 90- or 365-day expiration when creating a key; the default is 90 days. An account can have up to 20 active keys. Creation and rotation require a sign-in within the past 15 minutes.

Use Rotate to replace a key you own. The old key stops working immediately; save the replacement, which expires in 90 days, and update your integration. Other account Admins can revoke your key but cannot rotate it into their own membership. Revoke stops access immediately and remains available after paid access expires. Rotation or revocation can interrupt a connected tool, so update it deliberately.

Check account and feature availability

An active paid account is required for API access. Trial and legacy access do not qualify. Keys cannot exceed current permissions, paid access or enabled project features. Use the capabilities endpoint to check availability; an empty result does not enable an unavailable feature.

Ansvra

A clearer next step.

MEET YOUR AI GUIDE

A little clarity.
A clearer next move.

Ask about Ansvra, AI visibility, or your next step with content.

Opening chat…