Azure referência à API REST de áudio e vídeo do OpenAI (versão prévia v1)

Este artigo documenta a imagem, o áudio (fala) e as operações da API REST de inferência do plano de dados de geração de vídeo para Azure OpenAI na versão prévia v1. Para conclusões de chat, inserções, avaliações, arquivos, ajuste fino, respostas, repositórios de vetores e todas as outras operações, consulte a referência oficial da API REST do Azure OpenAI.

Inferência do plano de dados

O restante deste artigo aborda as operações de imagem, áudio e vídeo na nova versão prévia da API v1 da especificação de inferência do plano de dados Azure OpenAI. Para obter mais informações, consulte o guia de ciclo de vida da API.

Para obter a API completa do plano de dados ga v1, consulte o Azure referência oficial da API REST do OpenAI.

Criar discurso

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

Gera áudio de conversão de texto em fala do texto de entrada.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Com suporte Azure pontos de extremidade OpenAI (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo Azure nome do recurso OpenAI). https://{your-resource-name}.openai.azure.com
versão da API	consulta	No		O Microsoft versão explícita da API de Modelos de Fundimento a ser usada para essa solicitação. `v1` se não for especificado de outra forma.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	Exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Escopo: `https://ai.azure.com/.default`
chave da API	Verdade	cadeia	Forneça Azure chave de API openai aqui

Corpo da solicitação

Content-Type: multipart/form-data (dados de formulário em múltiplas partes)

Nome	Tipo	Descrição	Obrigatório	Default
entrada	cadeia	O texto para o qual gerar áudio. O comprimento máximo é de 4.096 caracteres.	Yes
instructions	cadeia	Controle a voz do áudio gerado com instruções adicionais. Não funciona com `tts-1` ou `tts-1-hd`.	No
modelo	cadeia	O modelo a ser usado para essa solicitação de conversão de texto em fala.	Yes
formato_de_resposta	objeto	Os formatos de saída de áudio com suporte para conversão de texto em fala.	No
Velocidade	number	A velocidade da fala do áudio gerado. Os valores são válidos no intervalo de 0,25 a 4,0, com 1,0 os valores padrão e mais altos correspondentes à fala mais rápida.	No	1
stream_format	enumeração	O formato para transmitir o áudio. Os formatos com suporte são `sse` e `audio`. `sse` não há suporte para `tts-1` ou `tts-1-hd`. Valores possíveis: `sse`, `audio`	No
Voz	objeto		Yes

Respostas

Código de status: 200

Descrição: a solicitação foi bem-sucedida.

Tipo de conteúdo	Tipo	Descrição
application/octet-stream	cadeia

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
application/json	AzureErrorResponse

Exemplos

Example

Sintetiza o áudio do texto fornecido.

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"
}

Respostas: Código de Status: 200

{
  "body": "101010101"
}

Criar transcrição

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

Transcreve o áudio no idioma de entrada.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Com suporte Azure pontos de extremidade OpenAI (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo Azure nome do recurso OpenAI). https://{your-resource-name}.openai.azure.com
versão da API	consulta	No		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	Exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Escopo: `https://ai.azure.com/.default`
chave da API	Verdade	cadeia	Forneça Azure chave de API openai aqui

Corpo da solicitação

Content-Type: multipart/form-data (dados de formulário em múltiplas partes)

