Developer documentation

Automate Webklip with the REST API, CLI, and webhooks.

Webklip exposes a JSON REST API for creating, reading, updating, and deleting clips. Use it from scripts, CI pipelines, or any HTTP client. A small CLI wraps the same endpoints for terminal workflows.

Quick start

Create a clip and read it back:

curl -s -X POST https://webklip.com/api/v1/clips/my-clip \
  -H "Content-Type: application/json" \
  -d '{"content":"hello from the API","burnOnRead":false,"ttl":3600}'

curl -s https://webklip.com/api/v1/clips/my-clip

Guides

• REST API — endpoints, request bodies, PIN headers, and rate limits
• CLI — push and pull clip content from your terminal
• Webhooks — get notified when clips are read, burned, or expired

Authentication

Anonymous clips work without credentials — the slug URL is the access secret. Clip CRUD does not require sign-in or an API key.

Limits

• Clip slugs: 3–64 characters, letters, numbers, _, and -
• Content size: up to 1 MB per update
• Rate limits: per-IP caps on API requests and clip creation (see X-RateLimit-Remaining response header)