Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.clipping.cc/llms.txt

Use this file to discover all available pages before exploring further.

The API uses API keys in the Authorization header, with the Bearer scheme:
Authorization: Bearer ck_live_YOUR_SECRET

Managing keys

Keys are created and revoked from the dashboard at clipping.cc/account:
  • Create: the full secret (ck_live_…) is shown once. The server stores only a hash — there is no way to recover it later.
  • Revoke: immediate. Requests using a revoked key start failing with 401.
  • You can have multiple keys (e.g. one per environment/integration).
Use one key per integration and give them descriptive names. That way, if one leaks, you revoke just that one without taking down the others.

Authentication errors

StatusMeaning
401Key missing, invalid, or revoked.
402Key valid, but the account has no balance. See billing.
Example error body:
{ "erro": "API key inválida ou ausente — use Authorization: Bearer ck_live_…" }

Access scope

The key inherits your account’s access: you read your own items, collections and reporters, plus whatever is public via discover. There are no per-permission scopes (yet) — a key has the same read reach as you do.