Skip to content

Commit 2a76633

Browse files
techpro-aimlapigitbook-bot
authored andcommitted
GITBOOK-552: docs: fix /responses schemas
1 parent d798004 commit 2a76633

11 files changed

Lines changed: 31 additions & 33 deletions

File tree

docs/api-references/text-models-llm/OpenAI/gpt-3.5-turbo.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,8 @@ The _Responses_ API is the newer, unified interface used across OpenAI’s lates
6666

6767
This endpoint is currently used _only_ with OpenAI models. Some models support both the `/chat/completions` and `/responses` endpoints, while others support only one of them.
6868

69-
{% openapi-operation spec="responses-all-models" path="/v1/responses" method="post" %}
70-
[OpenAPI responses-all-models](https://api.aimlapi.com/docs-public-yaml)
69+
{% openapi-operation spec="gpt-3-5-turbo-RESPONSES" path="/v1/responses" method="post" %}
70+
[OpenAPI gpt-3-5-turbo-RESPONSES](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/text-models-llm/OpenAI/gpt-3.5-turbo-RESPONSES.json)
7171
{% endopenapi-operation %}
7272

7373
## Code Example

docs/api-references/text-models-llm/OpenAI/gpt-4-turbo.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,8 @@ The _Responses_ API is the newer, unified interface used across OpenAI’s lates
6464

6565
This endpoint is currently used _only_ with OpenAI models. Some models support both the `/chat/completions` and `/responses` endpoints, while others support only one of them.
6666

67-
{% openapi-operation spec="responses-all-models" path="/v1/responses" method="post" %}
68-
[OpenAPI responses-all-models](https://api.aimlapi.com/docs-public-yaml)
67+
{% openapi-operation spec="gpt-4-turbo-RESPONSES" path="/v1/responses" method="post" %}
68+
[OpenAPI gpt-4-turbo-RESPONSES](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/text-models-llm/OpenAI/gpt-4-turbo-RESPONSES.json)
6969
{% endopenapi-operation %}
7070

7171
## Code Example

docs/api-references/text-models-llm/OpenAI/gpt-4o-mini.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# gpt-4o-mini
22

3-
<table data-header-hidden data-full-width="true"><thead><tr><th width="546.4443969726562" valign="top"></th><th width="202.666748046875" valign="top"></th></tr></thead><tbody><tr><td valign="top"><div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>This documentation is valid for the following list of our models:</p><ul><li><code>gpt-4o-mini</code></li><li><code>gpt-4o-mini-2024-07-18</code></li></ul></div></td><td valign="top"><a href="https://aimlapi.com/app/?model=gpt-4o-mini&#x26;mode=chat" class="button primary">Try in Playground</a></td></tr></tbody></table>
3+
<table data-header-hidden data-full-width="true"><thead><tr><th width="509.11102294921875" valign="top"></th><th width="202.666748046875" valign="top"></th></tr></thead><tbody><tr><td valign="top"><div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>This documentation is valid for the following list of our models:</p><ul><li><code>gpt-4o-mini</code></li><li><code>gpt-4o-mini-2024-07-18</code></li></ul></div></td><td valign="top"><a href="https://aimlapi.com/app/?model=gpt-4o-mini&#x26;mode=chat" class="button primary">Try in Playground</a></td></tr></tbody></table>
44

55
## Model Overview
66

@@ -64,8 +64,8 @@ The _Responses_ API is the newer, unified interface used across OpenAI’s lates
6464

6565
This endpoint is currently used _only_ with OpenAI models. Some models support both the `/chat/completions` and `/responses` endpoints, while others support only one of them.
6666

67-
{% openapi-operation spec="responses-all-models" path="/v1/responses" method="post" %}
68-
[OpenAPI responses-all-models](https://api.aimlapi.com/docs-public-yaml)
67+
{% openapi-operation spec="gpt-4o-mini-RESPONSES" path="/v1/responses" method="post" %}
68+
[OpenAPI gpt-4o-mini-RESPONSES](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/text-models-llm/OpenAI/gpt-4o-mini-RESPONSES.json)
6969
{% endopenapi-operation %}
7070

7171
## Code Example

docs/api-references/text-models-llm/OpenAI/o3-mini.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,8 @@ The _Responses_ API is the newer, unified interface used across OpenAI’s lates
6464

6565
This endpoint is currently used _only_ with OpenAI models. Some models support both the `/chat/completions` and `/responses` endpoints, while others support only one of them.
6666

67-
{% openapi-operation spec="responses-all-models" path="/v1/responses" method="post" %}
68-
[OpenAPI responses-all-models](https://api.aimlapi.com/docs-public-yaml)
67+
{% openapi-operation spec="o3-mini-RESPONSES" path="/v1/responses" method="post" %}
68+
[OpenAPI o3-mini-RESPONSES](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/text-models-llm/OpenAI/o3-mini-RESPONSES.json)
6969
{% endopenapi-operation %}
7070

7171
## Code Example

docs/api-references/text-models-llm/openai/gpt-4.1-mini.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,8 @@ The _Responses_ API is the newer, unified interface used across OpenAI’s lates
6666

6767
This endpoint is currently used _only_ with OpenAI models. Some models support both the `/chat/completions` and `/responses` endpoints, while others support only one of them.
6868

69-
{% openapi-operation spec="responses-all-models" path="/v1/responses" method="post" %}
70-
[OpenAPI responses-all-models](https://api.aimlapi.com/docs-public-yaml)
69+
{% openapi-operation spec="gpt-4-1-mini-RESPONSES" path="/v1/responses" method="post" %}
70+
[OpenAPI gpt-4-1-mini-RESPONSES](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/text-models-llm/OpenAI/gpt-4.1-mini-RESPONSES.json)
7171
{% endopenapi-operation %}
7272

7373
## Code Example

docs/api-references/text-models-llm/openai/gpt-4.1-nano.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,8 @@ The _Responses_ API is the newer, unified interface used across OpenAI’s lates
6666

6767
This endpoint is currently used _only_ with OpenAI models. Some models support both the `/chat/completions` and `/responses` endpoints, while others support only one of them.
6868

69-
{% openapi-operation spec="responses-all-models" path="/v1/responses" method="post" %}
70-
[OpenAPI responses-all-models](https://api.aimlapi.com/docs-public-yaml)
69+
{% openapi-operation spec="gpt-4-1-nano-RESPONSES" path="/v1/responses" method="post" %}
70+
[OpenAPI gpt-4-1-nano-RESPONSES](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/text-models-llm/OpenAI/gpt-4.1-nano-RESPONSES.json)
7171
{% endopenapi-operation %}
7272

7373
## Code Example

docs/api-references/text-models-llm/openai/gpt-4.1.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,8 @@ The _Responses_ API is the newer, unified interface used across OpenAI’s lates
6464

6565
This endpoint is currently used _only_ with OpenAI models. Some models support both the `/chat/completions` and `/responses` endpoints, while others support only one of them.
6666

67-
{% openapi-operation spec="responses-all-models" path="/v1/responses" method="post" %}
68-
[OpenAPI responses-all-models](https://api.aimlapi.com/docs-public-yaml)
67+
{% openapi-operation spec="gpt-4-1-RESPONSES" path="/v1/responses" method="post" %}
68+
[OpenAPI gpt-4-1-RESPONSES](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/text-models-llm/OpenAI/gpt-4.1-RESPONSES.json)
6969
{% endopenapi-operation %}
7070

7171
## Code Example

docs/api-references/text-models-llm/openai/gpt-5-chat.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,8 @@ The _Responses_ API is the newer, unified interface used across OpenAI’s lates
6464

6565
This endpoint is currently used _only_ with OpenAI models. Some models support both the `/chat/completions` and `/responses` endpoints, while others support only one of them.
6666

67-
{% openapi-operation spec="gpt-5-1-RESPONSES" path="/v1/responses" method="post" %}
68-
[OpenAPI gpt-5-1-RESPONSES](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/text-models-llm/OpenAI/gpt-5-1-RESPONSES.json)
67+
{% openapi-operation spec="gpt-5-chat-RESPONSES" path="/v1/responses" method="post" %}
68+
[OpenAPI gpt-5-chat-RESPONSES](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/text-models-llm/OpenAI/gpt-5-chat-RESPONSES.json)
6969
{% endopenapi-operation %}
7070

7171
## Code Example

docs/api-references/text-models-llm/openai/gpt-5-mini.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@ The _Responses_ API is the newer, unified interface used across OpenAI’s lates
6868

6969
This endpoint is currently used _only_ with OpenAI models. Some models support both the `/chat/completions` and `/responses` endpoints, while others support only one of them.
7070

71-
{% openapi-operation spec="responses-all-models" path="/v1/responses" method="post" %}
72-
[OpenAPI responses-all-models](https://api.aimlapi.com/docs-public-yaml)
71+
{% openapi-operation spec="gpt-5-mini-RESPONSES-v2" path="/v1/responses" method="post" %}
72+
[OpenAPI gpt-5-mini-RESPONSES-v2](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/text-models-llm/OpenAI/gpt-5-mini-RESPONSES.json)
7373
{% endopenapi-operation %}
7474

7575
## Code Example

docs/api-references/text-models-llm/openai/gpt-5-pro.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Version of [GPT-5](gpt-5.md) that produces smarter and more precise responses
1919

2020
:digit\_two: **Copy the code example**
2121

22-
At the bottom of this page, you'll find [a code example](gpt-5-pro.md#code-example) that shows how to structure the request. Choose the code snippet in your preferred programming language and copy it into your development environment.
22+
At the bottom of this page, you'll find [a code example](gpt-5-pro.md#code-example-using-responses-endpoint) that shows how to structure the request. Choose the code snippet in your preferred programming language and copy it into your development environment.
2323

2424
:digit\_three: **Modify the code example**
2525

@@ -28,7 +28,7 @@ At the bottom of this page, you'll find [a code example](gpt-5-pro.md#code-examp
2828

2929
:digit\_four: <sup><sub><mark style="background-color:yellow;">**(Optional)**<mark style="background-color:yellow;"><sub></sup>**&#x20;Adjust other optional parameters if needed**
3030

31-
Only `model` and `messages` are required parameters for this model (and we’ve already filled them in for you in the example), but you can include optional parameters if needed to adjust the model’s behavior. Below, you can find the corresponding [API schema](gpt-5-pro.md#api-schemas), which lists all available parameters along with notes on how to use them.
31+
Only `model` and `messages` are required parameters for this model (and we’ve already filled them in for you in the example), but you can include optional parameters if needed to adjust the model’s behavior. Below, you can find the corresponding [API schema](gpt-5-pro.md#api-schema), which lists all available parameters along with notes on how to use them.
3232

3333
:digit\_five: **Run your modified code**
3434

@@ -40,7 +40,11 @@ If you need a more detailed walkthrough for setting up your development environm
4040

4141
</details>
4242

43-
## API Schemas
43+
## API Schema
44+
45+
{% hint style="warning" %}
46+
Note: This model can ONLY be called via the `/responses` endpoint!
47+
{% endhint %}
4448

4549
<details>
4650

@@ -54,21 +58,15 @@ The _Responses_ API is the newer, unified interface used across OpenAI’s lates
5458

5559
</details>
5660

57-
### Chat Completions Endpoint
58-
59-
...
60-
6161
### Responses Endpoint
6262

6363
This endpoint is currently used _only_ with OpenAI models. Some models support both the `/chat/completions` and `/responses` endpoints, while others support only one of them.
6464

65-
{% openapi-operation spec="responses-all-models" path="/v1/responses" method="post" %}
66-
[OpenAPI responses-all-models](https://api.aimlapi.com/docs-public-yaml)
65+
{% openapi-operation spec="gpt-5-pro-RESPONSES" path="/v1/responses" method="post" %}
66+
[OpenAPI gpt-5-pro-RESPONSES](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/text-models-llm/OpenAI/gpt-5-pro-RESPONSES.json)
6767
{% endopenapi-operation %}
6868

69-
## Code Example
70-
71-
## Code Example #2: Using /responses Endpoint
69+
## Code Example: Using /responses Endpoint
7270

7371
{% tabs %}
7472
{% tab title="Python" %}

0 commit comments

Comments
 (0)