Skip to content
Product Documentation

Introspect the calling API key: tier, rate limit, and quota usage.

GET
/v1/me
curl --request GET \
  --url https://api.betflux.ai/v1/me \
  --header 'Authorization: Bearer <token>'

Reachable even when the monthly row quota is exhausted, and never counts against it.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

The key’s tier and usage.

Media typeapplication/json
object
key_id
required

Id of the calling API key (not the secret).

string
tier
required

The key’s entitled product tier.

string
Allowed values: DEMO BETA STARTER PRO
rate_limit_per_minute
required

Requests per minute this tier allows.

integer
quota
required
object
monthly_rows
required

Rows per calendar month the tier allows; null while unconfigured (unlimited).

integer | null
used_rows
required

Rows served so far this month (best-effort; 0 if the ledger is unreachable).

integer
resets
required

ISO date (UTC) the monthly quota resets.

string
Example
{
  "tier": "DEMO"
}

401

Section titled “401”

Missing, malformed, or unrecognized API key (problem type invalid-key).

Media typeapplication/problem+json

RFC 9457 problem details. Dispatch on the stable type URI (https://api.betflux.ai/problems/*), never on the English title.

object
type
required

Stable problem type URI.

string
title
required

Short human-readable summary.

string
status
required

HTTP status code.

integer
detail

Explanation specific to this occurrence.

string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example"
}

402

Section titled “402”

The key has no entitled tier — subscription lapsed or absent (problem type subscription-required; the body carries an upgrade_url).

Media typeapplication/problem+json

RFC 9457 problem details. Dispatch on the stable type URI (https://api.betflux.ai/problems/*), never on the English title.

object
type
required

Stable problem type URI.

string
title
required

Short human-readable summary.

string
status
required

HTTP status code.

integer
detail

Explanation specific to this occurrence.

string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example"
}

403

Section titled “403”

API key revoked or suspended (problem type key-disabled), or the requested range exceeds the tier’s history window (history-restricted).

Media typeapplication/problem+json

RFC 9457 problem details. Dispatch on the stable type URI (https://api.betflux.ai/problems/*), never on the English title.

object
type
required

Stable problem type URI.

string
title
required

Short human-readable summary.

string
status
required

HTTP status code.

integer
detail

Explanation specific to this occurrence.

string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example"
}

429

Section titled “429”

Rate limit, monthly row quota, or ops throttle — the problem type distinguishes rate-limited, quota-exhausted, and throttled.

Media typeapplication/problem+json

RFC 9457 problem details. Dispatch on the stable type URI (https://api.betflux.ai/problems/*), never on the English title.

object
type
required

Stable problem type URI.

string
title
required

Short human-readable summary.

string
status
required

HTTP status code.

integer
detail

Explanation specific to this occurrence.

string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example"
}