Nome	Tipo	Descrição	Obrigatório	Default
chunking_strategy	objeto		No
└─ prefix_padding_ms	inteiro	Quantidade de áudio a ser incluída antes da fala detectada pelo VAD (em milissegundos).	No	300
└─ duração_do_silêncio_ms	inteiro	Duração do silêncio para detectar a parada de fala (em milissegundos). Com valores mais curtos, o modelo responderá mais rapidamente, mas pode entrar em pausas curtas do usuário.	No	200
└─ limite	number	Limite de confidencialidade (0,0 a 1,0) para detecção de atividade de voz. Um limite mais alto exigirá um áudio mais alto para ativar o modelo e, portanto, poderá ter um desempenho melhor em ambientes barulhentos.	No	0,5
└─ tipo	enumeração	Deve ser definido para `server_vad` habilitar o agrupamento manual usando o VAD do lado do servidor. Valores possíveis: `server_vad`	No
arquivo	cadeia		Yes
filename	cadeia	O nome de arquivo opcional ou o identificador descritivo a ser associado aos dados de áudio.	No
include[]	matriz	Informações adicionais a serem incluídas na resposta de transcrição. `logprobs` retornará as probabilidades de log dos tokens na resposta para entender a confiança do modelo na transcrição. `logprobs`só funciona com response_format definidos `json` como e somente com os modelos`gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`e `gpt-4o-mini-transcribegpt-4o-mini-transcribe-2025-12-15`.	No
linguagem	cadeia	O idioma do áudio de entrada. Fornecer o idioma de entrada no formato ISO-639-1 (por exemplo `en`) melhorará a precisão e a latência.	No
modelo	cadeia	O modelo a ser usado para essa solicitação de transcrição.	No
solicitação	cadeia	Um texto opcional para orientar o estilo do modelo ou continuar um segmento de áudio anterior. O prompt deve corresponder ao idioma de áudio.	No
formato_de_resposta	objeto		No
fluxo	booleano	Se definido como true, os dados de resposta do modelo serão transmitidos para o cliente à medida que forem gerados usando eventos enviados pelo servidor. Observação: o streaming não tem suporte para o `whisper-1` modelo e será ignorado.	No	Falso
Temperatura	number	A temperatura de amostragem, entre 0 e 1. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 o tornarão mais focado e determinístico. Se definido como 0, o modelo usará a probabilidade de log para aumentar automaticamente a temperatura até que determinados limites sejam atingidos.	No	0
timestamp_granularities[]	matriz	As granularidades de carimbo de data/hora a serem preenchidas para essa transcrição. `response_format` deve ser definido `verbose_json` para usar granularidades de carimbo de data/hora. Há suporte para ambas ou ambas as opções: `word`ou `segment`. Observação: não há latência adicional para carimbos de data/hora do segmento, mas gerar carimbos de data/hora de palavra incorre em latência adicional.	No	['segment']

Respostas

Código de status: 200

Descrição: a solicitação foi bem-sucedida.

Tipo de conteúdo	Tipo	Descrição
application/json	AzureAudioTranscriptionResponse
texto/sem formatação	cadeia

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
application/json	AzureErrorResponse

Exemplos

Example

Obtém texto transcrito e metadados associados de dados de áudio falados fornecidos.

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

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

Respostas: Código de Status: 200

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

Criar tradução

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

Obtém texto transcrito em inglês e metadados associados de dados de áudio falados fornecidos.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Com suporte Azure pontos de extremidade OpenAI (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo Azure nome do recurso OpenAI). https://{your-resource-name}.openai.azure.com
versão da API	consulta	No		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	Exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Escopo: `https://ai.azure.com/.default`
chave da API	Verdade	cadeia	Forneça Azure chave de API openai aqui

Corpo da solicitação

Content-Type: multipart/form-data (dados de formulário em múltiplas partes)

Nome	Tipo	Descrição	Obrigatório	Default
arquivo	cadeia		Yes
filename	cadeia	O nome de arquivo opcional ou o identificador descritivo a ser associado aos dados de áudio	No
modelo	cadeia	O modelo a ser usado para essa solicitação de tradução.	No
solicitação	cadeia	Um texto opcional para orientar o estilo do modelo ou continuar um segmento de áudio anterior. O prompt deve estar em inglês.	No
formato_de_resposta	objeto		No
Temperatura	number	A temperatura de amostragem, entre 0 e 1. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 o tornarão mais focado e determinístico. Se definido como 0, o modelo usará a probabilidade de log para aumentar automaticamente a temperatura até que determinados limites sejam atingidos.	No	0

Respostas

Código de status: 200

Descrição: a solicitação foi bem-sucedida.

Tipo de conteúdo	Tipo	Descrição
application/json	AzureAudioTranslationResponse
texto/sem formatação	cadeia

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
application/json	AzureErrorResponse

Exemplos

Example

Obtém texto transcrito em inglês e metadados associados de dados de áudio falados fornecidos.

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

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

