Azure OpenAI image and audio REST API reference (2025-04-01-preview)

本文記錄了 Azure OpenAI 2025-04-01-preview 的影像生成與音訊(語音)資料平面推論 REST API 操作。 關於聊天完成、嵌入、助理、回應、向量儲存及所有其他操作,請參閱官方 Azure OpenAI REST API 參考文獻

API 規格

管理與互動 Azure OpenAI 模型與資源分為三大主要 API 介面:

  • 控制平面
  • 資料平面 - 著述
  • 資料平面 - 推論

每個 API 表面/規範都封裝了一組不同的 Azure OpenAI 功能。 每個 API 都有其獨特的預覽版及穩定/一般可用(GA)API 版本。 預覽版目前通常以每月更新為準。

Important

現在有一個新的預覽推論 API。 想了解更多,請參閱我們的 API 生命週期指南

API 最新預覽發布 最新 GA 發行 Specifications Description
控制平面 2025-07-01-preview 2025-06-01 規格檔案 控制平面 API 用於 建立資源模型部署及其他高階資源管理任務等操作。 控制平面也管理像 Azure Resource Manager、Bicep、Terraform 和 Azure CLI 這類功能能做什麼。
資料平面 v1 preview v1 規格檔案 資料平面 API 控制推理與撰寫操作。

驗證

Azure OpenAI 提供兩種認證方法。 你可以使用 API Keys 或 Microsoft Entra ID。

  • API 金鑰認證:此類型驗證中,所有 API 請求必須在 api-key HTTP 標頭中包含 API 金鑰。 快速入門指南提供了如何使用此類認證打電話的指引。

  • Microsoft Entra ID authentication:你可以用 Microsoft Entra tokens 來驗證 API 呼叫。 認證憑證作為標頭包含在請求 Authorization 中。 所提供的標記必須前置 Bearer,例如 Bearer YOUR_AUTH_TOKEN。 你可以閱讀我們關於使用 Microsoft Entra ID 認證的操作指南。

REST API 版本管理

服務 API 會透過 api-version 查詢參數來進行版本控制。 所有版本皆遵循 YYYY -MM-DD 日期結構。 例如:

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2024-06-01

資料平面推論

本文其餘部分將介紹 Azure OpenAI 資料平面推論規範預覽版中的2025-04-01-preview影像與音訊操作。

關於 GA 影像與音訊操作,請參閱 GA 影像與音訊 REST API 參考文獻

轉錄 - 建立

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

將音訊轉錄成輸入語言。

URI 參數

