Repository navigation
Document the Responses API with usage and limitations - #580
Open
sabrinaaquino wants to merge 2 commits into
Open
sabrinaaquino wants to merge 2 commits into
sabrinaaquino wants to merge 2 commits into
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
This branch was successfully deployed
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
1 participant
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.
Adds a proper guide for
POST /responsesand a reference page for it. Before this, the only docs were the raw spec, so nothing told you what actually works.What's new
guides/features/responses-api: when to pick Responses over Chat Completions, a quick start (cURL, Python, JS), how to run multi-turn and tool loops without stored state, streaming events, supported parameters, and a limitations table with a workaround for each itemapi-reference/endpoint/responses/create: the endpoint reference, rendered from the spec, with a short alpha warning that links to the limitationsllms.txtentry now point to the guideHow the limitations were checked
Each one was tested against prod
/api/v1/responsesor read from the current outerface translator:instructionsignored,text.formatignored,store/previous_response_idignored, Venice system prompt on by default, OpenAI-styletool_choicereturns 400,input_filereturns 400,detail: "original"returns 400, E2EE returns 400.The native OpenAI lane from outerface #11213 is left out on purpose until it ships. The guide will need an update when it does.