---
title: "Ping"
method: GET
path: "/v1/ping"
tags: ["v1"]
---

# Ping

`GET /v1/ping`

## Request

- Base URL: `https://api.korely.ai`
- URL: `https://api.korely.ai/v1/ping`
- Auth: HTTP bearer

Check a key before pointing an agent at it: 200 with its `scopes`, the
`processing_region` where a model reads its memories (null when that
region has no model to write with) and `region`, a label the operator set
with REGION (`eu` when not set), which the service cannot check: not a
statement of where the data is. Or 401. No scope is needed. It counts
against the request ceiling like every other call: past it, 429 with
`Retry-After`.

## Response `200`

Successful Response

- object

## Other responses

- `401`: `invalid_key`: the `Authorization: Bearer` key is missing, unknown, revoked or expired.
- `429`: `rate_limit_exceeded`: past the request ceiling, the per-minute one set on this install (`RATE_LIMIT_PER_MINUTE`) or, on the hosted service, the plan's minute, hour or day; `message` names the window and `Retry-After` the seconds until it resets.
- `500`: `internal_error`: the server failed on this request; `message` holds no detail of it.
- `503`: A dependency did not answer: the database while the key was checked (`unavailable`, see `Retry-After`), or the one `code` names. Nothing was written; retry.

---

[API](https://skmtc.dev/korely/apis/korely-agents-api.md) · [All operations](https://skmtc.dev/korely/apis/korely-agents-api/llms.txt) · [OpenAPI document](https://skmtc.dev/korely/apis/korely-agents-api/revisions/8a40bf09eca1?raw)