Azure OpenAI, referência de imagem, áudio e vídeo REST API (pré-visualização v1)

Este artigo documenta as operações de inferência do plano de dados de imagem, áudio (voz) e geração de vídeo das operações da API REST para o Azure OpenAI na versão preliminar v1. Para conclusãos de chats, embeddings, avaliações, ficheiros, ajustes finos, respostas, armazenamentos vetoriais 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 v1 preview API da especificação de inferência do plano de dados do Azure OpenAI. Para mais informações, consulte o guia do ciclo de vida da API.

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

Criar discurso

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

Gera áudio de texto para voz a partir do texto de entrada.

Parâmetros de URI

Name	Em	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API	consulta	No		A versão explícita da API do Microsoft Foundry Models para este pedido. `v1` se não for especificado de outra forma.

Cabeçalho da solicitação

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

Name	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	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` Âmbito: `https://ai.azure.com/.default`
chave de API	Verdade	cadeia (de caracteres)	Forneça aqui a chave API do Azure OpenAI

Órgão do Pedido

Tipo de conteúdo: multipart/form-data

Name	Tipo	Description	Obrigatório	Predefinição
dados introduzidos	cadeia (de caracteres)	O texto para gerar áudio. O comprimento máximo é de 4096 caracteres.	Yes
instructions	cadeia (de caracteres)	Controla a voz do áudio gerado com instruções adicionais. Não funciona com `tts-1` ou `tts-1-hd`.	No
modelo	cadeia (de caracteres)	O modelo a usar para este pedido de texto para fala.	Yes
formato_de_resposta	objecto	Os formatos de saída de áudio suportados para texto para fala.	No
Velocidade	number	A velocidade da fala para áudio gerado. Os valores são válidos no intervalo de 0,25 a 4,0, sendo 1,0 o padrão e valores superiores correspondentes a fala mais rápida.	No	1
formato_de_fluxo	enumeração	O formato para transmitir o áudio. Os formatos suportados são `sse` e `audio`. `sse` não é suportado para `tts-1` ou `tts-1-hd`. Valores possíveis: `sse`, `audio`	No
Voz	objecto		Yes

Respostas

Código de Estado: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Description
application/octet-stream	cadeia (de caracteres)

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
Application/JSON	AzureErrorResponse

Exemplos

Exemplo

Sintetiza áudio a partir 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 Estado: 200

{
  "body": "101010101"
}

Criar transcrição

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

Transcreve o áudio para a língua de entrada.

Parâmetros de URI

Name	Em	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API	consulta	No		A versão explícita da API Foundry Models para este pedido. `v1` se não for especificado de outra forma.

Cabeçalho da solicitação

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

Name	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	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` Âmbito: `https://ai.azure.com/.default`
chave de API	Verdade	cadeia (de caracteres)	Forneça aqui a chave API do Azure OpenAI

Órgão do Pedido

Tipo de conteúdo: multipart/form-data

