Quickstart: REST (5 minutes)
Make your first authenticated, credit-metered API call.
Goal: make your first authenticated, credit-metered API call.
1. Get a key. Create one with the link:links.write scope — see API keys.
You'll use it as a bearer token on every request below.
2. Make the call.
The Idempotency-Key is required on this call because it spends credits: if your connection drops and you
retry with the same key, you get the same link back instead of a second one. Use a fresh UUID per link
you intend to create.
3. Read the response.
id is the link's canonical identifier — use it for later GET/PATCH/DELETE calls. credits_charged
and credits_balance tell you what this call cost and what's left, with no extra request. If something
goes wrong instead, you'll get a problem+json body with a stable code — see
Concepts: errors for how to branch on it.
Where to next:
- List and paginate your links —
GET /v1/links?cursor=… - Handle rate limits and retries
- Quickstart: MCP — the same operation from an AI agent