Azure OpenAI image， audio， and video REST API reference （v1 preview）

本文記錄了 Azure OpenAI v1 預覽版中影像、音訊（語音）及視訊資料生成平面推論 REST API 操作。關於聊天完成、嵌入、評估、檔案、微調、回應、向量存儲及所有其他操作，請參閱官方 Azure OpenAI REST API 參考文獻。

資料平面推論

本文其餘部分將涵蓋 Azure OpenAI 資料平面推論規範新版本 v1 預覽 API 版本中的影像、音訊與視訊操作。欲了解更多資訊，請參閱 API 生命週期指南。

關於完整的 v1 GA 資料平面 API，請參閱官方 Azure OpenAI REST API 參考文獻。

生成語音

POST {endpoint}/openai/v1/audio/speech?api-version=preview

從輸入文字產生文字轉語音音訊。

URI 參數

Name	In	Required	類型	Description
端點	路徑	Yes	字串網址	支援Azure OpenAI 端點（協定與主機名稱，例如：`https://aoairesource.openai.azure.com`。請將「aoairesource」替換成你的 Azure OpenAI 資源名稱）。 https://{your-resource-name}.openai.azure.com
API版本	查詢	No		此請求使用明確的 Microsoft Foundry 模型 API 版本。 `v1` 若未另行說明。

請求標頭

使用基於權杖的認證或 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	預設值
輸入	字串	要產生音訊的文字。最大長度為 4096 字元。	Yes
說明	字串	用額外指示控制你產生的音訊聲音。與或不相容`tts-1tts-1-hd`。	No
型號	字串	此文字轉語音請求的模型。	Yes
回應格式	物件	支援的文字轉語音音訊輸出格式。	No
速度	number	生成音訊的語音速度。數值有效範圍為 0.25 至 4.0，預設值為 1.0，較高則表示語音速度較快。	No	1
stream_format	列舉	音訊串流格式。支援的格式為 `sse` 和 `audio`。 `sse` 不支援 `tts-1` 或 `tts-1-hd`。可能的值： `sse`， `audio`	No
語音	物件		Yes

回應

狀態代碼： 200

說明：請求已成功。

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

狀態代碼： 預設

描述：一個意外的錯誤回應。

內容類型	Type	說明
application/json	AzureErrorResponse

Examples

範例

從提供的文字合成音訊。

POST {endpoint}/openai/v1/audio/speech?api-version=preview

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

回應：狀態代碼：200

{
  "body": "101010101"
}

建立轉錄

POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview

將音訊轉錄成輸入語言。

URI 參數

Name	In	Required	類型	Description
端點	路徑	Yes	字串網址	支援Azure OpenAI 端點（協定與主機名稱，例如：`https://aoairesource.openai.azure.com`。請將「aoairesource」替換成你的 Azure OpenAI 資源名稱）。 https://{your-resource-name}.openai.azure.com
API版本	查詢	No		此請求使用明確的 Foundry Models API 版本。 `v1` 若未另行說明。

請求標頭

使用基於權杖的認證或 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	預設值
chunking_strategy	物件		No
└─ prefix_padding_ms (前綴填充毫秒)	整數	VAD 偵測語音前需要包含的音訊量（以毫秒計）。	No	300
└─ silence_duration_ms（靜音持續時間，以毫秒為單位）	整數	靜默持續時間以偵測語音停止（以毫秒計）。當數值較短時，模型會反應更快，但可能會在使用者短暫停頓時介入。	No	200
‧---- 臨界值	number	語音活動偵測的靈敏度閾值（0.0 到 1.0）。較高的門檻需要較大聲的聲音來啟動模型，因此在嘈雜環境中表現可能更好。	No	0.5
\---- 類型	列舉	必須設定為才能 `server_vad` 啟用伺服器端 VAD 手動分塊。可能的數值： `server_vad`	No
檔案	字串		Yes
filename	字串	可選的檔案名稱或描述性識別碼，用於與音訊資料關聯。	No
include[]	陣列	轉錄回應中需包含的額外資訊。 `logprobs` 會回傳回應中代幣的對數機率，以了解模型對轉錄的信心度。 `logprobs` 僅在response_format 設定為且 `json` 僅適用於 `gpt-4o-transcribe`、 `gpt-4o-transcribe-diarize`、 `gpt-4o-mini-transcribe`和 `gpt-4o-mini-transcribe-2025-12-15`。	No
語言	字串	輸入音訊的語言。以 ISO-639-1 （例如 `en`）格式提供輸入語言，將提升準確度與延遲。	No
型號	字串	本次轉錄請求的模型。	No
提示	字串	可選文字用來引導模型風格或延續先前的音訊片段。提示詞應該與音頻語言相符。	No
回應格式	物件		No
串流	boolean	若設定為 true，模型回應資料會在透過伺服器發送事件產生時串流給用戶端。注意：本 `whisper-1` 模型不支援串流功能，將被忽略。	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	AzureAudioTranscriptionResponse
文字/平文	字串