Name	Tipo	Description	Obrigatório	Predefinição
chunking_strategy	objecto		No
└─ preenchimento_prefixo_ms	número inteiro	Quantidade de áudio a incluir antes do VAD detetar a fala (em milissegundos).	No	300
└─ duração_do_silêncio_ms	número inteiro	Duração do silêncio para detetar a paragem da fala (em milissegundos). Com valores mais curtos, o modelo responderá mais rapidamente, mas pode entrar em pausas curtas do utilizador.	No	200
└─ limiar	number	Limiar de sensibilidade (0.0 a 1.0) para deteção de atividade de voz. Um limiar mais elevado exigirá um áudio mais alto para ativar o modelo, podendo assim ter melhor desempenho em ambientes ruidosos.	No	0,5
└─ tipo	enumeração	Deve estar definido para `server_vad` permitir o chunking manual usando VAD do lado do servidor. Valores possíveis: `server_vad`	No
ficheiro	cadeia (de caracteres)		Yes
filename	cadeia (de caracteres)	O nome opcional do ficheiro ou identificador descritivo para associar aos dados de áudio.	No
incluir[]	matriz	Informação adicional a incluir na resposta de transcrição. `logprobs` devolverá as probabilidades logarítmicas dos tokens na resposta para compreender a confiança do modelo na transcrição. `logprobs` Funciona apenas com response_format definidos como `json` e apenas com os modelos `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, `gpt-4o-mini-transcribe`, e `gpt-4o-mini-transcribe-2025-12-15`.	No
linguagem	cadeia (de caracteres)	A linguagem do áudio de entrada. Fornecer a linguagem de entrada no formato ISO-639-1 (por exemplo, `en`) irá melhorar a precisão e a latência.	No
modelo	cadeia (de caracteres)	O modelo a usar para este pedido de transcrição.	No
avisar	cadeia (de caracteres)	Um texto opcional para guiar o estilo do modelo ou continuar um segmento áudio anterior. O prompt deve corresponder à linguagem do áudio.	No
formato_de_resposta	objecto		No
fluxo	boolean	Se definido como verdadeiro, os dados de resposta do modelo serão transmitidos para o cliente à medida que são gerados usando eventos enviados pelo servidor. Nota: O streaming não é suportado 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 tornam a saída mais aleatória, enquanto valores mais baixos como 0,2 tornam-na mais focada e determinística. Se definido para 0, o modelo usará a probabilidade logarítmica para aumentar automaticamente a temperatura até que certos limiares sejam atingidos.	No	0
timestamp_granularities[]	matriz	As granularidades do carimbo temporal para preencher esta transcrição. `response_format` deve ser definido `verbose_json` para usar granularidades de carimbo temporal. Uma ou ambas estas opções são suportadas: `word`, ou `segment`. Nota: Não existe latência adicional para carimbos temporais de segmentos, mas gerar carimbos temporais de palavra implica latência adicional.	No	['segmento']

Respostas

Código de Estado: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Description
Application/JSON	AzureAudioTranscriptionResponse
texto/sem formatação	cadeia (de caracteres)

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
Application/JSON	AzureErrorResponse

Exemplos

Exemplo

Obtém texto transcrito e metadados associados a partir dos dados de áudio falado fornecidos.

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

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

Respostas: Código de Estado: 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 a partir dos dados de áudio falado fornecidos.

Parâmetros de URI

Name	Em	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API	consulta	No		A versão explícita da API Foundry Models para este pedido. `v1` se não for especificado de outra forma.

Cabeçalho da solicitação

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

Name	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	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` Âmbito: `https://ai.azure.com/.default`
chave de API	Verdade	cadeia (de caracteres)	Forneça aqui a chave API do Azure OpenAI

Órgão do Pedido

Tipo de conteúdo: multipart/form-data

Name	Tipo	Description	Obrigatório	Predefinição
ficheiro	cadeia (de caracteres)		Yes
filename	cadeia (de caracteres)	O nome opcional do ficheiro ou identificador descritivo a associar aos dados de áudio	No
modelo	cadeia (de caracteres)	O modelo a usar para este pedido de tradução.	No
avisar	cadeia (de caracteres)	Um texto opcional para guiar o estilo do modelo ou continuar um segmento áudio anterior. O enunciado deve estar em inglês.	No
formato_de_resposta	objecto		No
Temperatura	number	A temperatura de amostragem, entre 0 e 1. Valores mais altos como 0,8 tornam a saída mais aleatória, enquanto valores mais baixos como 0,2 tornam-na mais focada e determinística. Se definido para 0, o modelo usará a probabilidade logarítmica para aumentar automaticamente a temperatura até que certos limiares sejam atingidos.	No	0

Respostas

Código de Estado: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Description
Application/JSON	AzureAudioTranslationResponse
texto/sem formatação	cadeia (de caracteres)

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
Application/JSON	AzureErrorResponse

Exemplos

Exemplo

Obtém texto transcrito em inglês e metadados associados a partir dos dados de áudio falado fornecidos.

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

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

Respostas: Código de Estado: 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

Name	Em	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API	consulta	No		A versão explícita da API Foundry Models para este pedido. `v1` se não for especificado de outra forma.

Cabeçalho da solicitação

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

Name	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	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` Âmbito: `https://ai.azure.com/.default`
chave de API	Verdade	cadeia (de caracteres)	Forneça aqui a chave API do Azure OpenAI

Órgão do Pedido

Tipo de conteúdo: multipart/form-data