Respostas: Código de Status: 200

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

Criar edição de imagem

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Com suporte Azure pontos de extremidade OpenAI (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo Azure nome do recurso OpenAI). https://{your-resource-name}.openai.azure.com
versão da API	consulta	No		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	Exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Escopo: `https://ai.azure.com/.default`
chave da API	Verdade	cadeia	Forneça Azure chave de API openai aqui

Corpo da solicitação

Content-Type: multipart/form-data (dados de formulário em múltiplas partes)

Nome	Tipo	Descrição	Obrigatório	Default
em segundo plano	enumeração	Permite definir a transparência para a tela de fundo das imagens geradas. Esse parâmetro só tem suporte para `gpt-image-1` modelos. Deve ser um ou `transparentopaqueauto` (valor padrão). Quando `auto` for usado, o modelo determinará automaticamente o melhor plano de fundo para a imagem. Se `transparent`, o formato de saída precisa dar suporte à transparência, portanto, ele deve ser definido como `png` (valor padrão) ou `webp`. Valores possíveis: `transparent`, , `opaqueauto`	No
imagem	cadeia de caracteres ou matriz		Yes
máscara	cadeia		No
modelo	cadeia	A implantação de modelo a ser usada para a operação de edição de imagem.	Yes
n	inteiro	O número de imagens a serem geradas. Deve estar entre 1 e 10.	No	1
compressão_de_saída	inteiro	O nível de compactação (0-100%) para as imagens geradas. Esse parâmetro só tem suporte para `gpt-image-1`modelos de série com os `webp` formatos ou `jpeg` saída e usa como padrão 100.	No	100
formato de saída	enumeração	O formato no qual as imagens geradas são retornadas. Esse parâmetro só tem suporte para `gpt-image-1`modelos de série. Deve ser um de `png`, `jpeg`ou `webp`. O valor padrão é `png`. Valores possíveis: `png`, , `jpegwebp`	No
solicitação	cadeia	Uma descrição de texto das imagens desejadas. O comprimento máximo é de 1.000 caracteres e `dall-e-2`3.2000 caracteres para `gpt-image-1`modelos da série.	Yes
Qualidade	enumeração	A qualidade da imagem que será gerada. `high`, `medium` e `low` só têm suporte para `gpt-image-1`modelos de série. `dall-e-2` só dá suporte à `standard` qualidade. O padrão é `auto`. Valores possíveis: `standard`, , `low`, `medium`, `high`, `auto`	No
formato_de_resposta	enumeração	O formato no qual as imagens geradas são retornadas. Deve ser um de `url` ou `b64_json`. As URLs só são válidas por 60 minutos após a geração da imagem. Esse parâmetro só tem suporte para `dall-e-2`modelos de série, pois `gpt-image-1`os modelos de série sempre retornarão imagens codificadas em base64. Valores possíveis: `url`, `b64_json`	No
size	enumeração	O tamanho das imagens geradas. Deve ser um de `1024x1024`, `1536x1024` (paisagem), `1024x1536` (retrato) ou `auto` (valor padrão) para `gpt-image-1`modelos de série e um de `256x256`, `512x512`ou `1024x1024` para `dall-e-2`. Valores possíveis: `256x256`, , `512x512`, `1024x1024`, `1536x1024`, , `1024x1536auto`	No
usuário	cadeia	Um identificador exclusivo que representa o usuário final, que pode ajudar o OpenAI a monitorar e detectar abusos.	No

Respostas

Código de status: 200

Descrição: a solicitação foi bem-sucedida.

Tipo de conteúdo	Tipo	Descrição
application/json	AzureImagesResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
application/json	AzureErrorResponse

