Skip to content

Livesov REST API

Programmatic access to every Livesov surface - brands, prompts, runs, metrics, citations, and reports. REST endpoints plus signed webhooks for real-time events.

Get an API key
Endpoints

Six resources, full CRUD

REST conventions, JSON in and out, bearer-token auth.

/v1/brands

List, create, update, and delete tracked brands. Includes competitor sets and tracked URLs.

/v1/prompts

Manage the prompt panel for any brand - list, add, update, delete, or bulk-import.

/v1/runs

Trigger a measurement run or fetch results from a previous run, scoped by brand, prompt, or LLM.

/v1/metrics

Aggregated mention rate, citation share, sentiment, and rank-in-answer over any time range.

/v1/citations

The full list of cited URLs detected for any brand or prompt across grounded LLM surfaces.

/v1/reports

Generate a PDF or CSV report on demand for any brand and time range.

A request, end-to-end

Fetch mention rate across three LLMs for one brand over 30 days.

curl https://api.livesov.com/v1/metrics \
  -H "Authorization: Bearer $LIVESOV_API_KEY" \
  -d brand_id=br_abc123 \
  -d range=30d \
  -d llms=chatgpt,perplexity,gemini

# {
#   "brand_id": "br_abc123",
#   "range": "30d",
#   "metrics": {
#     "chatgpt":    { "mention_rate": 0.64, "citation_share": 0.21, ... },
#     "perplexity": { "mention_rate": 0.71, "citation_share": 0.18, ... },
#     "gemini":     { "mention_rate": 0.58, "citation_share": 0.14, ... }
#   }
# }
Webhooks

Six real-time events

Signed with HMAC-SHA256, delivered with automatic retry + idempotency keys.

mention_rate.dropped

A tracked brand's mention rate dropped past your configured threshold on an LLM.

competitor.passed

A competitor overtook your brand on mention rate, citation share, or rank.

citation.created

A new third-party URL began citing your brand on a grounded LLM surface.

sentiment.shifted

Net sentiment for a brand or prompt moved past your threshold.

report.ready

A scheduled or on-demand report finished generating and is ready to fetch.

run.completed

A measurement run completed (useful for cron-driven measurement flows).

A webhook payload

POST https://your.app/webhooks/livesov
Content-Type: application/json
X-Livesov-Signature: sha256=...

{
  "type": "mention_rate.dropped",
  "id": "evt_01h...",
  "occurred_at": "2026-06-06T09:31:22Z",
  "brand": { "id": "br_abc123", "name": "Northwind" },
  "llm": "chatgpt",
  "metric": {
    "previous": 0.64,
    "current": 0.51,
    "delta_pp": -13
  },
  "prompts_affected": [ "prompt_01h...", "prompt_01h..." ]
}

What teams build on the API

  • Custom dashboards. Stream metrics into your own data warehouse, then visualise in Looker / Metabase / Tableau.
  • White-label client reports. Agencies render branded PDFs nightly via the report endpoint.
  • CRM enrichment. Append AI share-of-voice to every account record in Salesforce or HubSpot.
  • Programmatic prompt management. Auto-generate prompt panels from a content calendar or product launch list.
  • Real-time PR rapid-response. Webhook into PagerDuty or Linear when a competitor lands a major citation.
Docs and SDKs
Full REST reference, webhook signature verification, and official TypeScript + Python SDKs live at /docs.

API FAQ

How do I get an API key?

Settings → API in your Livesov dashboard. Keys are per-workspace; rotate any time. Read and write scopes are separate.

What are the rate limits?

Default: 60 requests per minute per workspace, 10,000 per day. Higher limits available on Scale and Enterprise plans.

Is the API REST or GraphQL?

REST today. We use standard HTTP verbs, JSON request/response bodies, and bearer-token auth. A GraphQL layer is on the roadmap for late 2026.

How are webhooks authenticated?

HMAC-SHA256 signatures via the X-Livesov-Signature header. Use the signing secret from your webhook config to verify every payload.

Is there a Node / Python SDK?

Official TypeScript and Python SDKs ship in the docs. Both wrap REST + webhook signature verification + retries.

Can I use the API during the free trial?

Read-only API access is included on the 7-day free trial. Write endpoints and webhooks require any paid plan.

More ways to plug Livesov in

Slack integration
Native real-time alerts in Slack channels.
Zapier integration
5,000+ apps without code.
All integrations
Every LLM, alert route, and export format.
Docs
API reference, SDKs, and integration guides.

Ready to track your AI visibility?

Monitor your brand across ChatGPT, Perplexity, Claude, Gemini & Grok.
Get Started

No credit card required.