> Finks API docs. Every page: https://finks.ai/llms.txt. The OpenAPI spec: https://finks.ai/docs/openapi.json.

# Account

Check your plan, your usage and what your key can reach.

Base URL: https://data.finks.ai. Send your key as `Authorization: Bearer $FINKS_API_KEY`.

## Account

`GET /v1/account` (#get-v1-account)

Your account and its plan limits.

### Response

- `account_id` (string, required)
- `alert_thresholds` (one of several shapes, required)
- `keys` (one of several shapes, required): 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.
- `metering` (one of several shapes, required): 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.
- `period` (object, required)
- `spend_cap` (one of several shapes, required)
- `units` (array of object, required)
- `agent_search_daily_jobs` (object, required, can be null): `GET /v1/account`'s `research_daily_jobs`: today's research jobs against the account's daily cap.
- `features` (array of object, required)
- `profile` (object, required, can be null)
- `research_daily_jobs` (object, required, can be null): `GET /v1/account`'s `research_daily_jobs`: today's research jobs against the account's daily cap.

### Statuses

- 200: The calling account's state for the current billing period, with its sign-up profile
- 401: Missing, unknown, revoked, or expired key

### Request

```bash
curl -sS "https://data.finks.ai/v1/account" \
  -H "Authorization: Bearer $FINKS_API_KEY"
```

Not metered.

## Keys

`GET /v1/account/keys` (#get-v1-account-keys)

The account's keys, masked, with each one's environment and status.

### Response

- `account_id` (string, required)
- `keys` (one of several shapes, required): 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.

### Statuses

- 200: The calling account's masked keys
- 401: Missing, unknown, revoked, or expired key

### Request

```bash
curl -sS "https://data.finks.ai/v1/account/keys" \
  -H "Authorization: Bearer $FINKS_API_KEY"
```

Not metered.

## Usage

`GET /v1/account/usage` (#get-v1-account-usage)

Usage for one month, the current UTC month by default, per billable unit.

### Parameters

- `period` (string, query, can be null): The month, `YYYY-MM`. Default: the current UTC month.

### Response

- `account_id` (string, required)
- `metering` (one of several shapes, required): 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.
- `period` (object, required): The month, `YYYY-MM`. Default: the current UTC month.
- `units` (array of object, required)

### Statuses

- 200: The calling account's recorded usage for one billing period
- 400: `request.invalid`, a malformed or repeated `period`
- 401: Missing, unknown, revoked, or expired key

### Request

```bash
curl -sS "https://data.finks.ai/v1/account/usage" \
  -H "Authorization: Bearer $FINKS_API_KEY"
```

Not metered.

## Datasets

`GET /v1/datasets` (#get-v1-datasets)

Every dataset Finks serves, with its routes and source, and whether your plan includes it.

### Response

- `results` (array of object, required): The pools, then the data-block datasets, then the route-only names, each in vocabulary order.
- `tier` (string, can be null): The tier the key's account resolves to. Absent when no entitlement can be proven; every `granted` is then `false`.

### Statuses

- 200: Every pool, dataset and route-only name, and whether this key's plan includes it
- 401: Missing, unknown, revoked, or expired key

### Request

```bash
curl -sS "https://data.finks.ai/v1/datasets" \
  -H "Authorization: Bearer $FINKS_API_KEY"
```

Not metered.