Product Ingestion API for Microsoft Copilot Studio Connector or Agent - public preview

Note

Now available for public preview!

This article covers product-specific guidance for Microsoft Copilot Studio Connector or Agent. For shared concepts like authentication, core API methods, resource-tree queries, configuration requests, and lifecycle management, see the Product Ingestion API documentation.

Tip

You can now create and manage Microsoft Copilot Studio connector and agent offers with AI agents by using the Marketplace Ingestion MCP server, which connects tools like GitHub Copilot and Visual Studio Code to the Product Ingestion API.

Note

Your Microsoft Entra app registration must be in the seller-associated tenant (the tenant linked to your Partner Center seller account). App tokens from a corporate or Microsoft-homed Entra tenant won't work.

Note

Microsoft Copilot Studio Connector or Agent products don't have a listing resource. Product information is derived from the Power Platform Connector package.

Retrieve existing resource configurations

To retrieve the current configuration for a Microsoft Copilot Studio Connector or Agent product, use the resource-tree endpoint with the product's durable ID:

GET https://graph.microsoft.com/rp/product-ingestion/resource-tree/product/12345678-abcd-efgh-1234-12345678901?$version=2026-04-01-preview1

Sample response:

{
  "$schema": "https://schema.mp.microsoft.com/schema/resource-tree/2022-03-01-preview2",
  "root": "product/12345678-abcd-efgh-1234-12345678901",
  "target": {
    "targetType": "preview"
  },
  "resources": [
    {
      "$schema": "https://schema.mp.microsoft.com/schema/product/2026-04-01-preview1",
      "id": "product/12345678-abcd-efgh-1234-12345678901",
      "identity": {
        "externalId": "my-copilot-connector"
      },
      "type": "copilotStudioConnector",
      "alias": "My Copilot Studio Connector"
    },
    {
      "$schema": "https://schema.mp.microsoft.com/schema/property/2026-04-01-preview1",
      "id": "property/12345678-abcd-efgh-1234-12345678902",
      "product": "product/12345678-abcd-efgh-1234-12345678901",
      "kind": "copilotStudioConnector",
      "categories": ["ai-machine-learning"],
      "termsConditions": "standardMicrosoft"
    }
  ]
}

Create a new Microsoft Copilot Studio Connector or Agent product

To create a new Microsoft Copilot Studio Connector or Agent product, submit a configure request with the product resource. Set type to copilotStudioConnector.

POST https://graph.microsoft.com/rp/product-ingestion/configure?$version=2026-04-01-preview1

Request body:

{
  "$schema": "https://schema.mp.microsoft.com/schema/configure/2022-03-01-preview2",
  "resources": [
    {
      "$schema": "https://schema.mp.microsoft.com/schema/product/2026-04-01-preview1",
      "resourceName": "myNewProduct",
      "identity": {
        "externalId": "my-new-copilot-connector"
      },
      "type": "copilotStudioConnector",
      "alias": "My New Copilot Studio Connector"
    }
  ]
}

Sample response:

{
  "$schema": "https://schema.mp.microsoft.com/schema/configure-status/2022-03-01-preview2",
  "jobId": "87654321-dcba-hgfe-4321-109876543210",
  "jobStatus": "running",
  "jobResult": "pending",
  "jobStart": "2026-04-01T10:00:00.0000000Z",
  "resourceStatuses": [
    {
      "resourceName": "myNewProduct",
      "status": "running"
    }
  ]
}

Configure properties

The property resource defines categories and terms and conditions for your Microsoft Copilot Studio Connector or Agent product. Set kind to copilotStudioConnector.

POST https://graph.microsoft.com/rp/product-ingestion/configure?$version=2026-04-01-preview1

Request body:

{
  "$schema": "https://schema.mp.microsoft.com/schema/configure/2022-03-01-preview2",
  "resources": [
    {
      "$schema": "https://schema.mp.microsoft.com/schema/property/2026-04-01-preview1",
      "id": "property/12345678-abcd-efgh-1234-12345678902",
      "product": "product/12345678-abcd-efgh-1234-12345678901",
      "kind": "copilotStudioConnector",
      "categories": ["ai-machine-learning", "developer-tools"],
      "termsConditions": "standardMicrosoft",
      "termsOfUseUrl": "https://contoso.com/terms",
      "privacyPolicyUrl": "https://contoso.com/privacy",
      "supportDocumentUrl": "https://contoso.com/support"
    }
  ]
}

