Batch & status

Ping

A minimal liveness probe: prove a freshly minted kor_live_ key authenticates, and read back its tier, EU region, and scopes.

GET /v1/ping

The first call to make after minting a key. It confirms the bearer token resolves to a live key, surfaces the tier and granted scopes you'll use to reason about access, and proves at the wire that your data lives in the EU region the key is bound to.

Authentication

HTTP header, required: Authorization: Bearer kor_live_....

Query parameters

None. /v1/ping takes no query parameters, no path parameters, and no request body, just the Authorization header.

Example request

curl https://api.korely.ai/v1/ping \
  -H "Authorization: Bearer kor_live_..."

import requests

resp = requests.get(
    "https://api.korely.ai/v1/ping",
    headers={"Authorization": "Bearer kor_live_..."},
)

print(resp.json())
# {"ok": True, "tier": "hobby", "region": "eu-hel1", "scopes": [...]}

const resp = await fetch("https://api.korely.ai/v1/ping", {
  headers: { Authorization: "Bearer kor_live_..." },
});

console.log(await resp.json());
// { ok: true, tier: "hobby", region: "eu-hel1", scopes: [...] }

Response

200 OK. Confirmation that the key authenticated, plus its tier, EU region, and granted scopes.

{
  "ok": true,
  "tier": "hobby",
  "region": "eu-hel1",
  "scopes": ["memories:read", "memories:write", "facts:read"]
}

Field	Type	Description
`ok`	boolean	Always `true` on success, confirms the `kor_live_` key authenticated.
`tier`	string	The API key's billing tier, e.g. `hobby`.
`region`	string	EU data-residency proof at the wire: the server's configured EU region (e.g. `eu-hel1`).
`scopes`	array[string]	The scopes granted to the key; an empty list if the key has no scopes.

Errors

Status	Code	Cause
`401`	`invalid_key`	The `Authorization` header is missing or empty, or the bearer token does not resolve to a live key. The response detail is the plain string `Invalid or missing API key` with a `WWW-Authenticate: Bearer` header. Note: the detail is a plain string, not a structured `{"code": ...}` object.

Notes

Auth-only. Ping depends only on a valid key, there is no scope requirement and no rate limiting, so it never returns 403 or 429.
Source of each field. tier and scopes come from the key itself; region is read from the server's configuration, not the key. scopes defaults to an empty list [] when the key has none.
Side effect. Resolving the key stamps its last_used_at, so a ping also serves as a heartbeat for the key.
Use it in CI. A green ping is the fastest signal that your key, region binding, and EU endpoint are all wired correctly before you touch the memory endpoints under /v1/memories/{memory_id}.

Add a memory, the first real write once ping is green.
Get context, read back the assembled recall block.
SDK, the typed client for these endpoints.