Name	Tipo	Description	Obrigatório	Predefinição
em segundo plano	enumeração	Permite definir transparência para o fundo da(s) imagem(s) gerada(s). Este parâmetro é suportado apenas para `gpt-image-1` modelos. Deve ser um de `transparent`, `opaque` ou `auto` (valor padrão). Quando `auto` é utilizado, o modelo determina automaticamente o melhor fundo para a imagem. Se `transparent`, o formato de saída precisa de suportar transparência, por isso deve ser definido para `png` (valor padrão) ou `webp`. Valores possíveis: `transparent`, `opaque`, `auto`	No
imagem	String ou array		Yes
máscara	cadeia (de caracteres)		No
modelo	cadeia (de caracteres)	A implementação do modelo a usar para a operação de edição de imagem.	Yes
n	número inteiro	O número de imagens a gerar. Deve estar entre 1 e 10.	No	1
compressão_de_saída	número inteiro	O nível de compressão (0-100%) para as imagens geradas. Este parâmetro é suportado apenas para `gpt-image-1`modelos da série -com os `webp` formatos de saída ou `jpeg` , e por defeito é 100.	No	100
formato_de_saida	enumeração	O formato em que as imagens geradas são devolvidas. Este parâmetro é suportado apenas para `gpt-image-1`modelos em série -. Deve ser um dos `png`, `jpeg`, ou `webp`. O valor padrão é `png`. Valores possíveis: `png`, `jpeg`, `webp`	No
avisar	cadeia (de caracteres)	Uma descrição em texto da(s) imagem(ões) desejada(s). O comprimento máximo é de 1000 caracteres para `dall-e-2`, e 32000 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ão apenas suportados para `gpt-image-1`modelos da série -. `dall-e-2` Só suporta `standard` qualidade. Por defeito, é `auto`. Valores possíveis: `standard`, `low`, `medium`, `high`, `auto`	No
formato_de_resposta	enumeração	O formato em que as imagens geradas são devolvidas. Deve ser um dos `url` ou `b64_json`. Os URLs só são válidos durante 60 minutos após a imagem ter sido gerada. Este parâmetro é suportado apenas para `dall-e-2`, pois `gpt-image-1`modelos em série retornam sempre imagens codificadas 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 da série -, e um de `256x256`, `512x512`, ou `1024x1024` para `dall-e-2`. Valores possíveis: `256x256`, `512x512`, `1024x1024`, `1536x1024`, `1024x1536`, `auto`	No
utilizador	cadeia (de caracteres)	Um identificador único que representa o seu utilizador final, que pode ajudar a OpenAI a monitorizar e detetar abusos.	No

Respostas

Código de Estado: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Description
Application/JSON	AzureImagesResponse

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
Application/JSON	AzureErrorResponse

Criarimagem

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

Parâmetros de URI

Name	Em	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API	consulta	No		A versão explícita da API Foundry Models para este pedido. `v1` se não for especificado de outra forma.

Cabeçalho da solicitação

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

Name	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	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` Âmbito: `https://ai.azure.com/.default`
chave de API	Verdade	cadeia (de caracteres)	Forneça aqui a chave API do Azure OpenAI

Órgão do Pedido

Tipo de conteúdo: application/json