狀態代碼： 預設

描述：一個意外的錯誤回應。

內容類型	Type	說明
application/json	AzureErrorResponse

Examples

範例

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

POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview

{
 "file": "<binary audio data>",
 "model": "whisper-1",
 "response_format": "text"
}

回應：狀態代碼：200

{
  "body": "plain text when requesting text, srt, or vtt"
}

建立翻譯

POST {endpoint}/openai/v1/audio/translations?api-version=preview

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

URI 參數

Name	In	Required	類型	Description
端點	路徑	Yes	字串網址	支援Azure OpenAI 端點（協定與主機名稱，例如：`https://aoairesource.openai.azure.com`。請將「aoairesource」替換成你的 Azure OpenAI 資源名稱）。 https://{your-resource-name}.openai.azure.com
API版本	查詢	No		此請求使用明確的 Foundry Models API 版本。 `v1` 若未另行說明。

請求標頭

使用基於權杖的認證或 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
filename	字串	可選的檔名或描述性識別碼，用於與音訊資料關聯	No
型號	字串	此翻譯請求所採用的模型。	No
提示	字串	可選文字用來引導模型風格或延續先前的音訊片段。題目應該是英文。	No
回應格式	物件		No
溫度	number	取樣溫度介於0到1之間。像 0.8 這樣的較高值會讓輸出更隨機，而像 0.2 這樣的低值則會讓輸出更聚焦且確定性強。若設為 0，模型會利用對數機率自動升溫，直到達到特定閾值。	No	0

回應

狀態代碼： 200

說明：請求已成功。

內容類型	Type	說明
application/json	AzureAudioTranslationResponse
文字/平文	字串

狀態代碼： 預設

描述：一個意外的錯誤回應。

內容類型	Type	說明
application/json	AzureErrorResponse

Examples

範例

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

POST {endpoint}/openai/v1/audio/translations?api-version=preview

{
 "file": "<binary audio data>",
 "model": "whisper-1",
 "response_format": "text"
}

回應：狀態代碼：200

{
  "body": "plain text when requesting text, srt, or vtt"
}

建立圖片編輯

POST {endpoint}/openai/v1/images/edits?api-version=preview

URI 參數

Name	In	Required	類型	Description
端點	路徑	Yes	字串網址	支援Azure OpenAI 端點（協定與主機名稱，例如：`https://aoairesource.openai.azure.com`。請將「aoairesource」替換成你的 Azure OpenAI 資源名稱）。 https://{your-resource-name}.openai.azure.com
API版本	查詢	No		此請求使用明確的 Foundry Models API 版本。 `v1` 若未另行說明。

請求標頭

