REST API Overview

Interact with CustomKeys programmatically via our JSON-based REST API.

API Endpoint

The base URL for all API requests is: https://customkeys-api.superxepic.dev/v1

Authentication

All requests must be authenticated using a Bearer Token.

User JWT (Dashboard)

Used for local dev and the CLI.

Authorization: Bearer <your_jwt>

API Tokens (Programmatic)

Used for SDKs and CI/CD. Create these in Settings → Tokens.

Authorization: Bearer customkeys_tkn_...

Response Format

The API responds with JSON and uses standard HTTP status codes.

CodeMeaning
200/201Success
400Bad Request (Check validation errors)
401/403Unauthorized or Insufficient Permissions
404Resource Not Found
429Rate Limit Exceeded

Global Limits

  • Requests: 1000 requests per minute per IP (Free).
  • Payload: 1MB maximum request size.
  • WebSocket: 5 concurrent watchers per environment.
Last updated: 4/20/2026Report Issue