Farbeam
Docs / API: Keys

Current key

Returns the key record, its limits and up to 30 days of daily usage.

GET/api/v1/me
PropertyValue
AuthenticationRequired. Send Authorization: Bearer <key>.
Rate-limit cost0 units
StatusLive

#Request

curl -s "https://farbeamlabs.com/api/v1/me" \
  -H "Authorization: Bearer $FARBEAM_KEY"
const res = await fetch("https://farbeamlabs.com/api/v1/me", {
  headers: { Authorization: `Bearer ${process.env.FARBEAM_KEY}` }
});
const { data, meta, error } = await res.json();
if (error) throw new Error(`${error.code}: ${error.message}`);
console.log(data);
import os, requests

res = requests.get(
    "https://farbeamlabs.com/api/v1/me",
    headers={"Authorization": f"Bearer {os.environ['FARBEAM_KEY']}"},
    timeout=30,
)
body = res.json()
if "error" in body:
    raise RuntimeError(body["error"]["code"])
print(body["data"])

You can send this request now in the API playground.

#Response

This response is real. It was captured from the running API when this page was built. Arrays are cut to two items.

JSON
{
  "data": {
    "id": "key_000000000000",
    "label": "my-app",
    "created_at": "2026-11-04T20:10:50.184Z",
    "last_used_at": "2026-11-04T20:10:58.160Z",
    "requests_per_minute": 120,
    "rule_limit": 10,
    "rules": 0,
    "usage": [
      {
        "day": "2026-11-04",
        "calls": 29
      }
    ]
  },
  "meta": {
    "request_id": "req_434b6cb44b99",
    "as_of": "2026-11-04T20:10:58.170Z"
  }
}

#Errors

HTTPCodeMeaning
401missing_keyThe request has no key.
401invalid_keyThe key is unknown or revoked.

All errors share one format. See errors.