Criar imagem

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Com suporte Azure pontos de extremidade OpenAI (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo Azure nome do recurso OpenAI). https://{your-resource-name}.openai.azure.com
versão da API	consulta	No		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	Exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Escopo: `https://ai.azure.com/.default`
chave da API	Verdade	cadeia	Forneça Azure chave de API openai aqui

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	Descrição	Obrigatório	Default
em segundo plano	enumeração	Permite definir a transparência para a tela de fundo das imagens geradas. Esse parâmetro só tem suporte para `gpt-image-1` modelos. Deve ser um ou `transparentopaqueauto` (valor padrão). Quando `auto` for usado, o modelo determinará automaticamente o melhor plano de fundo para a imagem. Se `transparent`, o formato de saída precisa dar suporte à transparência, portanto, ele deve ser definido como `png` (valor padrão) ou `webp`. Valores possíveis: `transparent`, , `opaqueauto`	No
modelo	cadeia	A implantação de modelo a ser usada para a geração de imagem.	Yes
Moderação	enumeração	Controlar o nível de moderação de conteúdo para imagens geradas por `gpt-image-1`modelos de série. Deve ser `low` para filtragem menos restritiva ou `auto` (valor padrão). Valores possíveis: `low`, `auto`	No
n	inteiro	O número de imagens a serem geradas. Deve estar entre 1 e 10. Para `dall-e-3`, só `n=1` há suporte.	No	1
compressão_de_saída	inteiro	O nível de compactação (0-100%) para as imagens geradas. Esse parâmetro só tem suporte para `gpt-image-1`modelos de série com os `webp` formatos ou `jpeg` saída e usa como padrão 100.	No	100
formato de saída	enumeração	O formato no qual as imagens geradas são retornadas. Esse parâmetro só tem suporte para `gpt-image-1`modelos de série. Deve ser um de `png`, `jpeg`ou `webp`. Valores possíveis: `png`, , `jpegwebp`	No
solicitação	cadeia	Uma descrição de texto das imagens desejadas. O comprimento máximo é de 32.000 caracteres para `gpt-image-1`modelos da série, 1.000 caracteres e `dall-e-2` 4.000 caracteres para `dall-e-3`.	Yes
Qualidade	enumeração	A qualidade da imagem que será gerada. - `auto` (valor padrão) selecionará automaticamente a melhor qualidade para o modelo fornecido. - `high` `medium` e `low` são compatíveis com `gpt-image-1`modelos de série. - `hd` e `standard` têm suporte para `dall-e-3`. - `standard` é a única opção para `dall-e-2`. Valores possíveis: `standard`, , `hd`, `low`, `medium`, , `highauto`	No
formato_de_resposta	enumeração	O formato no qual as imagens geradas são `dall-e-2` retornadas e `dall-e-3` retornadas. Deve ser um de `url` ou `b64_json`. As URLs só são válidas por 60 minutos após a geração da imagem. Esse parâmetro não tem suporte para `gpt-image-1`modelos de série que sempre retornarão imagens codificadas em base64. Valores possíveis: `url`, `b64_json`	No
size	enumeração	O tamanho das imagens geradas. Deve ser um de `1024x1024`, `1536x1024` (paisagem), `1024x1536` (retrato) ou `auto` (valor padrão) para `gpt-image-1`modelos de série, um de `256x256`, `512x512`ou `1024x1024` para `dall-e-2`, e um de `1024x1024`, `1792x1024`ou `1024x1792` para `dall-e-3`. Valores possíveis: `auto`, , `1024x1024`, `1536x1024`, `1024x1536`, `256x256`, `512x512`, , , `1792x10241024x1792`	No
estilo	enumeração	O estilo das imagens geradas. Esse parâmetro só tem suporte para `dall-e-3`. Deve ser um de `vivid` ou `natural`. O Vivid faz com que o modelo se incline para gerar imagens hiper-reais e dramáticas. Natural faz com que o modelo produza imagens mais naturais e menos hiper-reais. Valores possíveis: `vivid`, `natural`	No
usuário	cadeia	Um identificador exclusivo que representa o usuário final, que pode ajudar o OpenAI a monitorar e detectar abusos.	No

Respostas

Código de status: 200

Descrição: a solicitação foi bem-sucedida.

Tipo de conteúdo	Tipo	Descrição
application/json	AzureImagesResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
application/json	AzureErrorResponse

Exemplos

Example

Cria imagens fornecidas por um prompt.

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"
}

Respostas: Código de Status: 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
          }
        }
      }
    ]
  }
}

