Document is_free field in router /v1/models API response#2567
Merged
Conversation
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
julien-c
approved these changes
Jun 16, 2026
julien-c
left a comment
julien-c
left a comment
Member
There was a problem hiding this comment.
(for moon-landing) maybe only output it when it's true?
Pierrci
approved these changes
Jun 16, 2026
hanouticelina
approved these changes
Jun 17, 2026
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
5 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 change with no runtime or API behavior impact.
Overview
Documents the optional
is_freeboolean on each provider object returned by the router’s OpenAI-compatibleGET /v1/modelslisting (and single-model lookup).The field indicates when a model is temporarily free on that provider (e.g. promos), and is added to the provider fields table in
hub-api.mdalongsidepricingand other routing metadata.Reviewed by Cursor Bugbot for commit fb55893. Bugbot is set up for automated code reviews on this repo. Configure here.