Microsoft Copilot Studio (Preview)
Microsoft Copilot Studio used to discover and trigger agents
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Standard | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Standard | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Automate | Standard | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Connector Metadata | |
|---|---|
| Publisher | Microsoft |
General Limits
| Name | Value |
|---|---|
| Connections per account | 50 |
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 300 | 60 seconds |
Actions
| Continue Turn [DEPRECATED] |
Sends a prompt to the specified Copilot for continue after Step 1 |
| EAP - Adds a card to the specified agent [DEPRECATED] |
Adds a card to the specified agent |
| EAP - Discover Microsoft Copilot Studio Agents [DEPRECATED] |
Discover agents running in Microsoft Copilot Studio |
| EAP - Gives feedback for Copilot run action [DEPRECATED] |
Gives feedback for Copilot run action |
| EAP - Sends a callback to specified Copilot to proceed with a pending action [DEPRECATED] |
Sends a callback to the specified Copilot to proceed with a pending action |
| EAP - Sends a prompt to the specified Copilot for asynchronous processing [DEPRECATED] |
Sends a prompt to the specified Copilot for processing |
| EAP - Sends a prompt to the specified Copilot for processing [DEPRECATED] |
Sends a prompt to the specified Copilot for processing |
| EAP - Sends prompt to specified Copilot for processing and expects JSON back [DEPRECATED] |
Sends prompt to the specified Copilot for processing and expects JSON response |
| Execute Copilot |
Sends a prompt to the specified Copilot for processing |
| Execute Copilot and wait [DEPRECATED] |
Sends a prompt to the specified Copilot for processing and wait to resume |
| Execute Copilot and wait for response V1 [DEPRECATED] |
Sends a prompt to the specified Copilot for processing |
| Execute Turn [DEPRECATED] |
Sends a prompt to the specified Copilot to start processing |
| Step 1 Start Conversation for First Party Copilot [DEPRECATED] |
Sends a prompt to the specified 1P Copilot to start processing |
| Step 2 Continue Conversation First Party Copilot [DEPRECATED] |
Sends a prompt to the specified 1P Copilot for continue after Step 1 |
Continue Turn [DEPRECATED]
Sends a prompt to the specified Copilot for continue after Step 1
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Copilot
|
Copilot | True | string | |
|
ConversationId
|
ConversationId | True | string | |
|
|
object |
A flexible object that accepts any properties. |
||
|
environmentId
|
environmentId | string |
Optional environment ID |
EAP - Adds a card to the specified agent [DEPRECATED]
Adds a card to the specified agent
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
AgentId
|
AgentId | True | string | |
|
name
|
name | string |
name |
|
|
id
|
id | string |
id |
EAP - Discover Microsoft Copilot Studio Agents [DEPRECATED]
Discover agents running in Microsoft Copilot Studio
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string |
id |
|
description
|
description | string |
description |
EAP - Gives feedback for Copilot run action [DEPRECATED]
Gives feedback for Copilot run action
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
AgentId
|
AgentId | True | string | |
|
agentRunId
|
agentRunId | uuid |
Either agentRunId and agentRunActionId, or cardSessionData must be provided |
|
|
agentRunActionId
|
agentRunActionId | uuid |
Either agentRunId and agentRunActionId, or cardSessionData must be provided |
|
|
cardSessionData
|
cardSessionData | string |
Either agentRunId and agentRunActionId, or cardSessionData must be provided |
|
|
feedbackValue
|
feedbackValue | string |
feedbackValue is required and must be either Positive or Negative |
EAP - Sends a callback to specified Copilot to proceed with a pending action [DEPRECATED]
Sends a callback to the specified Copilot to proceed with a pending action
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
AgentId
|
AgentId | True | string | |
|
conversationId
|
conversationId | string |
conversationId |
|
|
message
|
message | string |
message |
|
|
channelType
|
channelType | string |
channelType |
Returns
The response of the agent as text
- Copilot response
- string
EAP - Sends a prompt to the specified Copilot for asynchronous processing [DEPRECATED]
Sends a prompt to the specified Copilot for processing
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
AgentId
|
AgentId | True | string | |
|
conversationId
|
conversationId | string |
conversationId |
|
|
message
|
message | string |
message |
|
|
channelType
|
channelType | string |
channelType |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
message
|
message | string |
message |
|
pollingUrl
|
pollingUrl | string |
message |
EAP - Sends a prompt to the specified Copilot for processing [DEPRECATED]
Sends a prompt to the specified Copilot for processing
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
AgentId
|
AgentId | True | string | |
|
conversationId
|
conversationId | string |
conversationId |
|
|
message
|
message | string |
message |
|
|
channelType
|
channelType | string |
channelType |
Returns
The response of the Copilot as text
- Copilot response
- byte
EAP - Sends prompt to specified Copilot for processing and expects JSON back [DEPRECATED]
Sends prompt to the specified Copilot for processing and expects JSON response
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
AgentId
|
AgentId | True | string | |
|
conversationId
|
conversationId | string |
conversationId |
|
|
message
|
message | string |
message |
|
|
channelType
|
channelType | string |
channelType |
Returns
Agent response
Execute Copilot
Sends a prompt to the specified Copilot for processing
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Copilot
|
Copilot | True | string | |
|
message
|
message | string |
Message |
|
|
Conversation ID
|
x-ms-conversation-id | string |
Provide exisiting conversation id to resume Copilot execution. |
|
|
environmentId
|
environmentId | string |
Optional environment ID |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
ConversationId
|
ConversationId | string |
The conversation ID associated with the response |
Execute Copilot and wait [DEPRECATED]
Sends a prompt to the specified Copilot for processing and wait to resume
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Copilot
|
Copilot | True | string | |
|
message
|
message | string |
Message |
|
|
Conversation ID
|
x-ms-conversation-id | string |
Provide exisiting conversation id to resume Copilot execution. |
|
|
environmentId
|
environmentId | string |
Optional environment ID |
Returns
- response
- string
Execute Copilot and wait for response V1 [DEPRECATED]
Sends a prompt to the specified Copilot for processing
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Copilot
|
Copilot | True | string | |
|
message
|
message | string |
Message |
|
|
Conversation ID
|
x-ms-conversation-id | string |
Provide exisiting conversation id to resume Copilot execution. |
|
|
environmentId
|
environmentId | string |
Optional environment ID |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
responses
|
responses | array of string | |
|
conversationId
|
conversationId | string |
The conversation ID associated with the response |
|
Completed
|
Completed | boolean |
Instruction has been fully executed to completion |
Execute Turn [DEPRECATED]
Sends a prompt to the specified Copilot to start processing
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Copilot
|
Copilot | True | string | |
|
ConversationId
|
ConversationId | True | string | |
|
|
object |
A flexible object that accepts any properties. |
||
|
environmentId
|
environmentId | string |
Optional environment ID |
Step 1 Start Conversation for First Party Copilot [DEPRECATED]
Sends a prompt to the specified 1P Copilot to start processing
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Copilot
|
Copilot | True | string | |
|
ConversationId
|
ConversationId | True | string | |
|
|
object |
A flexible object that accepts any properties. |
||
|
environmentId
|
environmentId | string |
Optional environment ID |
Step 2 Continue Conversation First Party Copilot [DEPRECATED]
Sends a prompt to the specified 1P Copilot for continue after Step 1
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Copilot
|
Copilot | True | string | |
|
ConversationId
|
ConversationId | True | string | |
|
|
object |
A flexible object that accepts any properties. |
||
|
environmentId
|
environmentId | string |
Optional environment ID |
Triggers
| EAP - Trigger fired by a Microsoft Copilot Studio agent [DEPRECATED] |
Trigger fired by a Microsoft Copilot Studio agent |
EAP - Trigger fired by a Microsoft Copilot Studio agent [DEPRECATED]
Trigger fired by a Microsoft Copilot Studio agent
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
AgentId
|
AgentId | True | string | |
|
name
|
name | string |
function name in maven |
|
|
description
|
description | string |
description for consideration by maven router |
|
|
schema
|
schema | string |
equivalent to openai tool definition |
|
|
executionBehavior
|
executionBehavior | string |
Default causes full pipeline to run. EndTurnPreserveFormat skips any formatting and terminates tool chain which is useful for scenarios like rendering cards. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
agentId
|
agentId | string |
agentId |
|
payload
|
parameters.payload | string |
payload |
Definitions
ExecuteAgentJsonResponse
Agent response
| Name | Path | Type | Description |
|---|---|---|---|
|
Message
|
message | string |
Message |
string
This is the basic data type 'string'.
byte
This is the basic data type 'byte'.