Trabalhos de geração de vídeo – Criar

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

Cria um novo trabalho de geração de vídeo.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Com suporte Azure pontos de extremidade OpenAI (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo Azure nome do recurso OpenAI). https://{your-resource-name}.openai.azure.com
versão da API	consulta	No		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	Exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Escopo: `https://ai.azure.com/.default`
chave da API	Verdade	cadeia	Forneça Azure chave de API openai aqui

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	Descrição	Obrigatório	Default
height	inteiro	A altura do vídeo. Há suporte para as seguintes dimensões: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080 nas orientações paisagem e retrato.	Yes
modelo	cadeia	O nome da implantação a ser usada para essa solicitação.	Yes
n_seconds	inteiro	A duração do trabalho de geração de vídeo. Deve estar entre 1 e 20 segundos.	No	5
n_variants	inteiro	O número de vídeos a serem criados como variantes para este trabalho. Deve estar entre 1 e 5. Dimensões menores permitem mais variantes.	No	1
solicitação	cadeia	O prompt para este trabalho de geração de vídeo.	Yes
width	inteiro	A largura do vídeo. Há suporte para as seguintes dimensões: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080 nas orientações paisagem e retrato.	Yes

Corpo da solicitação

Content-Type: multipart/form-data (dados de formulário em múltiplas partes)

Nome	Tipo	Descrição	Obrigatório	Default
arquivos	matriz		Yes
height	inteiro	A altura do vídeo. Há suporte para as seguintes dimensões: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080 nas orientações paisagem e retrato.	Yes
inpaint_items	matriz	Itens de insintação opcionais para este trabalho de geração de vídeo.	No
modelo	cadeia	O nome da implantação a ser usada para essa solicitação.	Yes
n_seconds	inteiro	A duração do trabalho de geração de vídeo. Deve estar entre 1 e 20 segundos.	No	5
n_variants	inteiro	O número de vídeos a serem criados como variantes para este trabalho. Deve estar entre 1 e 5. Dimensões menores permitem mais variantes.	No	1
solicitação	cadeia	O prompt para este trabalho de geração de vídeo.	Yes
width	inteiro	A largura do vídeo. Há suporte para as seguintes dimensões: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080 nas orientações paisagem e retrato.	Yes

Respostas

Código de status: 200

Descrição: a solicitação foi bem-sucedida.

Tipo de conteúdo	Tipo	Descrição
application/json	VideoGenerationJob

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
application/json	AzureOpenAIVideoGenerationErrorResponse

Exemplos

Arquivo de exemplo não encontrado: ./examples/create_video_generation_job_simple.json

Trabalhos de geração de vídeo – Lista

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

Lista os trabalhos de geração de vídeo.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Com suporte Azure pontos de extremidade OpenAI (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo Azure nome do recurso OpenAI). https://{your-resource-name}.openai.azure.com
versão da API	consulta	No		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
before	consulta	No	cadeia
Depois	consulta	No	cadeia
limit	consulta	Yes	inteiro
statuses	consulta	No	matriz

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	Exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Escopo: `https://ai.azure.com/.default`
chave da API	Verdade	cadeia	Forneça Azure chave de API openai aqui

Respostas

Código de status: 200

Descrição: a solicitação foi bem-sucedida.

Tipo de conteúdo	Tipo	Descrição
application/json	VideoGenerationJobList

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
application/json	AzureOpenAIVideoGenerationErrorResponse

Exemplos

Arquivo de exemplo não encontrado: ./examples/get_video_generation_job_list.json

Trabalhos de geração de vídeo – Obter

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

Recupera as propriedades de um trabalho de geração de vídeo.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Com suporte Azure pontos de extremidade OpenAI (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo Azure nome do recurso OpenAI). https://{your-resource-name}.openai.azure.com
versão da API	consulta	No		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
job-id	caminho	Yes	cadeia	A ID do trabalho de geração de vídeo a ser usada para a solicitação Azure OpenAI.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	Exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Escopo: `https://ai.azure.com/.default`
chave da API	Verdade	cadeia	Forneça Azure chave de API openai aqui

Respostas

Código de status: 200

