Microsoft Copilot Studio
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 High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Standard | All Power Apps regions except the following: - 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 High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Microsoft Copilot Studio |
| URL | https://aka.ms/copilotstudio |
| donglei@microsoft.com |
| Connector Metadata | |
|---|---|
| Publisher | Microsoft |
| Website | https://aka.ms/copilotstudio |
| Privacy policy | https://www.microsoft.com/en-us/privacy/privacystatement |
| Categories | AI |
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
| Evaluate Agent |
Evaluates an agent using a specific test set. |
| Execute Agent |
Sends a prompt to the specified Agent for processing |
| Execute Agent and wait |
Sends a prompt to the specified Agent for processing and wait to resume |
| Get Agent Test Run Details |
Gets the details of a specific maker evaluation test run. |
| Get Agent Test Runs |
Gets maker evaluation test runs for the specified Agent. |
| Get Agent Test Set Details |
Gets the details of a specific maker evaluation test set. |
| Get Agent Test Sets |
Gets the test sets for an Agent. |
Evaluate Agent
Evaluates an agent using a specific test set.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Agent
|
Agent | True | string |
select an agent from the dropdown list, or enter a custom value (the agent ID). |
|
Test Set
|
TestSetId | True | string |
Select a test set from the dropdown list, or enter a custom value (the test set ID). |
|
MCS Connection ID
|
mcsConnectionId | string |
Select User profile - Enter the MCS connection ID or leave empty for anonymous run. |
|
|
Evaluation run name
|
evaluationRunName | string |
Enter a name for the evaluation run or leave empty. |
Execute Agent
Sends a prompt to the specified Agent for processing
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Agent
|
Copilot | True | string |
Agent |
|
message
|
message | string |
Message |
|
|
A BCP-47 locale name for the contents of the text field.
|
locale | string |
A BCP-47 locale name for the contents of the text field. |
|
|
contentType
|
contentType | string | ||
|
contentUrl
|
contentUrl | string | ||
|
content
|
content | object | ||
|
name
|
name | string | ||
|
thumbnailUrl
|
thumbnailUrl | string | ||
|
Conversation ID
|
x-ms-conversation-id | string |
Provide exisiting conversation id to resume Agent execution. |
|
|
Environment ID
|
environmentId | string |
Optional environment ID |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
ConversationId
|
ConversationId | string |
The conversation ID associated with the response |
Execute Agent and wait
Sends a prompt to the specified Agent for processing and wait to resume
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Agent
|
Copilot | True | string |
Agent |
|
Message
|
message | string |
Message |
|
|
A BCP-47 locale name for the contents of the text field.
|
locale | string |
A BCP-47 locale name for the contents of the text field. |
|
|
contentType
|
contentType | string | ||
|
contentUrl
|
contentUrl | string | ||
|
content
|
content | object | ||
|
name
|
name | string | ||
|
thumbnailUrl
|
thumbnailUrl | string | ||
|
Conversation ID
|
x-ms-conversation-id | string |
Provide exisiting conversation id to resume Agent execution. |
|
|
Environment ID
|
environmentId | string |
Optional environment ID |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
lastResponse
|
lastResponse | string |
The last text response in the activities list |
|
responses
|
responses | array of string |
The list of string responses in the activities list |
|
conversationId
|
conversationId | string |
The conversation ID associated with the response |
Get Agent Test Run Details
Gets the details of a specific maker evaluation test run.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Agent
|
Agent | True | string |
select an agent from the dropdown list, or enter a custom value (the agent ID). |
|
Evaluation Run
|
EvaluationRunId | True | string |
Select evaluation run from the dropdown list, or enter a custom value (the evaluation run ID). |
Returns
- Body
- TestRun
Get Agent Test Runs
Gets maker evaluation test runs for the specified Agent.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Agent
|
Agent | True | string |
select an agent from the dropdown list, or enter a custom value (the agent ID). |
Returns
- Body
- TestRunsResponse
Get Agent Test Set Details
Gets the details of a specific maker evaluation test set.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Agent
|
Agent | True | string |
select an agent from the dropdown list, or enter a custom value (the agent ID). |
|
Test Set
|
TestSetId | True | string |
Select a test set from the dropdown list, or enter a custom value (the test set ID). |
Returns
- Body
- TestSet
Get Agent Test Sets
Gets the test sets for an Agent.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Agent
|
Agent | True | string |
select an agent from the dropdown list, or enter a custom value (the agent ID). |
Returns
- Body
- TestSetsResponse
Definitions
TestSetsResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
value
|
value | array of TestSet |
TestSet
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string | |
|
displayName
|
displayName | string | |
|
totalTestCases
|
totalTestCases | integer | |
|
description
|
description | string | |
|
auditInfo
|
auditInfo | AuditInfo | |
|
state
|
state | string |
AuditInfo
| Name | Path | Type | Description |
|---|---|---|---|
|
createdBy
|
createdBy | string | |
|
createdTimeUtc
|
createdTimeUtc | date-time | |
|
modifiedBy
|
modifiedBy | string | |
|
modifiedTimeUtc
|
modifiedTimeUtc | date-time |
TestRunsResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
value
|
value | array of TestRun |
TestRun
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string | |
|
environmentId
|
environmentId | string | |
|
cdsBotId
|
cdsBotId | string | |
|
ownerId
|
ownerId | string | |
|
testSetId
|
testSetId | string | |
|
state
|
state | string | |
|
startTime
|
startTime | date-time | |
|
endTime
|
endTime | date-time | |
|
name
|
name | string | |
|
totalTestCases
|
totalTestCases | integer | |
|
msConnectionId
|
msConnectionId | string |