Skip to content

fix(api): clarify audio upload metadata requirements #857

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

Merged
jbeckwith-oai merged 1 commit into from
Aug 11, 2026
+54 −21
Merged

fix(api): clarify audio upload metadata requirements #857

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
8 changes: 4 additions & 4 deletions .castiron.stats.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
schema_version: 1
generation_id: 35daab74-8d4e-4d6f-9c38-c54f7b82e45d
openapi_spec_hash: 8d5c14d02f8cc28de343933fae3a9c28
openapi_transformed_spec_hash: cc042503b90491f4f162ce95fae87c36
generation_id: 8e78be37-d321-40c4-8a75-6a8d344f7616
openapi_spec_hash: 1faf0319c407c6534ef7c381614afbb6
openapi_transformed_spec_hash: 53eff50caa9d18046e4ff0615bc7512d
config_hash: 4617b0962f16d328804312ac81aac630
codegen_sha: 4e53657fc2ec8e3d75183902427cdf95db8462a0
codegen_sha: dd2f9827bb2d421d8a4599a221810f35651e1bc9
3 changes: 2 additions & 1 deletion api_reference/openapi.transformed.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34062,6 +34062,7 @@ components:
file:
description: |
The audio file object (not file name) to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.
The request must include enough format metadata for the file to be identified. We recommend an extension-bearing filename and an appropriate content type.
type: string
x-oaiTypeLabel: file
format: binary
Expand Down Expand Up @@ -34369,7 +34370,7 @@ components:
properties:
file:
description: |
The audio file object (not file name) translate, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.
The audio file object (not file name) translate, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm. The request must include enough format metadata for the file to be identified. We recommend an extension-bearing filename and an appropriate content type.
type: string
x-oaiTypeLabel: file
format: binary
Expand Down
32 changes: 24 additions & 8 deletions ...-core/src/main/kotlin/com/openai/models/audio/transcriptions/TranscriptionCreateParams.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,9 @@ private constructor(

/**
* The audio file object (not file name) to transcribe, in one of these formats: flac, mp3, mp4,
* mpeg, mpga, m4a, ogg, wav, or webm.
* mpeg, mpga, m4a, ogg, wav, or webm. The request must include enough format metadata for the
* file to be identified. We recommend an extension-bearing filename and an appropriate content
* type.
*
* @throws OpenAIInvalidDataException if the JSON field has an unexpected type or is
* unexpectedly missing or null (e.g. if the server responded with an unexpected value).
Expand Down Expand Up @@ -339,7 +341,9 @@ private constructor(

/**
* The audio file object (not file name) to transcribe, in one of these formats: flac, mp3,
* mp4, mpeg, mpga, m4a, ogg, wav, or webm.
* mp4, mpeg, mpga, m4a, ogg, wav, or webm. The request must include enough format metadata
* for the file to be identified. We recommend an extension-bearing filename and an
* appropriate content type.
*/
fun file(file: InputStream) = apply { body.file(file) }

Expand All @@ -354,13 +358,17 @@ private constructor(

/**
* The audio file object (not file name) to transcribe, in one of these formats: flac, mp3,
* mp4, mpeg, mpga, m4a, ogg, wav, or webm.
* mp4, mpeg, mpga, m4a, ogg, wav, or webm. The request must include enough format metadata
* for the file to be identified. We recommend an extension-bearing filename and an
* appropriate content type.
*/
fun file(file: ByteArray) = apply { body.file(file) }

/**
* The audio file object (not file name) to transcribe, in one of these formats: flac, mp3,
* mp4, mpeg, mpga, m4a, ogg, wav, or webm.
* mp4, mpeg, mpga, m4a, ogg, wav, or webm. The request must include enough format metadata
* for the file to be identified. We recommend an extension-bearing filename and an
* appropriate content type.
*/
fun file(path: Path) = apply { body.file(path) }

Expand Down Expand Up @@ -838,7 +846,9 @@ private constructor(

/**
* The audio file object (not file name) to transcribe, in one of these formats: flac, mp3,
* mp4, mpeg, mpga, m4a, ogg, wav, or webm.
* mp4, mpeg, mpga, m4a, ogg, wav, or webm. The request must include enough format metadata
* for the file to be identified. We recommend an extension-bearing filename and an
* appropriate content type.
*
* @throws OpenAIInvalidDataException if the JSON field has an unexpected type or is
* unexpectedly missing or null (e.g. if the server responded with an unexpected value).
Expand Down Expand Up @@ -1168,7 +1178,9 @@ private constructor(

/**
* The audio file object (not file name) to transcribe, in one of these formats: flac,
* mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.
* mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm. The request must include enough format
* metadata for the file to be identified. We recommend an extension-bearing filename
* and an appropriate content type.
*/
fun file(file: InputStream) = file(MultipartField.of(file))

Expand All @@ -1183,13 +1195,17 @@ private constructor(

/**
* The audio file object (not file name) to transcribe, in one of these formats: flac,
* mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.
* mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm. The request must include enough format
* metadata for the file to be identified. We recommend an extension-bearing filename
* and an appropriate content type.
*/
fun file(file: ByteArray) = file(file.inputStream())

/**
* The audio file object (not file name) to transcribe, in one of these formats: flac,
* mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.
* mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm. The request must include enough format
* metadata for the file to be identified. We recommend an extension-bearing filename
* and an appropriate content type.
*/
fun file(path: Path) =
file(
Expand Down
32 changes: 24 additions & 8 deletions ...java-core/src/main/kotlin/com/openai/models/audio/translations/TranslationCreateParams.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,9 @@ private constructor(

/**
* The audio file object (not file name) translate, in one of these formats: flac, mp3, mp4,
* mpeg, mpga, m4a, ogg, wav, or webm.
* mpeg, mpga, m4a, ogg, wav, or webm. The request must include enough format metadata for the
* file to be identified. We recommend an extension-bearing filename and an appropriate content
* type.
*
* @throws OpenAIInvalidDataException if the JSON field has an unexpected type or is
* unexpectedly missing or null (e.g. if the server responded with an unexpected value).
Expand Down Expand Up @@ -173,7 +175,9 @@ private constructor(

/**
* The audio file object (not file name) translate, in one of these formats: flac, mp3, mp4,
* mpeg, mpga, m4a, ogg, wav, or webm.
* mpeg, mpga, m4a, ogg, wav, or webm. The request must include enough format metadata for
* the file to be identified. We recommend an extension-bearing filename and an appropriate
* content type.
*/
fun file(file: InputStream) = apply { body.file(file) }

Expand All @@ -188,13 +192,17 @@ private constructor(

/**
* The audio file object (not file name) translate, in one of these formats: flac, mp3, mp4,
* mpeg, mpga, m4a, ogg, wav, or webm.
* mpeg, mpga, m4a, ogg, wav, or webm. The request must include enough format metadata for
* the file to be identified. We recommend an extension-bearing filename and an appropriate
* content type.
*/
fun file(file: ByteArray) = apply { body.file(file) }

/**
* The audio file object (not file name) translate, in one of these formats: flac, mp3, mp4,
* mpeg, mpga, m4a, ogg, wav, or webm.
* mpeg, mpga, m4a, ogg, wav, or webm. The request must include enough format metadata for
* the file to be identified. We recommend an extension-bearing filename and an appropriate
* content type.
*/
fun file(path: Path) = apply { body.file(path) }

Expand Down Expand Up @@ -439,7 +447,9 @@ private constructor(

/**
* The audio file object (not file name) translate, in one of these formats: flac, mp3, mp4,
* mpeg, mpga, m4a, ogg, wav, or webm.
* mpeg, mpga, m4a, ogg, wav, or webm. The request must include enough format metadata for
* the file to be identified. We recommend an extension-bearing filename and an appropriate
* content type.
*
* @throws OpenAIInvalidDataException if the JSON field has an unexpected type or is
* unexpectedly missing or null (e.g. if the server responded with an unexpected value).
Expand Down Expand Up @@ -576,7 +586,9 @@ private constructor(

/**
* The audio file object (not file name) translate, in one of these formats: flac, mp3,
* mp4, mpeg, mpga, m4a, ogg, wav, or webm.
* mp4, mpeg, mpga, m4a, ogg, wav, or webm. The request must include enough format
* metadata for the file to be identified. We recommend an extension-bearing filename
* and an appropriate content type.
*/
fun file(file: InputStream) = file(MultipartField.of(file))

Expand All @@ -591,13 +603,17 @@ private constructor(

/**
* The audio file object (not file name) translate, in one of these formats: flac, mp3,
* mp4, mpeg, mpga, m4a, ogg, wav, or webm.
* mp4, mpeg, mpga, m4a, ogg, wav, or webm. The request must include enough format
* metadata for the file to be identified. We recommend an extension-bearing filename
* and an appropriate content type.
*/
fun file(file: ByteArray) = file(file.inputStream())

/**
* The audio file object (not file name) translate, in one of these formats: flac, mp3,
* mp4, mpeg, mpga, m4a, ogg, wav, or webm.
* mp4, mpeg, mpga, m4a, ogg, wav, or webm. The request must include enough format
* metadata for the file to be identified. We recommend an extension-bearing filename
* and an appropriate content type.
*/
fun file(path: Path) =
file(
Expand Down
Loading