Name	Tipo	Description	Obrigatório	Predefinição
em segundo plano	enumeração	Permite definir transparência para o fundo da(s) imagem(s) gerada(s). Este parâmetro é suportado apenas para `gpt-image-1` modelos. Deve ser um de `transparent`, `opaque` ou `auto` (valor padrão). Quando `auto` é utilizado, o modelo determina automaticamente o melhor fundo para a imagem. Se `transparent`, o formato de saída precisa de suportar transparência, por isso deve ser definido para `png` (valor padrão) ou `webp`. Valores possíveis: `transparent`, `opaque`, `auto`	No
modelo	cadeia (de caracteres)	A implementação do modelo para usar na geração de imagens.	Yes
Moderação	enumeração	Controlar o nível de moderação de conteúdo para imagens geradas por `gpt-image-1`modelos da série -. Deve ser ou `low` para filtragem menos restritiva ou `auto` (valor padrão). Valores possíveis: `low`, `auto`	No
n	número inteiro	O número de imagens a gerar. Deve estar entre 1 e 10. Para `dall-e-3`, apenas `n=1` é suportado.	No	1
compressão_de_saída	número inteiro	O nível de compressão (0-100%) para as imagens geradas. Este parâmetro é suportado apenas para `gpt-image-1`modelos da série -com os `webp` formatos de saída ou `jpeg` , e por defeito é 100.	No	100
formato_de_saida	enumeração	O formato em que as imagens geradas são devolvidas. Este parâmetro é suportado apenas para `gpt-image-1`modelos em série -. Deve ser um dos `png`, `jpeg`, ou `webp`. Valores possíveis: `png`, `jpeg`, `webp`	No
avisar	cadeia (de caracteres)	Uma descrição em texto da(s) imagem(ões) desejada(s). O comprimento máximo é de 32000 caracteres para `gpt-image-1`modelos da série -, 1000 caracteres para `dall-e-2` e 4000 caracteres para `dall-e-3`.	Yes
qualidade	enumeração	A qualidade da imagem que será gerada. - `auto` (valor padrão) seleciona automaticamente a melhor qualidade para o modelo dado. - `high`, `medium` e `low` são suportados para `gpt-image-1`modelos da série -. - `hd` e `standard` são suportados para `dall-e-3`. - `standard` é a única opção para `dall-e-2`. Valores possíveis: `standard`, `hd`, `low`, `medium`, `high`, `auto`	No
formato_de_resposta	enumeração	O formato em que as imagens geradas com `dall-e-2` e `dall-e-3` são devolvidas. Deve ser um dos `url` ou `b64_json`. Os URLs só são válidos durante 60 minutos após a imagem ter sido gerada. Este parâmetro não é suportado para `gpt-image-1`modelos da série -que retornam sempre imagens codificadas 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 da 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`, `512x5121792x10241024x1792`	No
Estilo	enumeração	O estilo das imagens geradas. Este parâmetro é suportado apenas para `dall-e-3`. Deve ser um dos `vivid` ou `natural`. O vívido 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, menos hiper-realistas. Valores possíveis: `vivid`, `natural`	No
utilizador	cadeia (de caracteres)	Um identificador único que representa o seu utilizador final, que pode ajudar a OpenAI a monitorizar e detetar abusos.	No

Respostas

Código de Estado: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Description
Application/JSON	AzureImagesResponse

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
Application/JSON	AzureErrorResponse

Exemplos

Exemplo

Cria imagens com 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 Estado: 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
          }
        }
      }
    ]
  }
}

Empregos na 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

Name	Em	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API	consulta	No		A versão explícita da API Foundry Models para este pedido. `v1` se não for especificado de outra forma.

Cabeçalho da solicitação

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

Name	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	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` Âmbito: `https://ai.azure.com/.default`
chave de API	Verdade	cadeia (de caracteres)	Forneça aqui a chave API do Azure OpenAI

Órgão do Pedido

Tipo de conteúdo: application/json

Name	Tipo	Description	Obrigatório	Predefinição
height	número inteiro	O auge do vídeo. São suportadas as seguintes dimensões: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080, tanto em orientação paisagem como retrato.	Yes
modelo	cadeia (de caracteres)	O nome da implementação a usar para este pedido.	Yes
n_seconds	número inteiro	A duração do trabalho de geração de vídeo. Deve ser entre 1 e 20 segundos.	No	5
n_variants	número inteiro	O número de vídeos a criar como variantes para este trabalho. Deve estar entre 1 e 5. Dimensões menores permitem mais variantes.	No	1
avisar	cadeia (de caracteres)	O tema para este trabalho de geração de vídeo.	Yes
width	número inteiro	A largura do vídeo. São suportadas as seguintes dimensões: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080, tanto em orientação paisagem como retrato.	Yes

Órgão do Pedido

Tipo de conteúdo: multipart/form-data

Name	Tipo	Description	Obrigatório	Predefinição
files	matriz		Yes
height	número inteiro	O auge do vídeo. São suportadas as seguintes dimensões: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080, tanto em orientação paisagem como retrato.	Yes
inpaint_items	matriz	Itens opcionais de pintura para este trabalho de geração de vídeo.	No
modelo	cadeia (de caracteres)	O nome da implementação a usar para este pedido.	Yes
n_seconds	número inteiro	A duração do trabalho de geração de vídeo. Deve ser entre 1 e 20 segundos.	No	5
n_variants	número inteiro	O número de vídeos a criar como variantes para este trabalho. Deve estar entre 1 e 5. Dimensões menores permitem mais variantes.	No	1
avisar	cadeia (de caracteres)	O tema para este trabalho de geração de vídeo.	Yes
width	número inteiro	A largura do vídeo. São suportadas as seguintes dimensões: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080, tanto em orientação paisagem como retrato.	Yes

Respostas

Código de Estado: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Description
Application/JSON	VideoGenerationJob

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
Application/JSON	AzureOpenAIVideoGenerationErrorResponse

