How to create/construct endpoint URL/API for Copilot agents to call in Postman

Question

How to create/construct endpoint URL/API for Copilot agents to call in Postman

Prema 0

I have created and published an copilot agent and have my Client id, Client secret, tenant id, environment id, bot id with me. Kindly provide me the steps on how to construct the endpoint url to get the list of agents created in my copilot studio to use in Postman app.

Saideep Anchuri 9,425 Reputation points Microsoft External Staff Moderator

2025-05-23T02:47:59.4866667+00:00
Hi Prema

To construct an endpoint URL for your Copilot agent and use it in Postman,

Identify the Base URL

Microsoft Copilot Studio provides API endpoints for interacting with agents. The base URL typically follows this format:

https://api.copilotstudio.microsoft.com/{tenantId}/{environmentId}/agents

Replace {tenantId} and {environmentId} with your actual values.

Construct the Full Endpoint URL

To retrieve the list of agents, use:

https://api.copilotstudio.microsoft.com/{tenantId}/{environmentId}/agents/list

You may need to check the official documentation for the exact endpoint.

Set Up Authentication

Since you have your Client ID, Client Secret, Tenant ID, and Bot ID, you need to authenticate using OAuth 2.0:

Authorization URL: https://login.microsoftonline.com/{tenantId}/oauth2/token

Grant Type: Client Credentials

Headers:

Content-Type: application/x-www-form-urlencoded

Body Parameters:

`client_id={yourClientId}` `client_secret={yourClientSecret}` `grant_type=client_credentials` `resource=https://api.copilotstudio.microsoft.com`

Use Postman to Make the API Call

Open Postman.

Create a new request.

Set the method to GET.

Enter the constructed URL.

Go to the Authorization tab and select OAuth 2.0.

Enter the token obtained from the authentication step.

Click Send to retrieve the list of agents.

Kindly refer below link: https://learn.microsoft.com/en-us/microsoft-copilot-studio/authoring-http-node

Thank You.
Prema 0 Reputation points

2025-05-23T17:02:55.8933333+00:00

Hi Saideep,

I followed the steps and used the endpoint URL format you provided in Postman. I was able to successfully generate the token. However, I’m currently facing an issue when trying to retrieve the list of agents — I'm receiving the following error:

Error: getaddrinfo ENOTFOUND api.copilotstudio.microsoft.com

Additionally, the link you shared seems to focus on calling external APIs from Copilot agents, whereas I’m looking for guidance on how to call the Copilot Studio API to retrieve the list of agents configured.

Could you please help me:

Resolve the DNS error mentioned above.

Clarify the correct endpoint (if different) to retrieve agents configured in Copilot Studio.

Share any reference documentation or examples that show how to perform this specific API call.

Thanks in advance for your support!
Saideep Anchuri 9,425 Reputation points Microsoft External Staff Moderator

2025-05-24T04:22:55.9633333+00:00
Hi Prema

Resolving the DNS Error (ENOTFOUND)

The error suggests that your system is unable to resolve api.copilotstudio.microsoft.com. Here are a few things to check:

Network Issues: Ensure your internet connection is stable.

DNS Resolution: Run nslookup api.copilotstudio.microsoft.com or ping api.copilotstudio.microsoft.com in your terminal to check if the domain is reachable.

Firewall/VPN Restrictions: If you're behind a corporate firewall or VPN, verify that the domain isn't blocked.

Try a Different DNS Resolver: Switch to Google DNS (8.8.8.8) or Cloudflare DNS (1.1.1.1) and see if that helps.

Correct Endpoint for Retrieving Agents

The endpoint for listing agents in Copilot Studio might differ from the one you're using. You can check this Microsoft Learn page for details on extending Copilot agents with REST APIs.

Reference Documentation & Examples

You might find useful insights in this Stack Overflow discussion and this exercise guide that walks through making HTTP requests to connect to an API.

Thank You.
Smit Agrawal 95 Reputation points Microsoft External Staff

2025-05-26T05:59:02.75+00:00

Thanks for the query! We will check this and get back to you as soon as possible.

1 answer

Your answer

Saideep Anchuri 9,425 Reputation points Microsoft External Staff Moderator

2025-05-23T02:47:59.4866667+00:00

Hi Prema

To construct an endpoint URL for your Copilot agent and use it in Postman,

Identify the Base URL

Microsoft Copilot Studio provides API endpoints for interacting with agents. The base URL typically follows this format:

https://api.copilotstudio.microsoft.com/{tenantId}/{environmentId}/agents

Replace {tenantId} and {environmentId} with your actual values.

Construct the Full Endpoint URL

To retrieve the list of agents, use:

