MeResponse
{
"type": "object",
"properties": {
"user_id": {
"type": [
"string",
"null"
],
"description": "Id of the user the API key belongs to."
},
"key_id": {
"type": [
"string",
"null"
],
"description": "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_label": {
"type": [
"string",
"null"
],
"description": "The key name set in the dashboard, or the name of the connected OAuth client. Null when none is known."
},
"credential_kind": {
"type": "string",
"enum": [
"account_key",
"oauth",
"session"
],
"description": "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_masked": {
"type": [
"string",
"null"
],
"description": "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_at": {
"type": "string",
"description": "ISO 8601 time the plan credits reset: 00:00 UTC on the first of next month, on every plan."
},
"account": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the account this request spends: the person's own account, or the team account a key or OAuth token was made in."
},
"name": {
"type": [
"string",
"null"
],
"description": "The team name when the account is a team, else the account holder's name. Null when the account has no name."
},
"kind": {
"type": "string",
"enum": [
"personal",
"team"
],
"description": "team when the account is a team, personal otherwise."
},
"plan": {
"type": "string",
"description": "The account's plan tier, the same value as tier."
}
},
"required": [
"id",
"name",
"kind",
"plan"
],
"description": "The account whose credits and plan this request uses. user_id is the person; this is who pays."
},
"role": {
"type": "string",
"enum": [
"owner",
"admin",
"member"
],
"description": "The person's role on the account: owner of their own account, or admin or member of a team."
},
"tier": {
"type": "string",
"description": "Plan tier, e.g. free, pro, pro_plus, ultra, enterprise."
},
"scopes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Scopes granted to this API key, e.g. read, monitors:write, trackers:write, recommendations:read."
},
"rate_limit": {
"type": "integer",
"description": "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_enabled": {
"type": "boolean",
"description": "True when the plan includes the Recommendations API (commercial intelligence endpoints)."
},
"freshness": {
"allOf": [
{
"$ref": "#/components/schemas/Freshness"
},
{
"type": [
"object",
"null"
],
"description": "Where results stop for this account now: the free plan, and a paid plan past its usage limit, read media after a delay. Dated reads cut their window at served_through and say so. Null when results are current."
}
]
},
"usage": {
"type": "object",
"properties": {
"rows_used": {
"type": "integer",
"description": "Plan credits used this month, in rows (a row is 4 credits): usage.credits.plan.used divided by 4, rounded up."
},
"rows_remaining": {
"type": "integer",
"description": "Credits left from the plan and grants, on-demand excluded, in rows (a row is 4 credits): divided by 4, rounded up."
},
"monthly_rows": {
"type": "integer",
"description": "Plan credits a month, in rows (a row is 4 credits): usage.credits.plan.credits divided by 4 when the plan has a limit."
},
"current_spend_cents": {
"type": "integer",
"description": "On-demand overage spend so far this period, in US cents."
},
"credits": {
"type": "object",
"properties": {
"available": {
"type": [
"integer",
"null"
],
"description": "Credits spendable now: plan, granted, and on-demand up to its cap. Null when nothing limits it."
},
"plan": {
"type": "object",
"properties": {
"credits": {
"type": [
"integer",
"null"
],
"description": "Plan credits this month. Null when the plan has no limit."
},
"used": {
"type": "integer",
"description": "Plan credits spent this month."
},
"resets_at": {
"type": "string",
"description": "YYYY-MM-DD, the first day of next month (UTC), when plan credits reset."
}
},
"required": [
"credits",
"used",
"resets_at"
]
},
"granted": {
"type": "integer",
"description": "Credits left in granted lots that have not expired."
},
"on_demand": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "True when on-demand credits are on."
},
"cap_credits": {
"type": [
"integer",
"null"
],
"description": "The on-demand budget in credits. On-demand usage costs $0.002 a credit, so this is the dollar budget divided by 0.002. Null when uncapped or off."
},
"used": {
"type": "integer",
"description": "On-demand credits spent this month."
}
},
"required": [
"enabled",
"cap_credits",
"used"
]
}
},
"required": [
"available",
"plan",
"granted",
"on_demand"
],
"description": "The month in credits, the primary measure of usage. Every read uses credits from the plan, then the on-demand budget. An included plan credit is valued at $0.001; on-demand usage costs $0.002 a credit. A row is 4 credits. Present only when the credits ledger decides access."
}
},
"required": [
"rows_used",
"rows_remaining",
"monthly_rows",
"current_spend_cents"
]
},
"settings": {
"$ref": "#/components/schemas/AccountSettings"
}
},
"required": [
"user_id",
"key_id",
"key_label",
"credential_kind",
"email_masked",
"period_resets_at",
"account",
"role",
"tier",
"scopes",
"rate_limit",
"recommendations_api_enabled",
"freshness",
"usage",
"settings"
]
}