Skip to content

Commit 6bb5142

Browse files
committed
Update API docs with tier system and rate limit details
1 parent c5ab16c commit 6bb5142

File tree

3 files changed

+58
-5
lines changed

3 files changed

+58
-5
lines changed

docs/api-keys.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ description: Manage your Talent API keys.
88

99
# API Keys
1010

11-
API Keys are available exclusively for Talent+ members (5k requests/month).
11+
API Keys are available for Talent+ members. After getting your Talent+ membership on [talent.app](https://talent.app), you can request an API Key [here](https://talent.app/~/settings/api).
1212

13-
After getting your Talent+ membership on [talent.app](https://talent.app), you can request an API Key [here](https://talent.app/~/settings/api).
13+
New API keys are created with the **free** tier by default (5,000 requests/month). For unlimited access, contact us to upgrade to **enterprise**.
1414

1515

docs/talent-api/authentication.mdx

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,16 @@ The API key is the entry point for the Talent API. In order to perform requests
1010

1111
We use the header `X-API-KEY` to retrieve the access key and validate your access to our API.
1212

13-
There're two types of API keys:
13+
There are two types of API key permissions:
1414

1515
- `read_only`: Can only access GET requests
1616
- `write`: Can access all requests
17+
18+
### Tiers
19+
20+
API keys are assigned one of two tiers:
21+
22+
- **Free**: Default tier. Limited to 5,000 requests/month.
23+
- **Enterprise**: Unlimited requests.
24+
25+
See [Rate Limits](/docs/talent-api/rate-limits) for details on usage tracking and headers.

docs/talent-api/rate-limits.mdx

Lines changed: 46 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,53 @@
33

44
# Rate Limits
55

6-
## Rate Limits
6+
## Tiers
77

8-
Talent API usage is limited to 5,000 requests/month.
8+
API keys have two tiers with different usage limits:
9+
10+
| Tier | Monthly Limit | Description |
11+
|------|--------------|-------------|
12+
| **Free** | 5,000 requests | Default tier for all new API keys |
13+
| **Enterprise** | Unlimited | Unlimited access |
14+
15+
- Once the limit is reached, the API will block further requests with a `401` response.
16+
- Usage counters reset automatically at the beginning of each month.
17+
18+
## Usage Headers
19+
20+
Every successful response for **free tier** API keys includes the following headers:
21+
22+
| Header | Description |
23+
|--------|-------------|
24+
| `X-API-Usage-Current` | Number of requests made in the current month |
25+
| `X-API-Usage-Limit` | Monthly request limit (5,000) |
26+
| `X-API-Usage-Status` | Current status: `ok`, `warning`, or `exceeded` |
27+
28+
Enterprise tier keys do not receive these headers.
29+
30+
## Usage Endpoint
31+
32+
You can check your API key's usage details at any time, even if your key has exceeded the limit:
33+
34+
```
35+
GET /api_keys/usage
36+
```
37+
38+
Pass your API key via the `X-API-KEY` header. The response includes:
39+
40+
```json
41+
{
42+
"api_key_id": "uuid",
43+
"tier": "free",
44+
"current_usage": 150,
45+
"limit": 5000,
46+
"usage_status": "ok",
47+
"period": "2026-02",
48+
"resets_at": "2026-03-01T00:00:00Z"
49+
}
50+
```
51+
52+
For enterprise keys, `current_usage` and `limit` will be `null`, and `usage_status` will be `unlimited`.
953

1054
## Fair Use Policy
1155

0 commit comments

Comments
 (0)