Skip to content

feat(api): expose image tool call metadata #3826

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
markstuart-oai wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(api): expose image tool call metadata #3826

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 7 additions & 7 deletions .castiron.stats.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
schema_version: 1
generation_id: c48dfb66-88a5-4465-96d1-0585b9ab8215
openapi_spec_hash: 0ac5ea4ab2546a188a36a0d370367637
openapi_transformed_spec_hash: 6be6c39576ec27111cab26c251d2ab65
config_hash: d92ec885ac2a08b6a4c1ff90420f0327
codegen_sha: 9a9f8502cf7f372b0bc13c052819b78d02991ca5
codegen_hash: 82d1c3235b99cb90187912ae7dd653fba230efd59dbf3c947b6c522a1a801d85
public_codegen_sha: db47bcd202616d35b583b2433270b565be76233a
generation_id: 1670408c-d420-4fc4-a01f-8029bcfddd8f
openapi_spec_hash: 0cb51423f74235e850a5f1961f31c167
openapi_transformed_spec_hash: 70d190d2b54dd216f7280d9fd94363f0
config_hash: d7b82262337a543ff59106e4a32ead4e
codegen_sha: 59cbf1b4a77048cf3aa292025babbbce62d21906
codegen_hash: 4733330f060c261cc079b28b2044c0ef7c7d0adeaa5333a33a121c9c1b2b8b27
public_codegen_sha: 2600257f8c5960d6d1c52ebed8ac8e878ea62e49
1,020 changes: 598 additions & 422 deletions api_reference/openapi.transformed.yml
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions src/openai/resources/admin/organization/audit_logs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ def list(

event_types: Return only events with a `type` in one of these values. For example,
`project.created`. For all options, see the documentation for the
[audit log object](https://platform.openai.com/docs/api-reference/audit-logs/object).
[audit log object](https://developers.openai.com/api/reference/resources/admin/subresources/organization/subresources/audit_logs).

limit: A limit on the number of objects to be returned. Limit can range between 1 and
100, and the default is 20.
Expand Down Expand Up @@ -506,7 +506,7 @@ def list(

event_types: Return only events with a `type` in one of these values. For example,
`project.created`. For all options, see the documentation for the
[audit log object](https://platform.openai.com/docs/api-reference/audit-logs/object).
[audit log object](https://developers.openai.com/api/reference/resources/admin/subresources/organization/subresources/audit_logs).

limit: A limit on the number of objects to be returned. Limit can range between 1 and
100, and the default is 20.
Expand Down
8 changes: 4 additions & 4 deletions src/openai/resources/admin/organization/projects/projects.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,14 +216,14 @@ def create(

geography: Create the project with the specified data residency region. Your organization
must have access to Data residency functionality in order to use. See
[data residency controls](https://platform.openai.com/docs/guides/your-data#data-residency-controls)
[data residency controls](https://developers.openai.com/api/docs/guides/your-data#data-residency-controls)
to review the functionality and limitations of setting this field. Deprecated:
use `residency` instead. Do not provide both `geography` and `residency`.

residency: Create the project with the specified residency configuration. Your organization
must have access to the requested residency configuration in order to use it.
See
[data residency controls](https://platform.openai.com/docs/guides/your-data#data-residency-controls)
[data residency controls](https://developers.openai.com/api/docs/guides/your-data#data-residency-controls)
to review the functionality and limitations of setting this field.

extra_headers: Send extra headers
Expand Down Expand Up @@ -539,14 +539,14 @@ async def create(

geography: Create the project with the specified data residency region. Your organization
must have access to Data residency functionality in order to use. See
[data residency controls](https://platform.openai.com/docs/guides/your-data#data-residency-controls)
[data residency controls](https://developers.openai.com/api/docs/guides/your-data#data-residency-controls)
to review the functionality and limitations of setting this field. Deprecated:
use `residency` instead. Do not provide both `geography` and `residency`.

residency: Create the project with the specified residency configuration. Your organization
must have access to the requested residency configuration in order to use it.
See
[data residency controls](https://platform.openai.com/docs/guides/your-data#data-residency-controls)
[data residency controls](https://developers.openai.com/api/docs/guides/your-data#data-residency-controls)
to review the functionality and limitations of setting this field.

extra_headers: Send extra headers
Expand Down
16 changes: 16 additions & 0 deletions src/openai/resources/admin/organization/projects/service_accounts/service_accounts.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ def create(
*,
name: str,
create_service_account_only: Optional[bool] | Omit = omit,
expires_in_seconds: Optional[int] | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
Expand All @@ -82,6 +83,12 @@ def create(

create_service_account_only: Create the service account without default roles or an API key.

expires_in_seconds: Number of seconds until the initial API key expires. If omitted or null, the key
does not expire unless the effective organization or project policy requires an
expiration. When a policy sets a maximum lifetime, this value must be provided
and must not exceed that limit. A non-null value cannot be used when
`create_service_account_only` is true.

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request
Expand All @@ -98,6 +105,7 @@ def create(
{
"name": name,
"create_service_account_only": create_service_account_only,
"expires_in_seconds": expires_in_seconds,
},
service_account_create_params.ServiceAccountCreateParams,
),
Expand Down Expand Up @@ -345,6 +353,7 @@ async def create(
*,
name: str,
create_service_account_only: Optional[bool] | Omit = omit,
expires_in_seconds: Optional[int] | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
Expand All @@ -362,6 +371,12 @@ async def create(

create_service_account_only: Create the service account without default roles or an API key.

expires_in_seconds: Number of seconds until the initial API key expires. If omitted or null, the key
does not expire unless the effective organization or project policy requires an
expiration. When a policy sets a maximum lifetime, this value must be provided
and must not exceed that limit. A non-null value cannot be used when
`create_service_account_only` is true.

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request
Expand All @@ -378,6 +393,7 @@ async def create(
{
"name": name,
"create_service_account_only": create_service_account_only,
"expires_in_seconds": expires_in_seconds,
},
service_account_create_params.ServiceAccountCreateParams,
),
Expand Down
10 changes: 6 additions & 4 deletions src/openai/resources/audio/speech.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,15 +73,16 @@ def create(
input: The text to generate audio for. The maximum length is 4096 characters.

model:
One of the available [TTS models](https://platform.openai.com/docs/models#tts):
One of the available
[TTS models](https://developers.openai.com/api/docs/guides/text-to-speech):
`tts-1`, `tts-1-hd`, `gpt-4o-mini-tts`, or `gpt-4o-mini-tts-2025-12-15`.

voice: The voice to use when generating the audio. Supported built-in voices are
`alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`, `onyx`, `nova`, `sage`,
`shimmer`, `verse`, `marin`, and `cedar`. You may also provide a custom voice
object with an `id`, for example `{ "id": "voice_1234" }`. Previews of the
voices are available in the
[Text to speech guide](https://platform.openai.com/docs/guides/text-to-speech#voice-options).
[Text to speech guide](https://developers.openai.com/api/docs/guides/text-to-speech#voice-options).

instructions: Control the voice of your generated audio with additional instructions. Does not
work with `tts-1` or `tts-1-hd`.
Expand Down Expand Up @@ -177,15 +178,16 @@ async def create(
input: The text to generate audio for. The maximum length is 4096 characters.

model:
One of the available [TTS models](https://platform.openai.com/docs/models#tts):
One of the available
[TTS models](https://developers.openai.com/api/docs/guides/text-to-speech):
`tts-1`, `tts-1-hd`, `gpt-4o-mini-tts`, or `gpt-4o-mini-tts-2025-12-15`.

voice: The voice to use when generating the audio. Supported built-in voices are
`alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`, `onyx`, `nova`, `sage`,
`shimmer`, `verse`, `marin`, and `cedar`. You may also provide a custom voice
object with an `id`, for example `{ "id": "voice_1234" }`. Previews of the
voices are available in the
[Text to speech guide](https://platform.openai.com/docs/guides/text-to-speech#voice-options).
[Text to speech guide](https://developers.openai.com/api/docs/guides/text-to-speech#voice-options).

instructions: Control the voice of your generated audio with additional instructions. Does not
work with `tts-1` or `tts-1-hd`.
Expand Down
24 changes: 12 additions & 12 deletions src/openai/resources/audio/transcriptions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ def create(

prompt: An optional text to guide the model's style or continue a previous audio
segment. The
[prompt](https://platform.openai.com/docs/guides/speech-to-text#prompting)
[prompt](https://developers.openai.com/api/docs/guides/speech-to-text#prompting)
should match the audio language.

response_format: The format of the output, in one of these options: `json`, `text`, `srt`,
Expand All @@ -139,7 +139,7 @@ def create(
generated using
[server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
See the
[Streaming section of the Speech-to-Text guide](https://platform.openai.com/docs/guides/speech-to-text?lang=curl#streaming-transcriptions)
[Streaming section of the Speech-to-Text guide](https://developers.openai.com/api/docs/guides/speech-to-text?lang=curl#streaming)
for more information.

Note: Streaming is not supported for the `whisper-1` model and will be ignored.
Expand Down Expand Up @@ -276,7 +276,7 @@ def create(
generated using
[server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
See the
[Streaming section of the Speech-to-Text guide](https://platform.openai.com/docs/guides/speech-to-text?lang=curl#streaming-transcriptions)
[Streaming section of the Speech-to-Text guide](https://developers.openai.com/api/docs/guides/speech-to-text?lang=curl#streaming)
for more information.

Note: Streaming is not supported for the `whisper-1` model and will be ignored.
Expand Down Expand Up @@ -318,7 +318,7 @@ def create(

prompt: An optional text to guide the model's style or continue a previous audio
segment. The
[prompt](https://platform.openai.com/docs/guides/speech-to-text#prompting)
[prompt](https://developers.openai.com/api/docs/guides/speech-to-text#prompting)
should match the audio language. This field is not supported when using
`gpt-4o-transcribe-diarize`.

Expand Down Expand Up @@ -397,7 +397,7 @@ def create(
generated using
[server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
See the
[Streaming section of the Speech-to-Text guide](https://platform.openai.com/docs/guides/speech-to-text?lang=curl#streaming-transcriptions)
[Streaming section of the Speech-to-Text guide](https://developers.openai.com/api/docs/guides/speech-to-text?lang=curl#streaming)
for more information.

Note: Streaming is not supported for the `whisper-1` model and will be ignored.
Expand Down Expand Up @@ -439,7 +439,7 @@ def create(

prompt: An optional text to guide the model's style or continue a previous audio
segment. The
[prompt](https://platform.openai.com/docs/guides/speech-to-text#prompting)
[prompt](https://developers.openai.com/api/docs/guides/speech-to-text#prompting)
should match the audio language. This field is not supported when using
`gpt-4o-transcribe-diarize`.

Expand Down Expand Up @@ -644,7 +644,7 @@ async def create(

prompt: An optional text to guide the model's style or continue a previous audio
segment. The
[prompt](https://platform.openai.com/docs/guides/speech-to-text#prompting)
[prompt](https://developers.openai.com/api/docs/guides/speech-to-text#prompting)
should match the audio language. This field is not supported when using
`gpt-4o-transcribe-diarize`.

Expand All @@ -658,7 +658,7 @@ async def create(
generated using
[server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
See the
[Streaming section of the Speech-to-Text guide](https://platform.openai.com/docs/guides/speech-to-text?lang=curl#streaming-transcriptions)
[Streaming section of the Speech-to-Text guide](https://developers.openai.com/api/docs/guides/speech-to-text?lang=curl#streaming)
for more information.

Note: Streaming is not supported for the `whisper-1` model and will be ignored.
Expand Down Expand Up @@ -773,7 +773,7 @@ async def create(
generated using
[server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
See the
[Streaming section of the Speech-to-Text guide](https://platform.openai.com/docs/guides/speech-to-text?lang=curl#streaming-transcriptions)
[Streaming section of the Speech-to-Text guide](https://developers.openai.com/api/docs/guides/speech-to-text?lang=curl#streaming)
for more information.

Note: Streaming is not supported for the `whisper-1` model and will be ignored.
Expand Down Expand Up @@ -815,7 +815,7 @@ async def create(

prompt: An optional text to guide the model's style or continue a previous audio
segment. The
[prompt](https://platform.openai.com/docs/guides/speech-to-text#prompting)
[prompt](https://developers.openai.com/api/docs/guides/speech-to-text#prompting)
should match the audio language. This field is not supported when using
`gpt-4o-transcribe-diarize`.

Expand Down Expand Up @@ -894,7 +894,7 @@ async def create(
generated using
[server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
See the
[Streaming section of the Speech-to-Text guide](https://platform.openai.com/docs/guides/speech-to-text?lang=curl#streaming-transcriptions)
[Streaming section of the Speech-to-Text guide](https://developers.openai.com/api/docs/guides/speech-to-text?lang=curl#streaming)
for more information.

Note: Streaming is not supported for the `whisper-1` model and will be ignored.
Expand Down Expand Up @@ -936,7 +936,7 @@ async def create(

prompt: An optional text to guide the model's style or continue a previous audio
segment. The
[prompt](https://platform.openai.com/docs/guides/speech-to-text#prompting)
[prompt](https://developers.openai.com/api/docs/guides/speech-to-text#prompting)
should match the audio language. This field is not supported when using
`gpt-4o-transcribe-diarize`.

Expand Down
4 changes: 2 additions & 2 deletions src/openai/resources/audio/translations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ def create(

prompt: An optional text to guide the model's style or continue a previous audio
segment. The
[prompt](https://platform.openai.com/docs/guides/speech-to-text#prompting)
[prompt](https://developers.openai.com/api/docs/guides/speech-to-text#prompting)
should be in English.

response_format: The format of the output, in one of these options: `json`, `text`, `srt`,
Expand Down Expand Up @@ -282,7 +282,7 @@ async def create(

prompt: An optional text to guide the model's style or continue a previous audio
segment. The
[prompt](https://platform.openai.com/docs/guides/speech-to-text#prompting)
[prompt](https://developers.openai.com/api/docs/guides/speech-to-text#prompting)
should be in English.

response_format: The format of the output, in one of these options: `json`, `text`, `srt`,
Expand Down
10 changes: 6 additions & 4 deletions src/openai/resources/batches.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,11 +84,12 @@ def create(

input_file_id: The ID of an uploaded file that contains requests for the new batch.

See [upload file](https://platform.openai.com/docs/api-reference/files/create)
See
[upload file](https://developers.openai.com/api/reference/resources/files/methods/create)
for how to upload a file.

Your input file must be formatted as a
[JSONL file](https://platform.openai.com/docs/api-reference/batch/request-input),
[JSONL file](https://developers.openai.com/api/docs/guides/batch#1-prepare-your-batch-file),
and must be uploaded with the purpose `batch`. The file can contain up to 50,000
requests, and can be up to 200 MB in size.

Expand Down Expand Up @@ -325,11 +326,12 @@ async def create(

input_file_id: The ID of an uploaded file that contains requests for the new batch.

See [upload file](https://platform.openai.com/docs/api-reference/files/create)
See
[upload file](https://developers.openai.com/api/reference/resources/files/methods/create)
for how to upload a file.

Your input file must be formatted as a
[JSONL file](https://platform.openai.com/docs/api-reference/batch/request-input),
[JSONL file](https://developers.openai.com/api/docs/guides/batch#1-prepare-your-batch-file),
and must be uploaded with the purpose `batch`. The file can contain up to 50,000
requests, and can be up to 200 MB in size.

Expand Down
Loading
Loading