API v1
Build with Clipboard+
Connect your own scripts, workflows, and AI assistants to your Clipboard+ account.
Quick start
- Open Account settings and generate a narrowly scoped API key.
- Save the key in a secret manager or environment variable. It is shown only once.
- Send it as a Bearer token to the API.
curl https://backend-production-74d4.up.railway.app/api/clipboard?limit=20 \
-H "Authorization: Bearer $CLIPBOARDPLUS_API_KEY"Never put a key in browser-side code, chat messages, source control, or prompts. Revoke it immediately if exposed.
Endpoints and scopes
| Method | Path | Scope | Purpose |
|---|---|---|---|
| GET | /api/clipboard | clipboard:read | List and paginate items |
| POST | /api/clipboard | clipboard:write | Create an item |
| PATCH | /api/clipboard/:id/favorite | clipboard:write | Toggle favorite status |
| DELETE | /api/clipboard/:id | clipboard:write | Delete one item |
| DELETE | /api/clipboard/bulk | clipboard:write | Delete selected items |
| DELETE | /api/clipboard | clipboard:write | Delete all non-favorites |
| GET | /api/snippets | snippets:read | List all snippets |
| POST | /api/snippets | snippets:write | Create a snippet |
| PUT | /api/snippets | snippets:write | Replace every snippet |
| DELETE | /api/snippets/:id | snippets:write | Delete one snippet |
| GET | /api/settings | settings:read | Read settings |
| PUT | /api/settings | settings:write | Partially update settings |
Clipboard listing supports limit (1–500), offset (0–100000), and returns hasMore. Snippets are returned as one unpaginated list of at most 200. Responses are JSON; errors use { "error": "message" }. Honor 429 and Retry-After with exponential backoff.
Advanced sync clients can also use POST /api/clipboard/sync and GET /api/clipboard/pull. Their exact inputs and outputs are in the OpenAPI contract. Personal keys cannot create or revoke other API keys; manage keys from an authenticated Account settings session.
AI assistant instructions
Give your assistant the complete OpenAPI contract or LLM-readable guide, then provide the key through its encrypted secret store—not in the conversation. Grant read-only scopes unless the assistant must change data, require confirmation before every create, change, delete, or bulk operation, and rotate keys periodically.
You can use the Clipboard+ API described at
https://clipboardplus.apercallc.com/openapi.json.
Read data when needed. Ask before creating, changing, or deleting anything.
Never reveal, log, or repeat the API key.Example: add a clip
curl -X POST https://backend-production-74d4.up.railway.app/api/clipboard \
-H "Authorization: Bearer $CLIPBOARDPLUS_API_KEY" \
-H "Content-Type: application/json" \
-d '{"type":"text","content":"Added by my automation","source":"api"}'API use is governed by the Terms and Privacy Policy.