Descrição: a solicitação foi bem-sucedida.

Tipo de conteúdo	Tipo	Descrição
application/json	VideoGenerationJob

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
application/json	AzureOpenAIVideoGenerationErrorResponse

Exemplos

Arquivo de exemplo não encontrado: ./examples/get_video_generation_job.json

Trabalhos de geração de vídeo – Excluir

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

Exclui um trabalho de geração de vídeo.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Com suporte Azure pontos de extremidade OpenAI (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo Azure nome do recurso OpenAI). https://{your-resource-name}.openai.azure.com
versão da API	consulta	No		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
job-id	caminho	Yes	cadeia	A ID do trabalho de geração de vídeo a ser usada para a solicitação Azure OpenAI.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	Exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Escopo: `https://ai.azure.com/.default`
chave da API	Verdade	cadeia	Forneça Azure chave de API openai aqui

Respostas

Código de status: 204

Descrição: não há conteúdo a ser enviado para essa solicitação, mas os cabeçalhos podem ser úteis.

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
application/json	AzureOpenAIVideoGenerationErrorResponse

Gerações de vídeo – Obter

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

Recupera uma geração de vídeo por ID.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Com suporte Azure pontos de extremidade OpenAI (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo Azure nome do recurso OpenAI). https://{your-resource-name}.openai.azure.com
versão da API	consulta	No		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
generation-id	caminho	Yes	cadeia	A ID da geração de vídeo a ser usada para a solicitação Azure OpenAI.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	Exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Escopo: `https://ai.azure.com/.default`
chave da API	Verdade	cadeia	Forneça Azure chave de API openai aqui

Respostas

Código de status: 200

Descrição: a solicitação foi bem-sucedida.

Tipo de conteúdo	Tipo	Descrição
application/json	VideoGeneration

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
application/json	AzureOpenAIVideoGenerationErrorResponse

Exemplos

Arquivo de exemplo não encontrado: ./examples/get_video_generation.json

Gerações de vídeo – Recuperar miniatura

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

Recupera uma miniatura do conteúdo de vídeo gerado.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Com suporte Azure pontos de extremidade OpenAI (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo Azure nome do recurso OpenAI). https://{your-resource-name}.openai.azure.com
versão da API	consulta	No		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
generation-id	caminho	Yes	cadeia	A ID da geração de vídeo a ser usada para a solicitação Azure OpenAI.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	Exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Escopo: `https://ai.azure.com/.default`
chave da API	Verdade	cadeia	Forneça Azure chave de API openai aqui

Respostas

Código de status: 200

Descrição: a solicitação foi bem-sucedida.

Tipo de conteúdo	Tipo	Descrição
image/jpg	cadeia

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
application/json	AzureOpenAIVideoGenerationErrorResponse

Gerações de vídeo – Recuperar conteúdo de vídeo

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

Recupera o conteúdo de vídeo gerado.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Com suporte Azure pontos de extremidade OpenAI (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo Azure nome do recurso OpenAI). https://{your-resource-name}.openai.azure.com
versão da API	consulta	No		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
generation-id	caminho	Yes	cadeia	A ID da geração de vídeo a ser usada para a solicitação Azure OpenAI.
Qualidade	consulta	No

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	Exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Escopo: `https://ai.azure.com/.default`
chave da API	Verdade	cadeia	Forneça Azure chave de API openai aqui

Respostas

Código de status: 200

Descrição: a solicitação foi bem-sucedida.

Tipo de conteúdo	Tipo	Descrição
vídeo/mp4	cadeia

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
application/json	AzureOpenAIVideoGenerationErrorResponse

Gerações de vídeo – recuperar somente cabeçalhos de videocontent

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

Recupera cabeçalhos para o conteúdo de vídeo gerado.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Com suporte Azure pontos de extremidade OpenAI (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo Azure nome do recurso OpenAI). https://{your-resource-name}.openai.azure.com
versão da API	consulta	No		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
generation-id	caminho	Yes	cadeia	A ID da geração de vídeo a ser usada para a solicitação Azure OpenAI.
Qualidade	consulta	No

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	Exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Escopo: `https://ai.azure.com/.default`
chave da API	Verdade	cadeia	Forneça Azure chave de API openai aqui

