docs: add missing X-API-Key header to curl examples#62
Open
Perfect29 wants to merge 1 commit intosugarlabs:mainfrom
Open
docs: add missing X-API-Key header to curl examples#62Perfect29 wants to merge 1 commit intosugarlabs:mainfrom
Perfect29 wants to merge 1 commit intosugarlabs:mainfrom
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
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.
The curl examples for
/ask,/ask-llm, and/debugin the READMEdon't include the
X-API-Keyheader, but all three endpoints requireit (via the
verify_api_keydependency). Copying these examples as-isreturns a 401 "API key is missing" error.
The
/debugexample also had two issues:context=False?(trailing?) which FastAPI can't parse as aboolean, causing a 422 error
codeparameter contained a natural-language question instead ofactual Python code
Changes:
-H "X-API-Key: sugarai2024"to the/ask,/ask-llm, and/debugcurl examples/debugURL:context=falseand usedprint('hello world')as a realistic code sampleTested locally on macOS by running the original and fixed commands
against
uvicorn main:app.Before (all three return 401):

After (returns 200 with valid response):