使用基於權杖的認證或 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-image-1` 。必須是 `transparent`、或 `opaqueauto` （預設值）之一。使用時 `auto` ，模型會自動決定影像的最佳背景。如果 `transparent`，輸出格式需要支援透明，因此應設定為 `png` （預設值）或 `webp`。可能的值： `transparent`， `opaque`， `auto`	No
圖片	字串或陣列		Yes
遮罩	字串		No
型號	字串	用於影像編輯操作的模型部署。	Yes
n	整數	要產生的影像數量。必須介於1到10之間。	No	1
輸出壓縮	整數	產生影像的壓縮等級（0-100%）。此參數僅支援 `gpt-image-1`輸出格式為 `webpjpeg` or 的 -series 模型，預設為 100。	No	100
輸出格式	列舉	產生影像回傳的格式。此參數僅支援 `gpt-image-1`-級數模型。必須是其中之一`png`、或`jpegwebp`。預設值為 `png`。可能的值： `png`， `jpeg`， `webp`	No
提示	字串	這是想要圖片的文字描述。最大長度為 1000 字元（對 `dall-e-2`，）為，而 -系列模型則 `gpt-image-1`為 32000 字元。	Yes
品質	列舉	所產生的影像品質。 `high` `medium` `low`且僅支援 `gpt-image-1`-系列模型。 `dall-e-2` 只支援 `standard` 品質。預設為 `auto`。可能的值：`standard`， `low`， `mediumhighauto`	No
回應格式	列舉	產生影像回傳的格式。必須是其中 `url` 之一或 `b64_json`。網址在圖片產生後僅有效 60 分鐘。此參數僅支援 `dall-e-2`，因為 `gpt-image-1`-系列模型總是會回傳 base64 編碼的影像。可能的值： `url`， `b64_json`	No
size	列舉	產生的影像大小。對於 -系列模型，必須是、、（直向）、 `1024x1024` 或`1536x1024`（預設值）`1024x1536`中的一個`auto`，`gpt-image-1256x256512x512`對於 `1024x1024`。 `dall-e-2` 可能的值：`256x256`， `512x512`， `1024x10241536x10241024x1536auto`	No
使用者	字串	一個代表最終使用者的獨特識別碼，有助於 OpenAI 監控並偵測濫用行為。	No

回應

狀態代碼： 200

說明：請求已成功。

內容類型	Type	說明
application/json	AzureImagesResponse

狀態代碼： 預設

描述：一個意外的錯誤回應。

內容類型	Type	說明
application/json	AzureErrorResponse

Createimage（創建圖像）

POST {endpoint}/openai/v1/images/generations?api-version=preview

URI 參數

Name	In	Required	類型	Description
端點	路徑	Yes	字串網址	支援Azure OpenAI 端點（協定與主機名稱，例如：`https://aoairesource.openai.azure.com`。請將「aoairesource」替換成你的 Azure OpenAI 資源名稱）。 https://{your-resource-name}.openai.azure.com
API版本	查詢	No		此請求使用明確的 Foundry Models API 版本。 `v1` 若未另行說明。

請求標頭

使用基於權杖的認證或 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	預設值
背景	列舉	允許設定產生影像背景的透明度。此參數僅支援模型 `gpt-image-1` 。必須是 `transparent`、或 `opaqueauto` （預設值）之一。使用時 `auto` ，模型會自動決定影像的最佳背景。如果 `transparent`，輸出格式需要支援透明，因此應設定為 `png` （預設值）或 `webp`。可能的值： `transparent`， `opaque`， `auto`	No
型號	字串	用於影像生成的模型部署。	Yes
節制	列舉	控制由 `gpt-image-1`-系列模型產生的影像內容審核等級。必須是 `low` 為了較寬鬆的過濾，或 `auto` 是（預設值）。可能的值： `low`， `auto`	No
n	整數	要產生的影像數量。必須介於1到10之間。對於 `dall-e-3`，只有 `n=1` 是支持的。	No	1
輸出壓縮	整數	產生影像的壓縮等級（0-100%）。此參數僅支援 `gpt-image-1`輸出格式為 `webpjpeg` or 的 -series 模型，預設為 100。	No	100
輸出格式	列舉	產生影像回傳的格式。此參數僅支援 `gpt-image-1`-級數模型。必須是其中之一`png`、或`jpegwebp`。可能的值： `png`， `jpeg`， `webp`	No
提示	字串	這是想要圖片的文字描述。最大長度為 -系列模型 32000 字元`gpt-image-1`，系列 1000 字元`dall-e-2`，4000 字元。`dall-e-3`	Yes
品質	列舉	所產生的影像品質。 - `auto` （預設值）會自動選擇該模型的最佳品質。 - `high` `medium`，並`low`支援於 `gpt-image-1`-系列模型。 - `hd`且 `standard` 都被支援。`dall-e-3` - `standard`是的唯一選項。`dall-e-2` 可能的值：`standard`， `hd`， `lowmediumhighauto`	No
回應格式	列舉	產生與的`dall-e-2dall-e-3`影像格式。必須是其中 `url` 之一或 `b64_json`。網址在圖片產生後僅有效 60 分鐘。這個參數不支援 `gpt-image-1`-series 模型，因為 -series 模型總是會回傳 base64 編碼的影像。可能的值： `url`， `b64_json`	No
size	列舉	產生的影像大小。對於 -系列模型，必須是、（橫向）、 `1024x1024` （直向）或`1536x1024`（預設值）`1024x1536`中的一個`auto`，對於 `gpt-image-1256x256512x5121024x1024dall-e-21024x10241792x10241024x1792`，或為。 `dall-e-3` 可能的值：`auto`，， `1024x1024`， `1536x10241024x1536256x256512x5121792x10241024x1792`	No
樣式	列舉	產生的圖片風格。此參數僅支援於 `dall-e-3`。必須是其中 `vivid` 之一或 `natural`。鮮明讓模型傾向於產生超真實且戲劇性的影像。自然會讓模型產生更自然、較不過度寫實的影像。可能的值： `vivid`， `natural`	No
使用者	字串	一個代表最終使用者的獨特識別碼，有助於 OpenAI 監控並偵測濫用行為。	No