https://api.copilotstudio.microsoft.com/{tenantId}/{environmentId}/agents/list

You may need to check the official documentation for the exact endpoint.

Set Up Authentication

Since you have your Client ID, Client Secret, Tenant ID, and Bot ID, you need to authenticate using OAuth 2.0:

Authorization URL: https://login.microsoftonline.com/{tenantId}/oauth2/token

Grant Type: Client Credentials

Headers:

Content-Type: application/x-www-form-urlencoded

Body Parameters:

`client_id={yourClientId}` `client_secret={yourClientSecret}` `grant_type=client_credentials` `resource=https://api.copilotstudio.microsoft.com`

Use Postman to Make the API Call

Open Postman.

Create a new request.

Set the method to GET.

Enter the constructed URL.

Go to the Authorization tab and select OAuth 2.0.

Enter the token obtained from the authentication step.

Click Send to retrieve the list of agents.

Kindly refer below link: https://learn.microsoft.com/en-us/microsoft-copilot-studio/authoring-http-node

Thank You.
Prema 0 Reputation points

2025-05-23T17:02:55.8933333+00:00

Hi Saideep,

I followed the steps and used the endpoint URL format you provided in Postman. I was able to successfully generate the token. However, I’m currently facing an issue when trying to retrieve the list of agents — I'm receiving the following error:

Error: getaddrinfo ENOTFOUND api.copilotstudio.microsoft.com

Additionally, the link you shared seems to focus on calling external APIs from Copilot agents, whereas I’m looking for guidance on how to call the Copilot Studio API to retrieve the list of agents configured.

Could you please help me:

Resolve the DNS error mentioned above.

Clarify the correct endpoint (if different) to retrieve agents configured in Copilot Studio.

Share any reference documentation or examples that show how to perform this specific API call.

Thanks in advance for your support!
Saideep Anchuri 9,425 Reputation points Microsoft External Staff Moderator

2025-05-24T04:22:55.9633333+00:00

Hi Prema

Resolving the DNS Error (ENOTFOUND)

The error suggests that your system is unable to resolve api.copilotstudio.microsoft.com. Here are a few things to check:

Network Issues: Ensure your internet connection is stable.

DNS Resolution: Run nslookup api.copilotstudio.microsoft.com or ping api.copilotstudio.microsoft.com in your terminal to check if the domain is reachable.

Firewall/VPN Restrictions: If you're behind a corporate firewall or VPN, verify that the domain isn't blocked.

Try a Different DNS Resolver: Switch to Google DNS (8.8.8.8) or Cloudflare DNS (1.1.1.1) and see if that helps.

Correct Endpoint for Retrieving Agents

The endpoint for listing agents in Copilot Studio might differ from the one you're using. You can check this Microsoft Learn page for details on extending Copilot agents with REST APIs.

Reference Documentation & Examples

You might find useful insights in this Stack Overflow discussion and this exercise guide that walks through making HTTP requests to connect to an API.

Thank You.
Smit Agrawal 95 Reputation points Microsoft External Staff

2025-05-26T05:59:02.75+00:00

Thanks for the query! We will check this and get back to you as soon as possible.

Answer 1

Smit Agrawal 95 Microsoft External Staff

To list Copilot agents via Postman, use the Microsoft Power Platform API. First, acquire an access token using your Client ID, Client Secret, and Tenant ID via Azure AD token endpoint. Then, call the endpoint: https://api.bap.microsoft.com/providers/Microsoft.BusinessAppPlatform/environments/{environmentId}/copilotAgents?api-version=2023-10-01-preview Replace {environmentId} with your actual environment ID. Use the token in the Authorization header as Bearer <token>. This will return the list of agents created in your Copilot Studio. Ensure your app registration has the necessary API permissions for Power Platform

Thanks,

Smit Agrawal

If the response is helpful, please click on "upvote" button. You can share your feedback via Microsoft Copilot Developer Feedback link. Click here to escalate.

Smit Agrawal 95 Reputation points Microsoft External Staff

2025-05-27T20:52:21.6133333+00:00

I hope this answer helped!Feel free to discuss further queries if any.
Thanks
Prema 0 Reputation points

2025-05-28T13:42:01.09+00:00
Hi Smit Agrawal,

Kindly request your guidance regarding the necessary configuration for Copilot agents. Specifically, I would appreciate it if you could provide the following details:

A list of API permissions that need to be added for Copilot agents to function effectively.

Clarification on whether a separate App Registration is required for setting up Copilot agents.

The steps to construct the API endpoint to list all agents created in Copilot Studio.

Thanks!

Share via

How to create/construct endpoint URL/API for Copilot agents to call in Postman

1 answer

Your answer