Property fields

Field Required Description
kind Yes Must be copilotStudioConnector
product Yes Reference to the product resource
categories Yes Array of category identifiers
termsConditions Yes Either custom or standardMicrosoft
termsOfUseUrl No URL to your terms of use
privacyPolicyUrl No URL to your privacy policy
supportDocumentUrl No URL to your support documentation

Note

Microsoft Copilot Studio Connector or Agent doesn't support industries or cloudIndustries properties.

Configure Microsoft 365 setup

The Microsoft 365 setup resource configures Entra ID requirements, target cloud plans, and Apple Store availability.

POST https://graph.microsoft.com/rp/product-ingestion/configure?$version=2026-04-01-preview1

Request body:

{
  "$schema": "https://schema.mp.microsoft.com/schema/configure/2022-03-01-preview2",
  "resources": [
    {
      "$schema": "https://schema.mp.microsoft.com/schema/microsoft365-setup/2026-04-01-preview1",
      "product": "product/12345678-abcd-efgh-1234-12345678901",
      "requiresEntraId": true,
      "targetPlan": "gbl",
      "additionalPurchaseRequired": false,
      "appleStoreAvailability": false
    }
  ]
}

Microsoft 365 setup fields

Field Required Description
product Yes Reference to the product resource
requiresEntraId No Whether Entra ID authentication is required
targetPlan No Target cloud plan: chn (China), gbl (Global), ger (Germany), gov (Government)
additionalPurchaseRequired No Whether additional purchases are required
appleStoreAvailability No Whether the product is available in the Apple Store

Configure technical configuration

The technical configuration for Microsoft Copilot Studio Connector or Agent uses a payload-based model with authentication. You upload your Power Platform Connector package to Azure Blob Storage and provide the SAS URI along with authentication settings.

Authentication types

Microsoft Copilot Studio Connector or Agent supports two authentication types:

Auth type Description Required fields
none No authentication required sasUri, authType
oAuth OAuth 2.0 authentication sasUri, authType, clientId, secret

Technical configuration without authentication

If your connector doesn't require authentication, set authType to none:

POST https://graph.microsoft.com/rp/product-ingestion/configure?$version=2026-04-01-preview1

Request body:

{
  "$schema": "https://schema.mp.microsoft.com/schema/configure/2022-03-01-preview2",
  "resources": [
    {
      "$schema": "https://schema.mp.microsoft.com/schema/copilot-studio-connector-technical-configuration/2026-04-01-preview1",
      "product": "product/12345678-abcd-efgh-1234-12345678901",
      "payloads": [
        {
          "payload": {
            "sasUri": "https://yourstorageaccount.blob.core.windows.net/uploads/connector.zip?sv=...",
            "authType": "none"
          }
        }
      ]
    }
  ]
}

Technical configuration with OAuth authentication

If your connector requires OAuth authentication, set authType to oAuth and provide the clientId and secret:

POST https://graph.microsoft.com/rp/product-ingestion/configure?$version=2026-04-01-preview1

Request body:

{
  "$schema": "https://schema.mp.microsoft.com/schema/configure/2022-03-01-preview2",
  "resources": [
    {
      "$schema": "https://schema.mp.microsoft.com/schema/copilot-studio-connector-technical-configuration/2026-04-01-preview1",
      "product": "product/12345678-abcd-efgh-1234-12345678901",
      "payloads": [
        {
          "payload": {
            "sasUri": "https://yourstorageaccount.blob.core.windows.net/uploads/connector.zip?sv=...",
            "authType": "oAuth",
            "clientId": "12345678-abcd-efgh-1234-12345678901",
            "secret": "your-client-secret-value"
          }
        }
      ]
    }
  ]
}

Technical configuration payload fields

