Scribe Search API integration with Microsoft Copilot Agent
Mirza Delic
41 steps
5 minutes
Scribe
Microsoft
Scribe API Token Setup.
1
Click "Settings"
2
Click "Developer AccessNewManage API tokens and developer access"
3
Click "Generate Token"
4
Input name and select all teams or choose specific teams Click this button.
5
Click "Generate Token"
6
Click "Copy" on the popup for the new token\ \ *Keep in mind that this popup is shown only once.*
Convert OpenAPI 3 to Swagger 2.0 Schema
Microsoft Copilot doesn't support OpenAPI version 3 schema yet, so we need to downgrade to Swagger 2.0.
7
Go to <https://public-api.scribehow.com/schema/swagger/>, click link to download OpenAPI Schema and save it
8
Go to ChatGPT, input "Convert me this OpenAPI 3 schema to Swagger 2.0" and upload downloaded file from previous step
9
Click "Copy"
Copilot Setup
10
Go to <https://copilotstudio.microsoft.com/>
11
Click "Agents"
12
Click "+ New agent"
13
Click "Skip to configure"
14
Set name of the agent
15
Set instructions for agent, we used this: --- 1. *Take the user's input, get keywords from the input, but be precise, only take keywords* 2. *Go to the search action use keywords separated with space as "search" query parameter, use "type" query parameter if the user specifies "scribe" or "page"* 3. *At the end sort by relevant documents based on full input* *Return only the title that are clickable with details: author, type, created, and updated date times.Every time a user wants to filter something again, do it with request on the API again.* --- **Note:** The following instructions for Copilot are intended for testing purposes and should be implemented using a more robust and appropriate approach in production.
16
Click "Create"
17
Click "Tools"
18
Click "+ New tool"
19
Click "Custom connector"
20
Click "+ New custom connector"
21
Click "Create from blank"
22
Set name of the connector
23
Click "Continue"
24
Go back to previous tab for connector
25
Click "Swagger editor"
26
Replace content with copied from ChatGPT and click "Create connector" from [second section](https://scribehow.com/viewer/Scribe_Search_API_integration_with_Microsoft_Copilot_Agent__sjs1GIfITJ2L5BOUV-66IA?scrollToActionId=f1d91f62)
27
Go back to list of connectors
28
Click "+" sign on the newly created connector
29
Input copied API token from [first section](https://scribehow.com/viewer/Scribe_Search_API_integration_with_Microsoft_Copilot_Agent__sjs1GIfITJ2L5BOUV-66IA?scrollToActionId=b6c52498)
30
Click "Agents"
31
Click "Agents - Microsoft Copilot Studio"
32
Click on the newly created agent
33
Click "Tools"
34
Click "+ Add a tool"
35
Click "Connector"
36
Search for "scribe" and click on "v1_search_documents"
37
Click "Add to agent"
38
1. Go to Agent details page 2. Open "Test" side bar 3. Input "Search for google calendar documents" 4. Click "Open connection manager"
39
Click "Connect"
40
Click "Submit"
41
Go back to previous tab and click "Retry", it will show documents with info and link
Scribe Search API integration with Microsoft Copilot Agent
Mirza Delic
41 steps
5 minutes
Scribe
Microsoft
Scribe API Token Setup.
1
Click "Settings"
2
Click "Developer AccessNewManage API tokens and developer access"
3
Click "Generate Token"
4
Input name and select all teams or choose specific teams Click this button.
5
Click "Generate Token"
6
Click "Copy" on the popup for the new token\ \ *Keep in mind that this popup is shown only once.*
Convert OpenAPI 3 to Swagger 2.0 Schema
Microsoft Copilot doesn't support OpenAPI version 3 schema yet, so we need to downgrade to Swagger 2.0.
7
Go to <https://public-api.scribehow.com/schema/swagger/>, click link to download OpenAPI Schema and save it
8
Go to ChatGPT, input "Convert me this OpenAPI 3 schema to Swagger 2.0" and upload downloaded file from previous step
9
Click "Copy"
Copilot Setup
10
Go to <https://copilotstudio.microsoft.com/>
11
Click "Agents"
12
Click "+ New agent"
13
Click "Skip to configure"
14
Set name of the agent
15
Set instructions for agent, we used this: --- 1. *Take the user's input, get keywords from the input, but be precise, only take keywords* 2. *Go to the search action use keywords separated with space as "search" query parameter, use "type" query parameter if the user specifies "scribe" or "page"* 3. *At the end sort by relevant documents based on full input* *Return only the title that are clickable with details: author, type, created, and updated date times.Every time a user wants to filter something again, do it with request on the API again.* --- **Note:** The following instructions for Copilot are intended for testing purposes and should be implemented using a more robust and appropriate approach in production.
16
Click "Create"
17
Click "Tools"
18
Click "+ New tool"
19
Click "Custom connector"
20
Click "+ New custom connector"
21
Click "Create from blank"
22
Set name of the connector
23
Click "Continue"
24
Go back to previous tab for connector
25
Click "Swagger editor"
26
Replace content with copied from ChatGPT and click "Create connector" from [second section](https://scribehow.com/viewer/Scribe_Search_API_integration_with_Microsoft_Copilot_Agent__sjs1GIfITJ2L5BOUV-66IA?scrollToActionId=f1d91f62)
27
Go back to list of connectors
28
Click "+" sign on the newly created connector
29
Input copied API token from [first section](https://scribehow.com/viewer/Scribe_Search_API_integration_with_Microsoft_Copilot_Agent__sjs1GIfITJ2L5BOUV-66IA?scrollToActionId=b6c52498)
30
Click "Agents"
31
Click "Agents - Microsoft Copilot Studio"
32
Click on the newly created agent
33
Click "Tools"
34
Click "+ Add a tool"
35
Click "Connector"
36
Search for "scribe" and click on "v1_search_documents"
37
Click "Add to agent"
38
1. Go to Agent details page 2. Open "Test" side bar 3. Input "Search for google calendar documents" 4. Click "Open connection manager"
39
Click "Connect"
40
Click "Submit"
41
Go back to previous tab and click "Retry", it will show documents with info and link
