Update API docs with tier system and rate limit details#88
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Note
Low Risk
Documentation-only updates that clarify API key tiers and rate-limit behavior; low risk aside from potential mismatch if the described headers/endpoint differ from implementation.
Overview
Updates Talent API docs to reflect a two-tier API key model (Free 5,000 req/month vs Enterprise unlimited) and clarifies that new keys default to the free tier with enterprise available via upgrade.
Expands
Rate Limitsdocumentation with tier limits, enforcement behavior (401on limit), monthly reset timing, usage tracking headers for free-tier responses, and a new documentedGET /api_keys/usageendpoint (including example payload). Also tweaks wording inAuthenticationto describe API key permissions and links to the rate-limit details.Written by Cursor Bugbot for commit 30472ad. This will update automatically on new commits. Configure here.