Add Responses API quickstart - #55
Open
georgeatparallel wants to merge 3 commits into
Open
Conversation
georgeatparallel
marked this pull request as ready for review
July 20, 2026 18:08
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.
Our cookbook doesn't have a direct Responses API example. We add a small Python quickstart so developers familiar with the OpenAI SDK can get a cited research answer using only a Parallel API key.
We use the standard SDK with Parallel's base URL, the
parallelmodel and explicitmediumreasoning effort. The script makes oneresponses.createcall per invocation, reads the answer, and deduplicates URL citations into a source list. We fail clearly if the answer or citations are missing instead of adding application-level retries that could create extra billed research calls or hide a broken response contract.We include setup and migration instructions, a locked uv environment, deterministic tests, and cookbook registration. The billed live smoke test requires both an API key and an explicit opt-in flag and makes one
responses.createcall. It checks the company names and URL citations, not the accuracy of the financial figures.Testing: Previously recorded validation:
uv lock --check; seven deterministic tests passed with one live test deselected; the single-call live smoke test passed with seven tests deselected; Ruff format and lint, pre-commit secret and hygiene hooks, and cookbook JSON schema validation passed.