Share via

Integrate with native apps using the Agents Client SDK

Important

This content is intended for experienced IT professionals, such as IT admins or developers, who are familiar with developer tools, utilities, and integrated development environments (IDEs). Creating this integration requires software development expertise.

Agents Client SDK is an SDK for Android, iOS, and Windows platforms. This SDK lets you communicate with agents developed using Copilot Studio or the Microsoft 365 Agents SDK, from native Android, iOS, and Windows apps.

With Agents Client SDK, we're introducing multimodality to user-agent interaction. Users can now communicate with agents through text or voice, while sharing context through images or screen capture.

The first version of the SDK supports text-based communication and adaptive cards rendering for unauthenticated or anonymous end users with agents created in Copilot Studio. You can add adaptive cards to topics using the Ask with adaptive card option.

Important

Currently the SDK supports only unauthenticated users and can be used in native apps if you deem such usage appropriate and necessary for your end users.

Configure your agent for native apps

  1. Go to your agent in Copilot Studio by selecting Agents and then your agent.

  2. Under Settings > Security > Authentication, select No Authentication.

    Screenshot of the No Authentication security setting enabled for an agent in Copilot Studio.

  3. Go to the Channels page for your agent.

    With No authentication selected, a review is recommended.

    Screenshot of the Channels page for the agent showing review recommended due to No authentication selection.

  4. Select Publish.

    The Publish this agent screen appears.

    Screenshot of the publish confirmation screen for the agent in Copilot Studio.

  5. Select Publish. Your agent is published and available for use with the Client SDK.

Get the information you need to integrate with the SDK

Before you add integration for your agent into your app code, you need some details from Copilot Studio about your agent.

  1. Go your agent in Copilot Studio by selecting Agents and then selecting your agent.

  2. Go to Settings > Advanced settings > Metadata.

    Take note of the Environment ID and Schema name.

    Screenshot of the Advanced settings page showing environmentID and schema name for the agent.

  3. Take note of the deployment environment for your agent. For copilotstudio.microsoft.com and copilotstudio.preview.microsoft.com, the deployment environment is prod. For copilotstudio.preprod.microsoft.com, the deployment environment is preprod.

Learn more about the Agents Client SDK

Next, using the information you gathered, you can integrate your agent into your native app code using the Agents Client SDK.

For code and more information about how to integrate your agent into your native app, check out the GitHub repo for your app platform of choice:

  • Last updated on