Search the docs

Find a page, a section, or an endpoint.

Sign inGet started

This key

Every this key endpoint, generated from the API's own schemas.

What this key is, and what it may do

get/api/v1/me

The one question a credential could not ask. Everything else here answers what is *in* the account, so the only way to learn your own access was to try something and read the refusal — and a key that reaches nothing looks exactly like a key that is broken. Free: no write, no side effect, and the three facts that decide whether your next call works.

Responses

  • 200The calling credential.
  • 400The request is not valid. `error.field` names the input at fault when there is one.
  • 401No API key, or one that is not valid.
  • 403Refused. `error.code` says why: `forbidden` when this key may not do this or the account is on hold, `abuse_blocked` when a limit says no.
  • 404No such resource, or one this key cannot reach. The two answer the same, so treat a 404 as “not available to you” rather than “does not exist”.
  • 409It conflicts with what is there: it already exists, or the `etag` you sent is not the current one.
  • 429Rate limited. `X-RateLimit-Reset` says when to retry.
  • 500Something went wrong on our side. Retry; if it keeps happening, tell us.
  • 503Something this needs is not answering right now. Retry in a moment.
bash
curl https://pidgeon.ai/api/v1/me \
  -H "Authorization: Bearer $PIDGEON_API_KEY"

Generated · public/openapi.json