Name In Required 類型 Description
端點 路徑 Yes 字串網址 支援Azure OpenAI 端點(協定與主機名稱,例如:https://aoairesource.openai.azure.com。請將「aoairesource」替換成你的 Azure OpenAI 資源名稱)。 https://{your-resource-name}.openai.azure.com
deployment-id 路徑 Yes 字串
API版本 查詢 Yes 字串

請求標頭

使用基於權杖的認證或 API 金鑰。 建議使用基於憑證的認證來驗證,且更安全。

Name Required 類型 Description
授權 沒錯 字串 範例:Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 產生認證令牌:az account get-access-token --resource https://cognitiveservices.azure.com

類型:oauth2
授權網址: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
範圍: https://ai.azure.com/.default
API金鑰 沒錯 字串 在此輸入 Azure OpenAI API 金鑰

請求主體

Content-Type:multipart/form-data

Name 類型 Description Required 預設值
型號 字串 要用的型號識別碼。 選項為 gpt-4o-transcribegpt-4o-mini-transcribegpt-4o-mini-transcribe-2025-12-15whisper-1gpt-4o-transcribe-diarize和 。 Yes
檔案 字串 要轉錄的音訊檔案物件。 Yes
語言 字串 輸入音訊的語言。 以 ISO-639-1 格式提供輸入語言可提升準確度與延遲。 No
提示 字串 可選文字用來引導模型風格或延續先前的音訊片段。 提示詞應該與音頻語言相符。 No
回應格式 audioResponseFormat 定義輸出格式。 No
溫度 number 取樣溫度介於0到1之間。 像 0.8 這樣的較高值會讓輸出更隨機,而像 0.2 這樣的低值則會讓輸出更聚焦且確定性強。 若設為 0,模型會利用對數機率自動升溫,直到達到某些臨界點為止。 No 0
timestamp_granularities[] 陣列 此轉錄時需填寫的時間戳和細節。 response_format 必須設定 verbose_json 為使用時間戳記的細度。 支持以下選項之一或兩者: word,或 segment。 注意:區段時間戳記不會增加延遲,但產生字時間戳會產生額外的延遲。 No ['segment']

回應

狀態代碼: 200

描述:確定

內容類型 Type 說明
application/json 物件
文字/平文 字串 輸出格式的文字轉錄(當 response_format 為 textvttsrt之一時)。

Examples

範例

從提供的語音資料中取得文字轉錄及相關元資料。

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

回應:狀態代碼:200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

範例

從提供的語音資料中取得文字轉錄及相關元資料。

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

回應:狀態代碼:200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

翻譯 - 創作

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview

將輸入音訊轉錄並翻譯成英文文字。

URI 參數

Name In Required 類型 Description
端點 路徑 Yes 字串網址 支援Azure OpenAI 端點(協定與主機名稱,例如:https://aoairesource.openai.azure.com。請將「aoairesource」替換成你的 Azure OpenAI 資源名稱)。 https://{your-resource-name}.openai.azure.com
deployment-id 路徑 Yes 字串
API版本 查詢 Yes 字串

請求標頭

使用基於權杖的認證或 API 金鑰。 建議使用基於憑證的認證來驗證,且更安全。

Name Required 類型 Description
授權 沒錯 字串 範例:Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 產生認證令牌:az account get-access-token --resource https://cognitiveservices.azure.com

類型:oauth2
授權網址: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
範圍: https://ai.azure.com/.default
API金鑰 沒錯 字串 在此輸入 Azure OpenAI API 金鑰

請求主體

Content-Type:multipart/form-data

Name 類型 Description Required 預設值
檔案 字串 要翻譯的音訊檔案。 Yes
提示 字串 可選文字用來引導模型風格或延續先前的音訊片段。 題目應該是英文。 No
回應格式 audioResponseFormat 定義輸出格式。 No
溫度 number 取樣溫度介於0到1之間。 像 0.8 這樣的較高值會讓輸出更隨機,而像 0.2 這樣的低值則會讓輸出更聚焦且確定性強。 若設為 0,模型會利用對數機率自動升溫,直到達到某些臨界點為止。 No 0

回應

狀態代碼: 200

描述:確定

內容類型 Type 說明
application/json 物件
文字/平文 字串 以輸出格式轉錄文字(當response_format為文字、VTT 或 SRT 格式時)。

Examples

範例

從提供的語音資料中取得英文轉錄文字及相關元資料。

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

回應:狀態代碼:200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

範例

從提供的語音資料中取得英文轉錄文字及相關元資料。

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

回應:狀態代碼:200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

語音 - 創作

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-04-01-preview

從輸入文字產生音訊。

URI 參數

Name In Required 類型 Description
端點 路徑 Yes 字串網址 支援Azure OpenAI 端點(協定與主機名稱,例如:https://aoairesource.openai.azure.com。請將「aoairesource」替換成你的 Azure OpenAI 資源名稱)。 https://{your-resource-name}.openai.azure.com
deployment-id 路徑 Yes 字串
API版本 查詢 Yes 字串

請求標頭

使用基於權杖的認證或 API 金鑰。 建議使用基於憑證的認證來驗證,且更安全。

Name Required 類型 Description
授權 沒錯 字串 範例:Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 產生認證令牌:az account get-access-token --resource https://cognitiveservices.azure.com

類型:oauth2
授權網址: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
範圍: https://ai.azure.com/.default
API金鑰 沒錯 字串 在此輸入 Azure OpenAI API 金鑰

請求主體

Content-Type:multipart/form-data

Name 類型 Description Required 預設值
輸入 字串 合成音訊的文字。 最大長度為 4,096 字元。 Yes
回應格式 列舉 合成音訊的格式。
可能的值:mp3opusaacflacwavpcm
No
速度 number 合成音效的速度。 從 中選擇一個值 0.254.01.0 是預設值。 No 1.0
語音 列舉 用於語音合成的聲音。
可能的值:alloyechofableonyxnovashimmer
Yes

回應

狀態代碼: 200

描述:確定

內容類型 Type 說明
應用程式/八位元組串流 字串

Examples

範例

從提供的文字合成音訊。

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-04-01-preview

{
 "input": "Hi! What are you going to make?",
 "voice": "fable",
 "response_format": "mp3"
}

回應:狀態代碼:200

{
  "body": "101010101"
}

影像生成 - 創建

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-01-preview

根據特定影像生成模型部署,從文字說明產生一批影像

URI 參數

Name In Required 類型 Description
端點 路徑 Yes 字串網址 支援Azure OpenAI 端點(協定與主機名稱,例如:https://aoairesource.openai.azure.com。請將「aoairesource」替換成你的 Azure OpenAI 資源名稱)。 https://{your-resource-name}.openai.azure.com
deployment-id 路徑 Yes 字串
API版本 查詢 Yes 字串

請求標頭

使用基於權杖的認證或 API 金鑰。 建議使用基於憑證的認證來驗證,且更安全。

Name Required 類型 Description
授權 沒錯 字串 範例:Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 產生認證令牌:az account get-access-token --resource https://cognitiveservices.azure.com

類型:oauth2
授權網址: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
範圍: https://ai.azure.com/.default
API金鑰 沒錯 字串 在此輸入 Azure OpenAI API 金鑰

請求主體

Content-Type:application/json

Name 類型 Description Required 預設值
背景 imageBackground 允許設定產生影像背景的透明度。 此參數僅支援 gpt-image-1 系列模型。 No 自動
n 整數 要產生的影像數量。 對於 dall-e-3,僅支援 n=1。 No 1
輸出壓縮 整數 產生影像的壓縮等級(0-100%)。 此參數僅支援帶有 jpeg 輸出格式的 gpt-image-1 系列模型。 No 100
輸出格式 imagesOutputFormat 產生影像回傳的檔案格式。 僅支援 GPT-Image-1 系列機型。 No png
提示 字串 這是想要圖片的文字描述。 GPT-image-1 系列最大長度為 32000 字元,dall-e-3 則為 4000 字元 Yes
部分影像 整數 需要產生的部分影像數量。 此參數用於回傳部分影像的串流回應。 數值必須介於0到3之間。 當設定為 0 時,回應會是單一圖片,在一次串流事件中傳送。 請注意,若完整影像產生速度較快,最終影像可能會在部分影像數量尚未完整生成前傳送。 0
串流 boolean 在串流模式下編輯圖片。 false
品質 imageQuality 所產生的影像品質。 No 自動
回應格式 imagesResponseFormat 產生影像回傳的格式。 這個參數不支援 gpt-image-1-series 模型,因為 -series 模型總是會回傳 base64 編碼的影像。
可能的值: urlb64_json
No 網址
size imageSize 產生的影像大小。 No 自動
樣式 imageStyle 產生的圖片風格。 只支援 DALL-E-3。 No vivid
使用者 字串 一個代表終端使用者的獨特識別碼,有助於監控和偵測濫用行為。 No

回應

狀態代碼: 200

描述:確定

內容類型 Type 說明
application/json generateImagesResponse

狀態代碼: 預設

說明:發生錯誤。

內容類型 Type 說明
application/json dalleErrorResponse

Examples

範例

在提示下創作圖片。

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-01-preview

{
 "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.",
 "n": 1,
 "style": "natural",
 "quality": "standard"
}

回應:狀態代碼:200

{
  "body": {
    "created": 1698342300,
    "data": [
      {
        "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.",
        "prompt_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          },
          "profanity": {
            "detected": false,
            "filtered": false
          },
          "custom_blocklists": {
            "filtered": false,
            "details": []
          }
        },
        "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...",
        "content_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          }
        }
      }
    ]
  }
}

影像生成 - 編輯

POST https://{endpoint}/openai/deployments/{deployment-id}/images/edits?api-version=2025-04-01-preview

在特定 gpt-image-1 模型部署中,從文字說明中編輯圖片

URI 參數

Name In Required 類型 Description
端點 路徑 Yes 字串網址 支援Azure OpenAI 端點(協定與主機名稱,例如:https://aoairesource.openai.azure.com。請將「aoairesource」替換成你的 Azure OpenAI 資源名稱)。 https://{your-resource-name}.openai.azure.com
deployment-id 路徑 Yes 字串
API版本 查詢 Yes 字串

請求標頭

使用基於權杖的認證或 API 金鑰。 建議使用基於憑證的認證來驗證,且更安全。

Name Required 類型 Description
授權 沒錯 字串 範例:Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 產生認證令牌:az account get-access-token --resource https://cognitiveservices.azure.com

類型:oauth2
授權網址: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
範圍: https://ai.azure.com/.default
API金鑰 沒錯 字串 在此輸入 Azure OpenAI API 金鑰

請求主體

Content-Type:multipart/form-data

Name 類型 Description Required 預設值
圖片 字串或陣列 圖片需要編輯。 必須是支援的影像檔案或一組影像陣列。 每張圖片應該是 png 或 jpg 檔案,大小於 50MB。 Yes
輸入精確度 字串 控制模型在匹配輸入影像的風格與特徵(尤其是臉部特徵)時所投入的努力。 此參數僅支援 gpt-image-1 系列模型。 支持與 highlow low
遮罩 字串 另一張圖片的完全透明區域(例如alpha為零)指示圖片應編輯的位置。 若提供多張影像,遮罩會套用在第一張影像上。 必須是有效的 PNG 檔案,大小小於 4MB,且尺寸與圖片相同。 No
n 整數 要產生的影像數量。 必須介於1到10之間。 No 1
提示 字串 這是想要圖片的文字描述。 最大長度為32000字元。 Yes
品質 imageQuality 所產生的影像品質。 No 自動
部分影像 需要產生的部分影像數量。 此參數用於回傳部分影像的串流回應。 數值必須介於0到3之間。 當設定為 0 時,回應會是單一圖片,在一次串流事件中傳送。 請注意,若完整影像產生速度較快,最終影像可能會在部分影像數量尚未完整生成前傳送。
串流 boolean 在串流模式下編輯圖片。 false
回應格式 imagesResponseFormat 產生影像回傳的格式。 No 網址
size imageSize 產生的影像大小。 No 自動
使用者 字串 一個代表終端使用者的獨特識別碼,有助於監控和偵測濫用行為。 No

回應

狀態代碼: 200

描述:確定

內容類型 Type 說明
application/json generateImagesResponse

狀態代碼: 預設

說明:發生錯誤。

內容類型 Type 說明
application/json dalleErrorResponse

組成部分

關於聊天、補全、嵌入、回應及其他文字操作所使用的結構定義,請參見 Azure OpenAI REST API 參考文獻。 以下結構支援本頁的影像與音訊操作。

innerErrorCode

內部錯誤物件的錯誤代碼。

房產 價值
說明 內部錯誤物件的錯誤代碼。
Type 字串
價值 ResponsibleAIPolicyViolation

dalleErrorResponse

Name 類型 Description Required 預設值
錯誤 dalleError No

dalleError

Name 類型 Description Required 預設值
inner_error dalleInnerError 內部錯誤加上額外細節。 No
param 字串 No
型別 字串 No

dalleInnerError

內部錯誤加上額外細節。

Name 類型 Description Required 預設值
字碼 innerErrorCode 內部錯誤物件的錯誤代碼。 No
content_filter_results dalleFilterResults 關於內容過濾類別(仇恨、性、暴力、self_harm)、是否已被偵測到,以及嚴重程度等級(very_low、低、中、高,決定有害內容的強度與風險等級),以及是否已被過濾。 關於越獄內容與髒話的資訊,是否被偵測到,以及是否被過濾。 還有關於客戶封鎖名單的資訊(如果已經過濾過的話)以及它的識別碼。 No
revised_prompt 字串 如果提示有任何修改,就是用來產生圖片的提示。 No

contentFilterSeverityResult

Name 類型 Description Required 預設值
過濾 boolean Yes
嚴重程度 字串 No

contentFilterDetectedResult

Name 類型 Description Required 預設值
detected boolean No
過濾 boolean Yes

contentFilterDetailedResults

內容過濾會顯示被篩選區段的內容過濾 ID 細節。

Name 類型 Description Required 預設值
details 陣列 No
過濾 boolean Yes

dalleFilterResults

關於內容過濾類別(仇恨、性、暴力、self_harm)、是否已被偵測到,以及嚴重程度等級(very_low、低、中、高,決定有害內容的強度與風險等級),以及是否已被過濾。 關於越獄內容與髒話的資訊,是否被偵測到,以及是否被過濾。 還有關於客戶封鎖名單的資訊(如果已經過濾過的話)以及它的識別碼。

Name 類型 Description Required 預設值
custom_blocklists contentFilterDetailedResults 內容過濾會顯示被篩選區段的內容過濾 ID 細節。 No
仇恨 內容過濾嚴重程度結果 No
越獄 內容過濾檢測結果 No
髒話 內容過濾檢測結果 No
self_harm 內容過濾嚴重程度結果 No
性方面 內容過濾嚴重程度結果 No
暴力 內容過濾嚴重程度結果 No

audioResponseFormat

定義輸出格式。

房產 價值
說明 定義輸出格式。
Type 字串
價值 json
text
srt
verbose_json
vtt

imageQuality

所產生的影像品質。

房產 價值
說明 所產生的影像品質。
Type 字串
預設值 自動
價值 auto
high
medium
low
hd
standard

imagesResponseFormat

產生影像回傳的格式。

房產 價值
說明 產生影像回傳的格式。
Type 字串
預設值 網址
價值 url
b64_json

imagesOutputFormat

產生影像回傳的檔案格式。 僅支援系列機型。

房產 價值
說明 產生影像回傳的檔案格式。 僅支援 GPT-Image-1 系列機型。
Type 字串
預設值 png
價值 png
jpeg

imageSize

產生的影像大小。

房產 價值
說明 產生的影像大小。
Type 字串
預設值 自動
價值 auto
1792x1024
1024x1792
1024x1024
1024x1536
1536x1024

imageStyle

產生的圖片風格。 只支援 DALL-E-3。

房產 價值
說明 產生的圖片風格。 只支援 DALL-E-3。
Type 字串
預設值 vivid
價值 vivid
natural

imageBackground

允許設定產生影像背景的透明度。 此參數僅支援 gpt-image-1 系列模型。

房產 價值
說明 允許設定產生影像背景的透明度。 此參數僅支援 gpt-image-1 系列模型。
Type 字串
預設值 自動
價值 transparent
opaque
auto

generateImagesResponse

Name 類型 Description Required 預設值
創造 整數 Unix 的時間戳記是該操作建立的時刻。 Yes
資料 陣列 操作成功時,該操作的結果資料 Yes
使用方式 imageGenerationsUsage 代表影像生成請求的代幣使用細節。 僅限於 gpt-image-1 系列機型。 No

imageGenerationsUsage

代表影像生成請求的代幣使用細節。 僅限於 gpt-image-1 系列機型。

Name 類型 Description Required 預設值
input_tokens 整數 輸入標記的數量。 No
input_tokens_details 物件 輸入標記的詳細解析。 No
└─ 圖像標記 整數 圖片代幣的數量。 No
└─ 文字標記符號 整數 文字標記的數量。 No
output_tokens 整數 輸出代幣的數量。 No
total_tokens 整數 所使用的代幣總數。 No

下一步

學習 模型與 REST API 的微調。 深入了解驅動 OpenAI 的底層模型Azure。