Exemplos

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

Empregos para geração de vídeo - Lista

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

Lista empregos de geração de vídeo.

Parâmetros de URI

Name	Em	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API	consulta	No		A versão explícita da API Foundry Models para este pedido. `v1` se não for especificado de outra forma.
antes	consulta	No	cadeia (de caracteres)
depois	consulta	No	cadeia (de caracteres)
limit	consulta	Yes	número inteiro
statuses	consulta	No	matriz

Cabeçalho da solicitação

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

Name	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	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` Âmbito: `https://ai.azure.com/.default`
chave de API	Verdade	cadeia (de caracteres)	Forneça aqui a chave API do Azure OpenAI

Respostas

Código de Estado: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Description
Application/JSON	VideoGenerationJobList

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
Application/JSON	AzureOpenAIVideoGenerationErrorResponse

Exemplos

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

Empregos para geração de vídeo - Obter

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

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

Parâmetros de URI

Name	Em	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API	consulta	No		A versão explícita da API Foundry Models para este pedido. `v1` se não for especificado de outra forma.
job-id	caminho	Yes	cadeia (de caracteres)	O ID do trabalho de geração de vídeo a usar para o pedido Azure OpenAI.

Cabeçalho da solicitação

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

Name	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	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` Âmbito: `https://ai.azure.com/.default`
chave de API	Verdade	cadeia (de caracteres)	Forneça aqui a chave API do Azure OpenAI

Respostas

Código de Estado: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Description
Application/JSON	VideoGenerationJob

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
Application/JSON	AzureOpenAIVideoGenerationErrorResponse

Exemplos

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

Empregos na geração de vídeo - Eliminar

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

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

Parâmetros de URI

Name	Em	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API	consulta	No		A versão explícita da API Foundry Models para este pedido. `v1` se não for especificado de outra forma.
job-id	caminho	Yes	cadeia (de caracteres)	O ID do trabalho de geração de vídeo a usar para o pedido Azure OpenAI.

Cabeçalho da solicitação

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

Name	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	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` Âmbito: `https://ai.azure.com/.default`
chave de API	Verdade	cadeia (de caracteres)	Forneça aqui a chave API do Azure OpenAI

Respostas

Código de Estado: 204

Descrição: Não há conteúdo para enviar para este pedido, mas os cabeçalhos podem ser úteis.

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
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

Name	Em	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API	consulta	No		A versão explícita da API Foundry Models para este pedido. `v1` se não for especificado de outra forma.
generation-id	caminho	Yes	cadeia (de caracteres)	O ID da geração de vídeo a usar para o pedido Azure OpenAI.

Cabeçalho da solicitação

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

Name	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	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` Âmbito: `https://ai.azure.com/.default`
chave de API	Verdade	cadeia (de caracteres)	Forneça aqui a chave API do Azure OpenAI

Respostas

Código de Estado: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Description
Application/JSON	VideoGeneration

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
Application/JSON	AzureOpenAIVideoGenerationErrorResponse

Exemplos

Ficheiro 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

Name	Em	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API	consulta	No		A versão explícita da API Foundry Models para este pedido. `v1` se não for especificado de outra forma.
generation-id	caminho	Yes	cadeia (de caracteres)	O ID da geração de vídeo a usar para o pedido Azure OpenAI.

Cabeçalho da solicitação

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

Name	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	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` Âmbito: `https://ai.azure.com/.default`
chave de API	Verdade	cadeia (de caracteres)	Forneça aqui a chave API do Azure OpenAI

Respostas

Código de Estado: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Description
imagem/jpg	cadeia (de caracteres)

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
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

Name	Em	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API	consulta	No		A versão explícita da API Foundry Models para este pedido. `v1` se não for especificado de outra forma.
generation-id	caminho	Yes	cadeia (de caracteres)	O ID da geração de vídeo a usar para o pedido Azure OpenAI.
qualidade	consulta	No

Cabeçalho da solicitação

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

Name	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	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` Âmbito: `https://ai.azure.com/.default`
chave de API	Verdade	cadeia (de caracteres)	Forneça aqui a chave API do Azure OpenAI

Respostas

Código de Estado: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo	Type	Description
Vídeo/MP4	cadeia (de caracteres)

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
Application/JSON	AzureOpenAIVideoGenerationErrorResponse

