Skip to main content
The ShortKit API is organized around REST. It uses standard HTTP methods, returns JSON responses, and uses conventional HTTP status codes to indicate success or failure.

Base URL

All API requests use the following base URL:
All requests must be made over HTTPS.

Authentication

Every request requires an API key. See Authentication for key types and usage.

Response envelope

Every response is wrapped in a standard envelope:
  • data — The requested resource or array of resources. null on errors.
  • meta — Always includes request_id. May include pagination fields like nextCursor.
  • errors — Present only on error responses. See Errors for status codes and handling.

Pagination

List endpoints use cursor-based pagination. The response includes a nextCursor field in meta when more results are available.
When meta.nextCursor is absent, you’ve reached the last page.
Cursor tokens are opaque — they may change format at any time. Do not parse, decode, or construct them manually.

Request IDs

Every response includes a request_id in meta. Include this when contacting support about a specific request.

Environments

API keys encode their environment (live or test) in the prefix. These environments are completely isolated — a live key cannot access test data, and vice versa. See Authentication for details.