Getting started

The Skoup API gives you programmatic access to what Skoup measures about your brands in AI answers — visibility, alerts, fixes, products and attributed revenue — and lets you act on it from your own tools. Webhooks push every meaningful change to your systems as it happens.

Everything lives under a single base URL:


https://api.skoup.ai/v1

The API is organized around REST: predictable resource-oriented URLs, JSON request and response bodies, standard HTTP verbs and status codes, and Bearer authentication.

Create an API key

In Skoup, open Settings → Developers → API keys and click New key. Name it after the integration that will use it (for example “Looker · internal dashboards”), pick its scopes and, optionally, restrict it to some brands.

The secret is displayed once. Copy it into your secret manager right away — Skoup only stores a hash and can never show it again.

Start with a test key (skoup_test_…). It reads a demo workspace and never writes anything, so you can build your integration without risk. See Test mode.

List your brands


curl https://api.skoup.ai/v1/brands \
  -H "Authorization: Bearer skoup_test_4eC39HqLyjWDarjtT1zdp7dc"


{
  "object": "list",
  "data": [
    {
      "id": "br_2xKq8Fh3LmN9pQrT4vWy6Z",
      "object": "brand",
      "name": "Nordvelo",
      "slug": "nordvelo",
      "site_url": "https://nordvelo.fr",
      "livemode": false
    }
  ],
  "has_more": false
}

Read the metrics of a brand

Every brand-scoped resource lives under /v1/brands/{brand}:


curl "https://api.skoup.ai/v1/brands/br_2xKq8Fh3LmN9pQrT4vWy6Z/metrics?market=FR&period=90d" \
  -H "Authorization: Bearer skoup_test_4eC39HqLyjWDarjtT1zdp7dc"

These are the same numbers you see in the Skoup interface — the API and the app read the same measurements.

Receive webhooks

What you can do

Area	Read	Write
Brands & markets	✓	—
Visibility metrics, queries & samplings	✓	Add, enable or disable queries
Alerts	✓	Mark treated, dismiss, re-verify
Tasks (fixes backlog)	✓	Create, update, move across the board
Products	✓	Create and update manual products
Competitors, readiness, attribution	✓	—
Events	✓	—
Webhook endpoints	✓	Create, delete

The complete list of endpoints is in the API reference.

Conventions at a glance

JSON everywhere. Send Content-Type: application/json on writes.
Prefixed IDs. Every object has an ID such as br_… or alrt_… — see Object IDs.
Dates are ISO-8601 strings in UTC (2026-09-23T08:00:00Z).
Money is a decimal string plus an ISO-4217 currency ("1899.00", "EUR").
Every response carries a Request-Id header. Quote it when you contact support.