Skip to content
ansvra.Documentation
Customer API
Customer API

Customer API

Connect your reporting tools to saved Ansvra information and manage selected project settings.

Ansvra reference·5 min read

Build with your saved information

Read projects, prompts, answers, citations, reports, research, content and saved files. Create or edit projects, prompts, categories and competitors, and save business profile corrections.

Use the API with an active paid account. Access keys follow their owner’s current membership and project permissions. Account suspension or loss of paid access prevents requests.

Make your first request

  1. Create an access key

    Open Settings → Access settings. Choose Customer data, then Create access key. An account Admin can create a key after a recent sign-in. Choose Read saved information and restrict the key to the project your tool needs.

  2. Save the key securely

    Copy the key when it is shown. Store it as the ANSVRA_ACCESS_KEY environment variable in your own secret manager or server environment. The complete key is shown only once.

  3. List your projects

    Run the request below. A successful response contains data, pagination and meta. Use a returned project id in the endpoint examples.

First request
curl 'https://app.ansvra.com/api/customer/v1/projects' \
  --header "Authorization: Bearer $ANSVRA_ACCESS_KEY"
bash
200 OK
{
  "data": [
    {
      "id": "project_123",
      "workspaceId": "workspace_123",
      "name": "Alder & Coast",
      "domain": "alderandcoast.com",
      "websiteUrl": "https://alderandcoast.com/",
      "market": "US",
      "targetState": null,
      "language": "en",
      "brandAliases": [],
      "domainAliases": [],
      "includeSubdomains": true,
      "archived": false,
      "createdAt": "2026-11-16T10:00:00.000Z"
    }
  ],
  "pagination": {
    "hasMore": false,
    "nextCursor": null
  },
  "meta": {
    "requestId": "request_123",
    "resultScope": "saved"
  }
}
json

Base URL and examples

The production base URL is https://app.ansvra.com/api/customer/v1. Endpoint paths in this reference are relative to it. Replace example identifiers with identifiers returned by your own account. Examples use fictional customer content and contain no working credentials. JavaScript examples run on a server with Node.js; Python examples use the requests package.

Understand configuration changes

The API does not provide platform administration, billing changes, team management, schedule controls, permanent deletion, or execution endpoints. Archive and restore are supported where listed. Project archiving is blocked while a subscription is ongoing; canceling renewal does not make it available before the subscription ends. This restriction does not prevent archiving individual prompts or competitors.

Continue building

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…