Skip to main content
Developer portal

Developer docs

Quickstart

API access model, the first authenticated call, and the response envelope you can rely on.

Access model

The Kalinklo Artists API is in private alpha. Issuance of API keys is by introduction during the charter — apply at /pilot. The public endpoints documented under Public Endpoints do not require a key; the rest do.

The base URL is your environment's origin:

  • Production: https://kalinklo.com
  • Preview / branch: as printed in your deploy

There is no separate api. host. All endpoints live under /api/* on the same origin as the application.

A first call

Once your key is issued, the canonical first call confirms auth and rate-limit headers without changing any state:

curl -sSf "https://kalinklo.com/api/v1/artists?limit=1" \
  -H "Authorization: Bearer kal_live_xxxxxxxx" \
  -H "Accept: application/json"

The response shape:

{
  "success": true,
  "data": [ /* … */ ],
  "count": 1
}

The response envelope

Every JSON response follows the same envelope.

Success:

  • success: true
  • data — typed payload (object or array)
  • pagination fields when applicable (count, nextCursor)

Error:

  • success: false
  • error.code — stable string, safe to switch on
  • error.message — human-readable, do not parse
  • HTTP status — see the table in Telemetry and Status

Sandbox console

The /developers page hosts a browser console that calls the same endpoints under your active session. Use it to confirm behaviour before wiring a production client.

Where to next