Account
Check your plan, your usage and what your key can reach.
On this page
curl -sS "https://data.finks.ai/v1/account" \
-H "Authorization: Bearer $FINKS_API_KEY"Response
- account_idRequired
- alert_thresholdsRequired
Loading
Loading
Check your plan, your usage and what your key can reach.
curl -sS "https://data.finks.ai/v1/account" \
-H "Authorization: Bearer $FINKS_API_KEY"The account's keys. The list is a query against an eventually-consistent secondary index, so a key minted or revoked moments ago may be missing or stale here while authentication, which is strongly consistent, already reflects it.
Whether usage is being counted. Always on: every billable response is recorded a few seconds after it is served, so the usage figures below include all billable usage except the last few seconds.
The account period's label, the shared S4 counter rule: YYYY-MM when the period starts at a UTC 1st 00:00:00 (every calendar account), else its start, YYYY-MM-DDTHH:MM:SSZ.
UTC calendar month, YYYY-MM, that the units usage figures cover.
When the account period ends and the next begins, RFC 3339 UTC: the next UTC month start, or the next anchored boundary. Arithmetic on the period, never a configured cycle length.
First instant of the account period, RFC 3339 UTC.
The ledger-derived credit balance for one unit. A remaining figure requires *both* a configured allowance and a recorded consumption figure. Missing either, this reports which one is missing rather than subtracting from, or into, a number nobody has.
What the ledger says about one account, one unit, one period.
GET /v1/account's research_daily_jobs: today's research jobs against the account's daily cap.
Jobs per UTC day the account's tier allows.
When used resets: the next 00:00 UTC, RFC 3339.
Jobs started today (UTC), the counter POST /v1/research checks: every accepted POST that has not failed (a running or succeeded job); a POST whose page was not served, and a job that ends failed, are not counted.
ISO 3166-1 alpha-2, upper case.
The person's name: 1-200 characters, trimmed, inner whitespace collapsed, no control characters.
The company's name, by name's rules: required for company, null for individual.
GET /v1/account's research_daily_jobs: today's research jobs against the account's daily cap.
Jobs per UTC day the account's tier allows.
When used resets: the next 00:00 UTC, RFC 3339.
Jobs started today (UTC), the counter POST /v1/research checks: every accepted POST that has not failed (a running or succeeded job); a POST whose page was not served, and a job that ends failed, are not counted.
curl -sS "https://data.finks.ai/v1/account/keys" \
-H "Authorization: Bearer $FINKS_API_KEY"The account's keys. The list is a query against an eventually-consistent secondary index, so a key minted or revoked moments ago may be missing or stale here while authentication, which is strongly consistent, already reflects it.
curl -sS "https://data.finks.ai/v1/account/usage" \
-H "Authorization: Bearer $FINKS_API_KEY"The month, YYYY-MM. Default: the current UTC month.
Whether usage is being counted. Always on: every billable response is recorded a few seconds after it is served, so the usage figures below include all billable usage except the last few seconds.
The month, YYYY-MM. Default: the current UTC month.
The ledger-derived credit balance for one unit. A remaining figure requires *both* a configured allowance and a recorded consumption figure. Missing either, this reports which one is missing rather than subtracting from, or into, a number nobody has.
request.invalid, a malformed or repeated periodcurl -sS "https://data.finks.ai/v1/datasets" \
-H "Authorization: Bearer $FINKS_API_KEY"The pools, then the data-block datasets, then the route-only names, each in vocabulary order.
Whether its rows carry an attribution to show with them.
What a vocabulary name is.
The name: a result_types value, an exclude value, a datasets[].name.
Who publishes the data.
The tier the key's account resolves to. Absent when no entitlement can be proven; every granted is then false.
What the ledger says about one account, one unit, one period.