Gerações de vídeo - Apenas para recuperar cabeçalhos de conteúdo de vídeo

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

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

Parâmetros de URI

Name	Em	Obrigatório	Tipo	Description
ponto final	caminho	Yes	cadeia (de caracteres) url	Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API	consulta	No		A versão explícita da API Foundry Models para este pedido. `v1` se não for especificado de outra forma.
generation-id	caminho	Yes	cadeia (de caracteres)	O ID da geração de vídeo a usar para o pedido Azure OpenAI.
qualidade	consulta	No

Cabeçalho da solicitação

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

Name	Obrigatório	Tipo	Description
Authorization	Verdade	cadeia (de caracteres)	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` Âmbito: `https://ai.azure.com/.default`
chave de API	Verdade	cadeia (de caracteres)	Forneça aqui a chave API do Azure OpenAI

Respostas

Código de Estado: 200

Descrição: O pedido foi bem-sucedido.

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
Application/JSON	AzureOpenAIVideoGenerationErrorResponse

Components

Para as definições de esquema usadas pelo chat, completions, embeddings, respostas e outras operações de texto, veja a referência à API REST do Azure OpenAI. Os seguintes esquemas suportam as operações de imagem, áudio e vídeo nesta página.

AzureAudioTranscriptionResponse

Informação do resultado para uma operação que transcreveu áudio falado em texto escrito.

Name	Tipo	Description	Obrigatório
duration	number	A duração total do áudio é processada para produzir a informação de transcrição correspondente.	No
linguagem	cadeia (de caracteres)	A língua falada que foi detetada nos dados de áudio transcritos. Isto é expresso como um código de língua ISO-639-1 de duas letras, como 'en' ou 'fr'.	No
segments	matriz	Uma coleção de informações sobre o tempo, probabilidades e outros detalhes de cada segmento de áudio processado.	No
tarefa	objecto	Define os possíveis descritores para respostas de operações áudio disponíveis.	No
enviar SMS	cadeia (de caracteres)	O texto transcrito para os dados áudio fornecidos.	Yes
Palavras	matriz	Uma coleção de informações sobre o momento de cada palavra processada.	No

AzureAudioTranslationResponse

Informação do resultado para uma operação que traduziu áudio falado em texto escrito.

Name	Tipo	Description	Obrigatório
duration	number	A duração total do áudio processada para produzir informação de tradução acompanhante.	No
linguagem	cadeia (de caracteres)	A língua falada que foi detetada nos dados de áudio traduzidos. Isto é expresso como um código de língua ISO-639-1 de duas letras, como 'en' ou 'fr'.	No
segments	matriz	Uma coleção de informações sobre o tempo, probabilidades e outros detalhes de cada segmento de áudio processado.	No
tarefa	objecto	Define os possíveis descritores para respostas de operações áudio disponíveis.	No
enviar SMS	cadeia (de caracteres)	O texto traduzido para os dados áudio fornecidos.	Yes

AzureErrorResponse

Name	Tipo	Description	Obrigatório
erro	objecto	O erro é detalhado.	No
└─ código	cadeia (de caracteres)	O identificador distinto, gerado por máquina, para o erro.	No
└─ erro_interno			No
└─ mensagem	cadeia (de caracteres)	Uma mensagem legível para humanos associada ao erro.	No
└─ Param	cadeia (de caracteres)	Se aplicável, o parâmetro de entrada do pedido associado ao erro	No
└─ tipo	enumeração	O tipo de objeto, sempre 'erro'. Valores possíveis: `error`	No

AzureImagesResponse

Name	Tipo	Description	Obrigatório
em segundo plano	enumeração	GPT-image-1 apenas: o parâmetro de fundo usado para a geração da imagem. Ou `transparentopaque`ou. Valores possíveis: `transparent`, `opaque`	No
criado	número inteiro	O carimbo temporal do Unix (em segundos) de quando a imagem foi criada.	Yes
dados	matriz		No
formato_de_saida	enumeração	O formato de saída da geração da imagem. Ou `png`, `webp`, ou `jpeg`. Valores possíveis: `png`, `webp`, `jpeg`	No
qualidade	enumeração	A qualidade da imagem gerada. Ou `low`, `medium`, ou `high`. Valores possíveis: `low`, `medium`, `high`	No
size	enumeração	O tamanho da imagem gerada. Ou `1024x1024`, `1024x1536`, ou `1536x1024`. Valores possíveis: `1024x1024`, `1024x1536`, `1536x1024`	No
utilização	objecto	Para `gpt-image-1`modelos da série - apenas, a informação de utilização do token para a geração da imagem.	No
└─ tokens de entrada	número inteiro	O número de tokens (imagens e texto) no prompt de entrada.	No
└─ detalhes_de_tokens_de_entrada	objecto	Os tokens de entrada fornecem informações detalhadas para a geração da imagem.	No
└─ image_tokens	número inteiro	O número de tokens de imagem no prompt de entrada.	No
└─ text_tokens	número inteiro	O número de tokens de texto no prompt de entrada.	No
└─ output_tokens	número inteiro	O número de tokens de imagem na imagem de saída.	No
└─ fichas_totais	número inteiro	O número total de tokens (imagens e texto) usados para a geração de imagens.	No