Field Required Description
sasUri Yes Azure Blob SAS URI for the Power Platform Connector package
authType Yes Authentication type: none or oAuth
clientId Conditional OAuth client ID. Required when authType is oAuth.
secret Conditional OAuth client secret. Required when authType is oAuth.

Important

Microsoft Copilot Studio Connector or Agent doesn't support payloadId for reusing previously uploaded payloads. You must always provide a fresh sasUri with each configuration request.

Updating OAuth credentials

To update the OAuth credentials for an existing connector, submit a new configuration request with the updated values:

{
  "$schema": "https://schema.mp.microsoft.com/schema/configure/2022-03-01-preview2",
  "resources": [
    {
      "$schema": "https://schema.mp.microsoft.com/schema/copilot-studio-connector-technical-configuration/2026-04-01-preview1",
      "product": "product/12345678-abcd-efgh-1234-12345678901",
      "payloads": [
        {
          "payload": {
            "sasUri": "https://yourstorageaccount.blob.core.windows.net/uploads/connector.zip?sv=...",
            "authType": "oAuth",
            "clientId": "87654321-dcba-hgfe-4321-109876543210",
            "secret": "your-new-client-secret-value"
          }
        }
      ]
    }
  ]
}

Masking secrets in responses

When you retrieve the technical configuration, the secret value is masked for security:

{
  "$schema": "https://schema.mp.microsoft.com/schema/copilot-studio-connector-technical-configuration/2026-04-01-preview1",
  "id": "copilot-studio-connector-technical-configuration/12345678-abcd-efgh-1234-12345678905",
  "product": "product/12345678-abcd-efgh-1234-12345678901",
  "payloads": [
    {
      "payload": {
        "authType": "oAuth",
        "clientId": "12345678-abcd-efgh-1234-12345678901",
        "secret": "*********"
      }
    }
  ]
}

Publishing

Publish to live

{
  "$schema": "https://schema.mp.microsoft.com/schema/configure/2022-03-01-preview2",
  "resources": [
    {
      "$schema": "https://schema.mp.microsoft.com/schema/submission/2026-04-01-preview1",
      "id": "submission/12345678-abcd-efgh-1234-12345678904",
      "product": "product/12345678-abcd-efgh-1234-12345678901",
      "target": {
        "targetType": "live"
      }
    }
  ]
}

Important

A successful configure response doesn't guarantee a successful submission. The configure endpoint is more permissive than the submission pipeline. Validate your full resource tree before submitting.

Note

Microsoft Copilot Studio Connector or Agent products are free-only. Pricing is managed internally and isn't configurable through the API.

Resource lifecycle states

Resources support lifecycle state management. To deprecate a resource, set lifecycleState to deleted:

{
  "$schema": "https://schema.mp.microsoft.com/schema/configure/2022-03-01-preview2",
  "resources": [
    {
      "$schema": "https://schema.mp.microsoft.com/schema/property/2026-04-01-preview1",
      "id": "property/12345678-abcd-efgh-1234-12345678902",
      "product": "product/12345678-abcd-efgh-1234-12345678901",
      "kind": "copilotStudioConnector",
      "categories": ["ai-machine-learning"],
      "termsConditions": "standardMicrosoft",
      "lifecycleState": "deleted"
    }
  ]
}

To restore a deprecated resource, set lifecycleState back to generallyAvailable.

For more details on lifecycle management, see the base API documentation.

Resource API reference

Resource type Description Schema URL
product Main resource defining product name and type https://schema.mp.microsoft.com/schema/product/2026-04-01-preview1
property Categories and legal contracts https://schema.mp.microsoft.com/schema/property/2026-04-01-preview1
microsoft365-setup M365-specific setup configuration https://schema.mp.microsoft.com/schema/microsoft365-setup/2026-04-01-preview1
copilot-studio-connector-technical-configuration Technical configuration with connector package and auth https://schema.mp.microsoft.com/schema/copilot-studio-connector-technical-configuration/2026-04-01-preview1
submission Publishing state and actions https://schema.mp.microsoft.com/schema/submission/2026-04-01-preview1

API versions and updates

Version Description
2026-04-01-preview1 Initial preview release for Microsoft Copilot Studio Connector or Agent support

Related content

  • Last updated on