|
| 1 | +--- |
| 2 | +title: 'Quickstart: Generate video with Azure OpenAI' |
| 3 | +titleSuffix: Azure OpenAI |
| 4 | +description: Learn how to get started generating video clips with Azure OpenAI. |
| 5 | +manager: nitinme |
| 6 | +ms.service: azure-ai-openai |
| 7 | +ms.topic: quickstart |
| 8 | +author: PatrickFarley |
| 9 | +ms.author: pafarley |
| 10 | +ms.date: 05/12/2025 |
| 11 | +--- |
| 12 | + |
| 13 | +# Quickstart: Generate video with Azure OpenAI |
| 14 | + |
| 15 | +tbd |
| 16 | + |
| 17 | +## Prerequisites |
| 18 | + |
| 19 | +- An Azure subscription. <a href="https://azure.microsoft.com/free/ai-services" target="_blank">Create one for free</a>. |
| 20 | +- <a href="https://www.python.org/" target="_blank">Python 3.8 or later version</a>. |
| 21 | +- An Azure OpenAI resource created in a supported region. See [Region availability](/azure/ai-services/openai/concepts/models#model-summary-table-and-region-availability). |
| 22 | +- Then, you need to deploy a `sora` model with your Azure resource. For more information, see [Create a resource and deploy a model with Azure OpenAI](../how-to/create-resource.md). |
| 23 | + |
| 24 | + |
| 25 | +## Setup |
| 26 | + |
| 27 | +### Retrieve key and endpoint |
| 28 | + |
| 29 | +To successfully call the Azure OpenAI APIs, you need the following information about your Azure OpenAI resource: |
| 30 | + |
| 31 | +| Variable | Name | Value | |
| 32 | +|---|---|---| |
| 33 | +| **Endpoint** | `api_base` | The endpoint value is located under **Keys and Endpoint** for your resource in the Azure portal. You can also find the endpoint via the **Deployments** page in Azure AI Foundry portal. An example endpoint is: `https://docs-test-001.openai.azure.com/`. | |
| 34 | +| **Key** | `api_key` | The key value is also located under **Keys and Endpoint** for your resource in the Azure portal. Azure generates two keys for your resource. You can use either value. | |
| 35 | + |
| 36 | +Go to your resource in the Azure portal. On the navigation pane, select **Keys and Endpoint** under **Resource Management**. Copy the **Endpoint** value and an access key value. You can use either the **KEY 1** or **KEY 2** value. Always having two keys allows you to securely rotate and regenerate keys without causing a service disruption. |
| 37 | + |
| 38 | +:::image type="content" source="../media/quickstarts/endpoint.png" alt-text="Screenshot that shows the Keys and Endpoint page for an Azure OpenAI resource in the Azure portal." lightbox="../media/quickstarts/endpoint.png"::: |
| 39 | + |
| 40 | +[!INCLUDE [environment-variables](environment-variables.md)] |
| 41 | + |
| 42 | + |
| 43 | +POST: Create Video Generation Job |
| 44 | +`/deployments/{deployment-id}/video/generations/job` |
| 45 | + |
| 46 | + |
| 47 | +GET: Get Video Generation Job /deployments/{deployment-id}/video/generations/jobs/{job-id} |
| 48 | + |
| 49 | +GET: Get Video Generation /deployments/{deployment id}/video/generations/jobs/{generation-id} |
0 commit comments