AzureOpenAIVideoGenerationErrorResponse

Name	Tipo	Description	Obrigatório
código	cadeia (de caracteres)	O identificador distinto, gerado por máquina, para o erro.	No
inner_error	objecto	Se aplicável, um erro a montante que originou este erro.	No
└─ código	enumeração	O código associado ao erro interno. Valores possíveis: `ResponsibleAIPolicyViolation`	No
└─ detalhes_do_erro		O filtro de conteúdo resulta em detalhes associados ao erro interno.	No
└─ pedido_revisado	cadeia (de caracteres)	Se aplicável, o prompt modificado usado para geração.	No
mensagem	cadeia (de caracteres)	Uma mensagem legível para humanos associada ao erro.	No
param	cadeia (de caracteres)	Se aplicável, o parâmetro de entrada do pedido associado ao erro	No
tipo	cadeia (de caracteres)	Se aplicável, o número da linha de entrada associado ao erro.	No

VideoGeneration

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

Name	Tipo	Description	Obrigatório
criado_em	número inteiro	A época em que a geração de vídeo foi criada.	Yes
height	número inteiro	O auge do vídeo.	Yes
id	cadeia (de caracteres)	O id da geração de vídeo.	Yes
job_id	cadeia (de caracteres)	O id do trabalho de geração de vídeo para este vídeo.	Yes
n_seconds	número inteiro	A duração da geração de vídeo.	Yes
objecto	enumeração	Valores possíveis: `video.generation`	Yes
avisar	cadeia (de caracteres)	O prompt para esta geração de vídeo.	Yes
width	número inteiro	A largura do vídeo.	Yes

VideoGenerationJob

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

Name	Tipo	Description	Obrigatório
criado_em	número inteiro	A altura em que o emprego foi criado.	Yes
expira_em	número inteiro	O momento em que o trabalho é automaticamente eliminado do serviço. O conteúdo do vídeo e os metadados do trabalho devem ser armazenados antes desta data para evitar perda de dados.	No
failure_reason	string (ver modelos válidos abaixo)		No
concluído_em	número inteiro	A altura 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 dado e do sucesso da criação das gerações.	No
height	número inteiro	O auge do vídeo.	Yes
id	cadeia (de caracteres)	A identidade do trabalho.	Yes
inpaint_items	matriz	Itens opcionais de pintura para este trabalho de geração de vídeo.	No
modelo	cadeia (de caracteres)	O nome da implementação a usar para este trabalho de geração de vídeo.	Yes
n_seconds	número inteiro	A duração do trabalho de geração de vídeo.	Yes
n_variants	número inteiro	O número de vídeos a criar como variantes para este trabalho de geração de vídeo.	Yes
objecto	enumeração	Valores possíveis: `video.generation.job`	Yes
avisar	cadeia (de caracteres)	O tema para este trabalho de geração de vídeo.	Yes
estado	objecto	O estado de um trabalho de geração de vídeo.	Yes
width	número inteiro	O auge do vídeo.	Yes

VideoGenerationJobList

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

Name	Tipo	Description	Obrigatório
dados	matriz	A lista de empregos na geração de vídeo.	Yes
first_id	cadeia (de caracteres)	O ID do primeiro emprego na página atual, se disponível.	No
tem_mais	boolean	Uma bandeira a indicar se há mais empregos disponíveis após a lista.	Yes
last_id	cadeia (de caracteres)	O ID do último emprego na página atual, se disponível.	No
objecto	enumeração	Valores possíveis: `list`	Yes

Passos seguintes

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

Comentários

Esta página foi útil?

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