Respostas

Código de status: 200

Descrição: a solicitação foi bem-sucedida.

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
application/json	AzureOpenAIVideoGenerationErrorResponse

Componentes

Para obter as definições de esquema usadas por chat, conclusões, inserções, respostas e outras operações de texto, consulte a referência da API REST do Azure OpenAI. Os esquemas a seguir dão suporte às operações de imagem, áudio e vídeo nesta página.

AzureAudioTranscriptionResponse

Informações de resultado de uma operação que transscreveu áudio falado em texto escrito.

Nome	Tipo	Descrição	Obrigatório
duração	number	A duração total do áudio processado para produzir informações de transcrição que acompanham.	No
linguagem	cadeia	O idioma falado detectado nos dados de áudio transcritos. Isso é expresso como um código de idioma ISO-639-1 de duas letras, como 'en' ou 'fr'.	No
Segmentos	matriz	Uma coleção de informações sobre o tempo, as probabilidades e outros detalhes de cada segmento de áudio processado.	No
tarefa	objeto	Define os possíveis descritores para respostas de operação de áudio disponíveis.	No
enviar SMS	cadeia	O texto transcrito para os dados de áudio fornecidos.	Yes
words	matriz	Uma coleção de informações sobre o tempo de cada palavra processada.	No

AzureAudioTranslationResponse

Informações de resultado de uma operação que traduziu áudio falado em texto escrito.

Nome	Tipo	Descrição	Obrigatório
duração	number	A duração total do áudio processado para produzir informações de tradução que acompanham.	No
linguagem	cadeia	O idioma falado detectado nos dados de áudio traduzidos. Isso é expresso como um código de idioma ISO-639-1 de duas letras, como 'en' ou 'fr'.	No
Segmentos	matriz	Uma coleção de informações sobre o tempo, as probabilidades e outros detalhes de cada segmento de áudio processado.	No
tarefa	objeto	Define os possíveis descritores para respostas de operação de áudio disponíveis.	No
enviar SMS	cadeia	O texto traduzido para os dados de áudio fornecidos.	Yes

AzureErrorResponse

Nome	Tipo	Descrição	Obrigatório
erro	objeto	Os detalhes do erro.	No
└─ código	cadeia	O identificador distinto gerado pelo computador para o erro.	No
└─ erro_interno			No
Mensagem └─	cadeia	Uma mensagem legível por humanos associada ao erro.	No
└─ Param	cadeia	Se aplicável, o parâmetro de entrada de solicitação associado ao erro	No
└─ tipo	enumeração	O tipo de objeto, sempre "error". Valores possíveis: `error`	No

AzureImagesResponse

Nome	Tipo	Descrição	Obrigatório
em segundo plano	enumeração	Somente GPT-image-1: o parâmetro de plano de fundo usado para a geração de imagem. Ou `transparent` .`opaque` Valores possíveis: `transparent`, `opaque`	No
criado	inteiro	O carimbo de data/hora Unix (em segundos) de quando a imagem foi criada.	Yes
dados	matriz		No
formato de saída	enumeração	O formato de saída da geração de imagem. Ou `png`, `webp`ou `jpeg`. Valores possíveis: `png`, , `webpjpeg`	No
Qualidade	enumeração	A qualidade da imagem gerada. Ou `low`, `medium`ou `high`. Valores possíveis: `low`, , `mediumhigh`	No
size	enumeração	O tamanho da imagem gerada. Ou `1024x1024`, `1024x1536`ou `1536x1024`. Valores possíveis: `1024x1024`, , `1024x15361536x1024`	No
uso	objeto	Somente para `gpt-image-1`modelos de série, as informações de uso do token para a geração de imagem.	No
└─ tokens de entrada	inteiro	O número de tokens (imagens e texto) no prompt de entrada.	No
└─ detalhes_de_tokens_de_entrada	objeto	As informações detalhadas dos tokens de entrada para a geração de imagem.	No
└─ image_tokens	inteiro	O número de tokens de imagem no prompt de entrada.	No
└─ text_tokens	inteiro	O número de tokens de texto no prompt de entrada.	No
└─ tokens_de_saída	inteiro	O número de tokens de imagem na imagem de saída.	No
└─ tokens_totais	inteiro	O número total de tokens (imagens e texto) usados para a geração de imagem.	No

