Getting started

The Knips Public API is a single REST API over HTTPS that returns JSON. Endpoints are grouped by resource — see Endpoints in the sidebar.

Base URL

https://api.knips.tech

Your first request

Every request needs credentials — an access key and a secret, sent with Basic auth. Confirm the API is reachable and your credentials work with the ping endpoint:

curl https://api.knips.tech/ping \
  -u "ACCESS_KEY:SECRET"

A successful response returns the service name and version:

{ "name": "public-api", "version": "1.0.0" }

Next steps

• Authentication — how credentials work.
• API basics — base URL, formats and limits.
• Pagination & filtering — working with list endpoints.