Authenticate with Microsoft Web IQ

There are two ways to authenticate and gain access to the Microsoft Web IQ APIs. Use an API key for the quickest start and Microsoft Entra ID for production workloads.

API key

Create an API key in the Microsoft Web IQ portal to authenticate with Microsoft Web IQ APIs. Pass it in the x-apikey header on every request:

x-apikey: <YOUR_API_KEY>

Microsoft Entra ID

Use Microsoft Entra ID OAuth 2.0 Client Credentials (app-only token) for authenticating with the Microsoft Web IQ API.

Prerequisites

1. Set up a tenant: To register your app, an Azure tenant is required. An Azure subscription isn't required, but if your organization already has one or more Azure subscriptions or a Microsoft 365 organization, then you already have an Azure tenant. Otherwise, provision a new tenant.

2. Create an app registration: An app registration establishes a trust relationship between your application and the Microsoft identity platform, enabling your app to authenticate and access resources securely.

   When you register your app, a client ID, object ID, and directory ID are created. To create credentials for your app registration, see Register an application with the Microsoft identity platform.

Entra ID setup steps

1. App registration - Use an existing Microsoft Entra ID app registration or create one. Record its Application (client) ID. In the Azure portal, find it under Microsoft Entra ID > App registrations > your app > Overview.

2. Bind your app registration - Go to Profile Management, select the Application (Client) IDs tab, and then select Bind Application (Client) ID. Enter your Entra application (client) ID. Profile updates can take up to one minute to synchronize.

   Note

   If the Application (Client) IDs tab isn't available, Microsoft Entra ID authentication might not be enabled for your trial. Contact your Microsoft representative to request dedicated access.

3. Acquire a token - Use the client credentials grant with your preferred Microsoft Authentication Library (MSAL):

   • Authority: https://login.microsoftonline.com/{your-tenant-id}
   • Scope: https://api.microsoft.ai/.default

Then pass the access token on every Web IQ request:

Authorization: Bearer <access-token>

Calling more than one AppID

One Entra application (client) ID can be bound to more than one Web IQ AppID, for example one AppID per Web IQ resource or per workload. When it is, add the APPID query parameter to every request to choose which AppID the call uses. Rate limits count against that AppID.

POST https://api.microsoft.ai/v3/search/web?APPID=<your-web-iq-appid>
Authorization: Bearer <access-token>
Content-Type: application/json

APPID takes your Web IQ AppID, not your Entra application (client) ID. Your Microsoft contact provides your Web IQ AppIDs.

Request headers

Next steps

• Make your first call in the quickstart.
• Explore the REST API reference.

Support and feedback

Send technical issues or feedback to Web IQ Support.