AzureOpenAIVideoGenerationErrorResponse

Nome	Tipo	Descrição	Obrigatório
codificar	cadeia	O identificador distinto gerado pelo computador para o erro.	No
inner_error	objeto	Se aplicável, um erro upstream que originou esse erro.	No
└─ código	enumeração	O código associado ao erro interno. Valores possíveis: `ResponsibleAIPolicyViolation`	No
└─ detalhes_do_erro		Os detalhes do resultado do filtro de conteúdo associados ao erro interno.	No
└─ prompt_revisado	cadeia	Se aplicável, o prompt modificado usado para geração.	No
mensagem	cadeia	Uma mensagem legível por humanos associada ao erro.	No
param	cadeia	Se aplicável, o parâmetro de entrada de solicitação associado ao erro	No
tipo	cadeia	Se aplicável, o número da linha de entrada associado ao erro.	No

VideoGeneration

Um resultado de geração de vídeo.

Nome	Tipo	Descrição	Obrigatório
criado_em	inteiro	A hora em que a geração de vídeo foi criada.	Yes
height	inteiro	A altura do vídeo.	Yes
id	cadeia	A ID da geração de vídeo.	Yes
job_id	cadeia	A ID do trabalho de geração de vídeo para este vídeo.	Yes
n_seconds	inteiro	A duração da geração de vídeo.	Yes
objeto	enumeração	Valores possíveis: `video.generation`	Yes
solicitação	cadeia	O prompt para essa geração de vídeo.	Yes
width	inteiro	A largura do vídeo.	Yes

VideoGenerationJob

Um trabalho de geração de vídeo.

Nome	Tipo	Descrição	Obrigatório
criado_em	inteiro	A hora em que o trabalho foi criado.	Yes
expira_em	inteiro	A hora em que o trabalho é excluído automaticamente do serviço. O conteúdo do vídeo e os metadados do trabalho devem ser armazenados antes dessa data para evitar a perda de dados.	No
failure_reason	cadeia de caracteres (veja os modelos válidos abaixo)		No
finished_at	inteiro	A hora em que o trabalho terminou com todas as gerações de vídeo.	No
Gerações	matriz	Os vídeos gerados para este trabalho. O número depende do n_variants determinado e do sucesso de criação das gerações.	No
height	inteiro	A altura do vídeo.	Yes
id	cadeia	A ID do trabalho.	Yes
inpaint_items	matriz	Itens de insintação opcionais para este trabalho de geração de vídeo.	No
modelo	cadeia	O nome da implantação a ser usada para este trabalho de geração de vídeo.	Yes
n_seconds	inteiro	A duração do trabalho de geração de vídeo.	Yes
n_variants	inteiro	O número de vídeos a serem criados como variantes para este trabalho de geração de vídeo.	Yes
objeto	enumeração	Valores possíveis: `video.generation.job`	Yes
solicitação	cadeia	O prompt para este trabalho de geração de vídeo.	Yes
status	objeto	O status de um trabalho de geração de vídeo.	Yes
width	inteiro	A altura do vídeo.	Yes

VideoGenerationJobList

Uma lista de trabalhos de geração de vídeo.

Nome	Tipo	Descrição	Obrigatório
dados	matriz	A lista de trabalhos de geração de vídeo.	Yes
first_id	cadeia	A ID do primeiro trabalho na página atual, se disponível.	No
has_more	booleano	Um sinalizador que indica se há mais trabalhos disponíveis após a lista.	Yes
last_id	cadeia	A ID do último trabalho na página atual, se disponível.	No
objeto	enumeração	Valores possíveis: `list`	Yes

Próximas Etapas

Saiba mais sobre modelos e ajuste fino com a API REST. Saiba mais sobre os modelos underlying que alimentam Azure OpenAI.

Comentários

Esta página foi útil?

Última atualização em 2026-06-24