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 is pay-per-use, drawn from the balance of the account that owns the API key. Balance is measured in coins (1 coin = R$ 1.00).

​
Model: flat fee + pass-through

Every /v1 call has two cost components:
1

Flat platform fee

A small amount per request, drawn from the key account.
2

Pass-through (when applicable)

If the call triggers an external provider (transcription, AI, YouTube), its real cost is passed through too. The current read routes serve from the database and usually have no pass-through.

​
Flat fee per route

RouteCost
Most reads (me, items, collections, reporters, videos, discover)0.001 coin
search0.005 coin
items/{id}/transcript0.005 coin
Prices may be adjusted as the operation evolves. The cost is always drawn after the response — a billing failure never drops the call.

​
Insufficient balance

Before processing, the API checks the balance. If it’s zero or negative, the response is: 
// HTTP 402 Payment Required
{ "erro": "saldo insuficiente — adicione coins na conta" }
Add coins at clipping.cc/balance.

​
Top up via Pix

Coins are purchased via Pix (1 coin = R$ 1.00). The flow:
1

Create the charge

POST /admin/accounts/me/deposit/pix with { amount_coins, cpf }. Returns the QR Code (base64 image) and the copy-and-paste code:
{
  "deposit_id": "…",
  "status": "pending",
  "amount_coins": 50,
  "pix": {
    "qr_code_base64": "iVBORw0KGgo…",
    "copia_e_cola": "00020101…",
    "expiration": "2026-05-28T23:59:59Z"
  }
}
2

Pay

The user pays the Pix from their bank app (QR or copy-and-paste). Minimum of 5 coins per top-up.
3

Automatic credit

When the payment confirms, the provider (Asaas) notifies the API and the coins are credited to the account — you get a deposit_credited event in real time.
The credit happens only after the Pix is confirmed. The processing fee is absorbed by the platform — you are credited exactly amount_coins.

​
Tracking usage

The current balance comes from GET /v1/me (see the API Reference tab). The detailed transaction statement lives in the dashboard at clipping.cc/balance.