回應

狀態代碼： 200

說明：請求已成功。

內容類型	Type	說明
application/json	AzureImagesResponse

狀態代碼： 預設

描述：一個意外的錯誤回應。

內容類型	Type	說明
application/json	AzureErrorResponse

Examples

範例

在提示下創作圖片。

POST {endpoint}/openai/v1/images/generations?api-version=preview

{
 "model": "dall-e-3",
 "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
          }
        }
      }
    ]
  }
}

影片製作工作 - Create

POST {endpoint}/openai/v1/video/generations/jobs?api-version=preview

這會創造一個新的影片產生工作。

URI 參數

Name	In	Required	類型	Description
端點	路徑	Yes	字串網址	支援Azure OpenAI 端點（協定與主機名稱，例如：`https://aoairesource.openai.azure.com`。請將「aoairesource」替換成你的 Azure OpenAI 資源名稱）。 https://{your-resource-name}.openai.azure.com
API版本	查詢	No		此請求使用明確的 Foundry Models API 版本。 `v1` 若未另行說明。

請求標頭

使用基於權杖的認證或 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	預設值
height	整數	影片的高度。支援以下尺寸：480x480、854x480、720x720、1280x720、1080x1080 以及 1920x1080，橫向與直立兩種。	Yes
型號	字串	這個請求要用的部署名稱。	Yes
n_seconds	整數	影片產生工作的持續時間。時間必須介於1到20秒之間。	No	5
n_variants	整數	為了這個工作，要製作的影片數量作為變體。必須介於1到5之間。較小的尺寸允許更多變體。	No	1
提示	字串	這個影片製作工作的提示。	Yes
width	整數	影片的寬度。支援以下尺寸：480x480、854x480、720x720、1280x720、1080x1080 以及 1920x1080，橫向與直立兩種。	Yes

請求主體

Content-Type：multipart/form-data

Name	類型	Description	Required	預設值
檔案	陣列		Yes
height	整數	影片的高度。支援以下尺寸：480x480、854x480、720x720、1280x720、1080x1080 以及 1920x1080，橫向與直立兩種。	Yes
inpaint_items	陣列	這是影片製作工作的可選補漆項目。	No
型號	字串	這個請求要用的部署名稱。	Yes
n_seconds	整數	影片產生工作的持續時間。時間必須介於1到20秒之間。	No	5
n_variants	整數	為了這個工作，要製作的影片數量作為變體。必須介於1到5之間。較小的尺寸允許更多變體。	No	1
提示	字串	這個影片製作工作的提示。	Yes
width	整數	影片的寬度。支援以下尺寸：480x480、854x480、720x720、1280x720、1080x1080 以及 1920x1080，橫向與直立兩種。	Yes

回應

狀態代碼： 200

說明：請求已成功。

內容類型	Type	說明
application/json	VideoGenerationJob

狀態代碼： 預設

描述：一個意外的錯誤回應。

內容類型	Type	說明
application/json	AzureOpenAIVideoGenerationErrorResponse

Examples

範例檔案未找到：./examples/create_video_generation_job_simple.json

影片製作工作列表

GET {endpoint}/openai/v1/video/generations/jobs?api-version=preview

列出影片製作相關工作。

URI 參數

Name	In	Required	類型	Description
端點	路徑	Yes	字串網址	支援Azure OpenAI 端點（協定與主機名稱，例如：`https://aoairesource.openai.azure.com`。請將「aoairesource」替換成你的 Azure OpenAI 資源名稱）。 https://{your-resource-name}.openai.azure.com
API版本	查詢	No		此請求使用明確的 Foundry Models API 版本。 `v1` 若未另行說明。
before	查詢	No	字串
後	查詢	No	字串
限制	查詢	Yes	整數
狀態	查詢	No	陣列

