Current API key context

Available even when the account has exhausted its usage allowance. Returns the credential making the request (key_id, key_label, credential_kind), the masked email of the person, the account whose credits it spends (account: id, name, kind, plan) and the role the person holds on it, the tier, scopes, rate limit, usage with period_resets_at, and account settings. usage.credits is the primary measure: credits from the plan, then the on-demand budget. The row fields restate it at 4 credits a row. settings.transcripts is what a transcript request that names no parameter of its own receives: every key of the account resolves against it.

get/v1/me

Request

Base URL: https://api.arcmira.com
URL: https://api.arcmira.com/v1/me
Auth: HTTP bearer

Response

Success

user_idstring nullable required

Id of the user the API key belongs to.

key_idstring nullable required

Id of the credential making this request: the account key id, or the OAuth token id. Never a secret. Null on a browser session.

key_labelstring nullable required

The key name set in the dashboard, or the name of the connected OAuth client. Null when none is known.

credential_kind'account_key' | 'oauth' | 'session' required

How the request authenticated: account_key is an arc_sk_ key, oauth is a token from a connected client, session is a signed-in browser.

email_maskedstring nullable required

The email of the person calling (user_id), with the local part masked after its first character, e.g. z***@example.com. Null when the person has none.

period_resets_atstring required

ISO 8601 time the plan credits reset: 00:00 UTC on the first of next month, on every plan.

role'owner' | 'admin' | 'member' required

The person's role on the account: owner of their own account, or admin or member of a team.

tierstring required

Plan tier, e.g. free, pro, pro_plus, ultra, enterprise.

scopesstring[] required

Scopes granted to this API key, e.g. read, monitors:write, trackers:write, recommendations:read.

rate_limitinteger required

Requests allowed per 60-second window for this key: 600 for enterprise, 240 for other paid tiers, 60 for free, unless a per-key override is set.

recommendations_api_enabledboolean required

True when the plan includes the Recommendations API (commercial intelligence endpoints).

Changes

No recorded changes to this operation across all 1 revision of this API.