Skip to content

Commit 35439fe

Browse files
Merge pull request #210958 from Juliako/apiui
updated the API topic
2 parents 50c8dfe + 64e29f6 commit 35439fe

File tree

1 file changed

+12
-17
lines changed

1 file changed

+12
-17
lines changed

articles/azure-video-indexer/video-indexer-use-apis.md

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -22,30 +22,24 @@ Before you start, see the [Recommendations](#recommendations) section (that foll
2222

2323
1. Sign in to [Azure Video Indexer Developer Portal](https://api-portal.videoindexer.ai/).
2424

25-
Review a release note regarding [login information](release-notes.md#october-2020).
26-
27-
![Sign in to Azure Video Indexer Developer Portal](./media/video-indexer-use-apis/sign-in.png)
28-
2925
> [!Important]
3026
> * You must use the same provider you used when you signed up for Azure Video Indexer.
3127
> * Personal Google and Microsoft (Outlook/Live) accounts can only be used for trial accounts. Accounts connected to Azure require Azure AD.
3228
> * There can be only one active account per email. If a user tries to sign in with [email protected] for LinkedIn and later with [email protected] for Google, the latter will display an error page, saying the user already exists.
33-
34-
2. Subscribe.
35-
36-
Select the [Products](https://api-portal.videoindexer.ai/products) tab. Then, select Authorization and subscribe.
3729
38-
![Products tab in the Video Indexer developer portal](./media/video-indexer-use-apis/authorization.png)
30+
![Sign in to Azure Video Indexer Developer Portal](./media/video-indexer-use-apis/sign-in.png)
31+
1. Subscribe.
32+
33+
Select the [Products](https://api-portal.videoindexer.ai/products) tab. Then, select **Authorization** and subscribe.
3934

4035
> [!NOTE]
4136
> New users are automatically subscribed to Authorization.
4237
43-
After you subscribe, you can find your subscription under **Products** -> **Profile**. In the subscription page, you will find the primary and secondary keys. The keys should be protected. The keys should only be used by your server code. They shouldn't be available on the client side (.js, .html, and so on).
38+
After you subscribe, you can find your subscription under **[Products](https://api-portal.videoindexer.ai/products)** -> **Profile**. In the subscriptions section, you'll find the primary and secondary keys. The keys should be protected. The keys should only be used by your server code. They shouldn't be available on the client side (.js, .html, and so on).
4439

4540
![Subscription and keys in Video Indexer Developer Portal](./media/video-indexer-use-apis/subscriptions.png)
4641

47-
> [!TIP]
48-
> Azure Video Indexer user can use a single subscription key to connect to multiple Azure Video Indexer accounts. You can then link these Azure Video Indexer accounts to different Media Services accounts.
42+
An Azure Video Indexer user can use a single subscription key to connect to multiple Azure Video Indexer accounts. You can then link these Azure Video Indexer accounts to different Media Services accounts.
4943

5044
## Obtain access token using the Authorization API
5145

@@ -96,6 +90,7 @@ The Account ID parameter is required in all operational API calls. Account ID is
9690
```
9791
https://www.videoindexer.ai/accounts/00000000-f324-4385-b142-f77dacb0a368/videos/d45bf160b5/
9892
```
93+
9994
## Recommendations
10095
10196
This section lists some recommendations when using Azure Video Indexer API.
@@ -113,18 +108,18 @@ When you're uploading videos by using the API, you have the following options:
113108
114109
### Getting JSON output
115110
116-
- When you call the API that gets video insights for the specified video, you get a detailed JSON output as the response content. [See details about the returned JSON in this topic](video-indexer-output-json-v2.md).
111+
- When you call the API that gets video insights for the specified video, you get a detailed JSON output as the response content. [See details about the returned JSON in this article](video-indexer-output-json-v2.md).
117112
- The JSON output produced by the API contains `Insights` and `SummarizedInsights` elements. We highly recommend using `Insights` and not using `SummarizedInsights` (which is present for backward compatibility).
118-
- We do not recommend that you use data directly from the artifacts folder for production purposes. Artifacts are intermediate outputs of the indexing process. They are essentially raw outputs of the various AI engines that analyze the videos; the artifacts schema may change over time.
113+
- We don't recommend that you use data directly from the artifacts folder for production purposes. Artifacts are intermediate outputs of the indexing process. They're essentially raw outputs of the various AI engines that analyze the videos; the artifacts schema may change over time.
119114
120-
It is recommended that you use the [Get Video Index](https://api-portal.videoindexer.ai/api-details#api=Operations&operation=Get-Video-Index) API, as described in [Get insights and artifacts produced by the API](video-indexer-output-json-v2.md#get-insights-produced-by-the-api) and **not** [Get-Video-Artifact-Download-Url](https://api-portal.videoindexer.ai/api-details#api=Operations&operation=Get-Video-Artifact-Download-Url).
115+
It's recommended that you use the [Get Video Index](https://api-portal.videoindexer.ai/api-details#api=Operations&operation=Get-Video-Index) API, as described in [Get insights and artifacts produced by the API](video-indexer-output-json-v2.md#get-insights-produced-by-the-api) and **not** [Get-Video-Artifact-Download-Url](https://api-portal.videoindexer.ai/api-details#api=Operations&operation=Get-Video-Artifact-Download-Url).
121116
122117
## Code sample
123118
124119
The following C# code snippet demonstrates the usage of all the Azure Video Indexer APIs together.
125120
126121
> [!NOTE]
127-
> The following sample is intended for Classic accounts only and not compatible with ARM accounts. For an updated sample for ARM please see [this ARM sample repo](https://github.com/Azure-Samples/media-services-video-indexer/blob/master/ApiUsage/ArmBased/Program.cs).
122+
> The following sample is intended for classic accounts only and not compatible with ARM-based accounts. For an updated sample for ARM (recommended), see [this ARM sample repo](https://github.com/Azure-Samples/media-services-video-indexer/blob/master/ApiUsage/ArmBased/Program.cs).
128123
129124
```csharp
130125
var apiUrl = "https://api.videoindexer.ai";
@@ -221,7 +216,7 @@ Debug.WriteLine(playerWidgetLink);
221216

222217
## Clean up resources
223218

224-
After you are done with this tutorial, delete resources that you are not planning to use.
219+
After you're done with this tutorial, delete resources that you aren't planning to use.
225220

226221
## See also
227222

0 commit comments

Comments
 (0)