請求標頭

使用基於權杖的認證或 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 金鑰

回應

狀態代碼： 200

說明：請求已成功。

內容類型	Type	說明
application/json	VideoGenerationJobList

狀態代碼： 預設

描述：一個意外的錯誤回應。

內容類型	Type	說明
application/json	AzureOpenAIVideoGenerationErrorResponse

Examples

範例檔案未找到：./examples/get_video_generation_job_list.json

影片製作工作 - 取得

GET {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview

取得影片產生工作的屬性。

URI 參數

Name	In	Required	類型	Description
端點	路徑	Yes	字串網址	支援Azure OpenAI 端點（協定與主機名稱，例如：`https://aoairesource.openai.azure.com`。請將「aoairesource」替換成你的 Azure OpenAI 資源名稱）。 https://{your-resource-name}.openai.azure.com
API版本	查詢	No		此請求使用明確的 Foundry Models API 版本。 `v1` 若未另行說明。
job-id	路徑	Yes	字串	用於 Azure OpenAI 請求的影片產生工作 ID。

請求標頭

使用基於權杖的認證或 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 金鑰

回應

狀態代碼： 200

說明：請求已成功。

內容類型	Type	說明
application/json	VideoGenerationJob

狀態代碼： 預設

描述：一個意外的錯誤回應。

內容類型	Type	說明
application/json	AzureOpenAIVideoGenerationErrorResponse

Examples

範例檔案未找到：./examples/get_video_generation_job.json

影片產生工作 - 刪除

DELETE {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview

刪除了一個影片產生的工作。

URI 參數

Name	In	Required	類型	Description
端點	路徑	Yes	字串網址	支援Azure OpenAI 端點（協定與主機名稱，例如：`https://aoairesource.openai.azure.com`。請將「aoairesource」替換成你的 Azure OpenAI 資源名稱）。 https://{your-resource-name}.openai.azure.com
API版本	查詢	No		此請求使用明確的 Foundry Models API 版本。 `v1` 若未另行說明。
job-id	路徑	Yes	字串	用於 Azure OpenAI 請求的影片產生工作 ID。

請求標頭

使用基於權杖的認證或 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 金鑰

回應

狀態代碼： 204

說明：此請求沒有內容可寄送，但標頭可能有用。

狀態代碼： 預設

描述：一個意外的錯誤回應。

內容類型	Type	說明
application/json	AzureOpenAIVideoGenerationErrorResponse

影片生成 - 取得

GET {endpoint}/openai/v1/video/generations/{generation-id}?api-version=preview

透過 ID 擷取影片生成。

URI 參數

Name	In	Required	類型	Description
端點	路徑	Yes	字串網址	支援Azure OpenAI 端點（協定與主機名稱，例如：`https://aoairesource.openai.azure.com`。請將「aoairesource」替換成你的 Azure OpenAI 資源名稱）。 https://{your-resource-name}.openai.azure.com
API版本	查詢	No		此請求使用明確的 Foundry Models API 版本。 `v1` 若未另行說明。
generation-id	路徑	Yes	字串	用於 Azure OpenAI 請求的影片產生 ID。

請求標頭

使用基於權杖的認證或 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 金鑰

回應

狀態代碼： 200

說明：請求已成功。

內容類型	Type	說明
application/json	VideoGeneration

狀態代碼： 預設

描述：一個意外的錯誤回應。

內容類型	Type	說明
application/json	AzureOpenAIVideoGenerationErrorResponse

Examples

範例檔案未找到：./examples/get_video_generation.json

影片生成 - 擷取縮圖

GET {endpoint}/openai/v1/video/generations/{generation-id}/content/thumbnail?api-version=preview

擷取產生影片內容的縮圖。

URI 參數

Name	In	Required	類型	Description
端點	路徑	Yes	字串網址	支援Azure OpenAI 端點（協定與主機名稱，例如：`https://aoairesource.openai.azure.com`。請將「aoairesource」替換成你的 Azure OpenAI 資源名稱）。 https://{your-resource-name}.openai.azure.com
API版本	查詢	No		此請求使用明確的 Foundry Models API 版本。 `v1` 若未另行說明。
generation-id	路徑	Yes	字串	用於 Azure OpenAI 請求的影片產生 ID。

請求標頭

使用基於權杖的認證或 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 金鑰

回應

狀態代碼： 200

說明：請求已成功。

內容類型	Type	說明
image/jpg	字串

狀態代碼： 預設

描述：一個意外的錯誤回應。

內容類型	Type	說明
application/json	AzureOpenAIVideoGenerationErrorResponse

影片生成 - 擷取影片內容

GET {endpoint}/openai/v1/video/generations/{generation-id}/content/video?api-version=preview

擷取產生的影片內容。

URI 參數

Name	In	Required	類型	Description
端點	路徑	Yes	字串網址	支援Azure OpenAI 端點（協定與主機名稱，例如：`https://aoairesource.openai.azure.com`。請將「aoairesource」替換成你的 Azure OpenAI 資源名稱）。 https://{your-resource-name}.openai.azure.com
API版本	查詢	No		此請求使用明確的 Foundry Models API 版本。 `v1` 若未另行說明。
generation-id	路徑	Yes	字串	用於 Azure OpenAI 請求的影片產生 ID。
品質	查詢	No

請求標頭

使用基於權杖的認證或 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 金鑰

回應

狀態代碼： 200

說明：請求已成功。

內容類型	Type	說明
影片/MP4	字串

狀態代碼： 預設

描述：一個意外的錯誤回應。

內容類型	Type	說明
application/json	AzureOpenAIVideoGenerationErrorResponse

影片生成 - 僅取得影片內容標頭

HEAD {endpoint}/openai/v1/video/generations/{generation-id}/content/video?api-version=preview

擷取產生影片內容的標頭。

URI 參數

Name	In	Required	類型	Description
端點	路徑	Yes	字串網址	支援Azure OpenAI 端點（協定與主機名稱，例如：`https://aoairesource.openai.azure.com`。請將「aoairesource」替換成你的 Azure OpenAI 資源名稱）。 https://{your-resource-name}.openai.azure.com
API版本	查詢	No		此請求使用明確的 Foundry Models API 版本。 `v1` 若未另行說明。
generation-id	路徑	Yes	字串	用於 Azure OpenAI 請求的影片產生 ID。
品質	查詢	No

請求標頭

使用基於權杖的認證或 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 金鑰

回應

狀態代碼： 200

說明：請求已成功。

狀態代碼： 預設

描述：一個意外的錯誤回應。

內容類型	Type	說明
application/json	AzureOpenAIVideoGenerationErrorResponse

組成部分

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

AzureAudioTranscriptionResponse

一項將語音轉錄成書面文字的操作結果資訊。

Name	類型	Description	Required
duration	number	音訊的總長度會被處理以產生伴隨的轉錄資訊。	No
語言	字串	在轉錄音訊資料中偵測到的口語語言。這會以兩個字母的 ISO-639-1 語言代碼表示，如「en」或「fr」。	No
單元	陣列	一組關於每個處理音訊片段的時序、機率及其他細節資訊。	No
工作	物件	定義可用音訊操作回應的可能描述符。	No
收發簡訊	字串	為所提供音頻資料的文字轉錄。	Yes
字句	陣列	一組關於每個處理單字的時間資訊彙編。	No

Azure 音訊翻譯回應 (AzureAudioTranslationResponse)

將語音音訊轉譯成書面文字的操作結果資訊。

Name	類型	Description	Required
duration	number	音訊的總長度會被處理，以產生相應的翻譯資訊。	No
語言	字串	翻譯音訊資料中偵測到的口語。這會以兩個字母的 ISO-639-1 語言代碼表示，如「en」或「fr」。	No
單元	陣列	一組關於每個處理音訊片段的時序、機率及其他細節資訊。	No
工作	物件	定義可用音訊操作回應的可能描述符。	No
收發簡訊	字串	翻譯後的音頻資料。	Yes

AzureErrorResponse

Name	類型	Description	Required
錯誤	物件	錯誤細節。	No
└─ 程式碼	字串	那個獨特的機器產生錯誤識別碼。	No
內部錯誤			No
\|---- 訊息	字串	與錯誤相關聯的人類可讀訊息。	No
└─ 參數	字串	若適用，與錯誤相關的請求輸入參數	No
\---- 類型	列舉	物件類型，永遠是「error」。可能的數值： `error`	No

AzureImagesResponse

Name	類型	Description	Required
背景	列舉	僅限 GPT-image-1：用於影像生成的背景參數。不管是 `transparent` 不是 `opaque`。可能的值： `transparent`， `opaque`	No
創造	整數	Unix 的時間戳記（以秒計）顯示影像產生的時間。	Yes
資料	陣列		No
輸出格式	列舉	影像產生的輸出格式。要麼是 `png`， `webp`，或 `jpeg`是。可能的值： `png`， `webp`， `jpeg`	No
品質	列舉	產生的影像品質。要麼是 `low`， `medium`，或 `high`是。可能的值： `low`， `medium`， `high`	No
size	列舉	產生的影像大小。要麼是 `1024x1024`， `1024x1536`，或 `1536x1024`是。可能的值： `1024x1024`， `1024x1536`， `1536x1024`	No
使用方式	物件	僅針對 `gpt-image-1`-series 模型，影像產生時的代幣使用資訊。	No
└─ 輸入標記 (input_tokens)	整數	輸入提示中標記（圖片和文字）的數量。	No
輸入標記細節	物件	輸入標記提供影像生成所需的詳細資訊。	No
└─ 圖像標記	整數	輸入提示中圖片標記的數量。	No
└─ 文字標記符號	整數	輸入提示中的文字標記數量。	No
└─ output_tokens（輸出符號）	整數	輸出影像中的影像標記數量。	No
total_tokens	整數	用於影像生成的代幣（圖片與文字）總數。	No

AzureOpenAIVideoGenerationErrorResponse

Name	類型	Description	Required
字碼	字串	那個獨特的機器產生錯誤識別碼。	No
inner_error	物件	如果適用，則是引發此錯誤的上游錯誤。	No
└─ 程式碼	列舉	與內部錯誤相關的程式碼。可能的數值： `ResponsibleAIPolicyViolation`	No
└─ 錯誤詳情		內容過濾器的結果與內部錯誤相關。	No
└─ 修訂提示	字串	若適用，則使用修改過的提示詞來生成。	No
訊息	字串	與錯誤相關聯的人類可讀訊息。	No
param	字串	若適用，與錯誤相關的請求輸入參數	No
型別	字串	如適用，則為與錯誤相關的輸入行號。	No

VideoGeneration

影片產生的結果。

Name	類型	Description	Required
建立於	整數	那是影片世代誕生的時代。	Yes
height	整數	影片的高度。	Yes
識別碼	字串	影片生成的ID。	Yes
job_id	字串	這是本影片的影片生成工作ID。	Yes
n_seconds	整數	影片產生的時長。	Yes
物件	列舉	可能的數值： `video.generation`	Yes
提示	字串	這段影片產生的提示。	Yes
width	整數	影片的寬度。	Yes

VideoGenerationJob

一個影片製作的工作。

Name	類型	Description	Required
建立於	整數	工作創立的時間點。	Yes
到期時間	整數	工作自動從服務中刪除的時間點。作業的影片內容與元資料應在此日期前儲存，以避免資料遺失。	No
failure_reason	字串（見下方有效模型）		No
完成時間	整數	就是工作完成所有影片世代的時刻。	No
世代	陣列	這份工作產生的影片。這個數字取決於給定的n_variants以及各代人的創造成功程度。	No
height	整數	影片的高度。	Yes
識別碼	字串	工作的本性。	Yes
inpaint_items	陣列	這是影片製作工作的可選補漆項目。	No
型號	字串	這個部署名稱，用於這個影像產生工作。	Yes
n_seconds	整數	影片產生工作的持續時間。	Yes
n_variants	整數	為了這個影片製作工作，需要製作的影片數量作為變體。	Yes
物件	列舉	可能的數值： `video.generation.job`	Yes
提示	字串	這個影片製作工作的提示。	Yes
狀態	物件	影片製作工作的現狀。	Yes
width	整數	影片的高度。	Yes

VideoGenerationJobList

影片製作職缺清單。

Name	類型	Description	Required
資料	陣列	影片製作工作列表。	Yes
first_id	字串	如果有，請提供當前頁面第一個職缺的 ID。	No
還有更多	boolean	一個旗標顯示列表後是否有更多職缺。	Yes
last_id	字串	如果有，請提供當前頁面最後一個職缺的 ID。	No
物件	列舉	可能的數值： `list`	Yes

下一步

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

意見反應

此頁面對您有幫助嗎？

上次更新時間： 2026-06-24