Getting started

The aclipp API lets you read and manage your workspace programmatically: pull clippings, run reports, and automate the work you'd otherwise do in the dashboard. Everything is scoped to a single workspace, which is implied by your bearer credential. This guide uses a manually created API key; registered OAuth clients can use an access token instead.

1. Create an API key

Open workspace settings and create a key. You'll see the full key exactly once, so copy it somewhere safe. Grant it only the scopes it needs (see Authentication & scopes).

2. Make a request

Send the key as a bearer token in the Authorization header. The base URL is https://api.aclipp.com/api/v1.

curl "https://api.aclipp.com/api/v1/me" \
  -H "Authorization: Bearer aclipp_live_..."

GET /me returns the workspace, scopes, and project restriction the credential resolves to. It's the quickest way to confirm authentication works.

3. Explore

Every endpoint, its parameters, and example requests and responses live in the API reference. A few things worth knowing:

• Responses are JSON. Errors use the shape { "error": { "code", "message" } }.
• Large lists are paginated with page and limit parameters where the endpoint supports pagination.
• Requests are rate limited per workspace; you'll get a 429 with a Retry-After header if you exceed it.

When you're ready, read Authentication & scopes to understand what each credential can and can't do, and Rate limits to plan retries and background jobs.