Skip to content

docs: clarify response_schema vs response_json_schema #2298

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MukundaKatta wants to merge 2 commits into
base: main
Choose a base branch
from
+6 −1
Open

docs: clarify response_schema vs response_json_schema #2298

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3130f2f
docs: clarify response_schema vs response_json_schema
MukundaKatta Apr 19, 2026
a1b16b5
Merge branch 'main' into codex/clarify-structured-output-schema-docs
MukundaKatta Apr 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -918,6 +918,10 @@ output might be lower in quality.

#### JSON Schema support

Use `response_json_schema` when you want to pass a standard JSON Schema
dictionary directly. If you are passing Python types, Pydantic models, or
other SDK-native schema helpers, use `response_schema` instead.

Schemas can be provided as standard JSON schema.

```python
Expand Down Expand Up @@ -954,7 +958,8 @@ print(response.text)

#### Pydantic Model Schema support

Schemas can be provided as Pydantic Models.
Schemas can also be provided as Python types or Pydantic models through
`response_schema`.

```python
from pydantic import BaseModel
Expand Down