CopilotStudioSamples/CallAgentConnector/Connector/apiDefinition.json at workdayfix · Unity-Billal-mesloub/CopilotStudioSamples · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
{
  "swagger": "2.0",
  "info": {
    "version": "1.0.0",
    "title": "Copilot Studio CAT",
    "description": "Copilot Studio CAT custom connector"
  },
  "host": "YOUR_FUNCTION_APP_HOSTNAME",
  "basePath": "/",
  "schemes": [
    "https"
  ],
  "consumes": [],
  "produces": [
    "application/json"
  ],
  "paths": {
    "/api/SyncToAsyncService": {
      "post": {
        "summary": "call agent and wait for response",
        "description": "call agent and wait for response",
        "operationId": "callAgent",
        "parameters": [
          {
            "name": "Content-Type",
            "in": "header",
            "required": true,
            "type": "string",
            "default": "application/json",
            "description": "Content-Type"
          },
          {
            "name": "body",
            "in": "body",
            "schema": {
              "type": "object",
              "properties": {
                "environmentId": {
                  "type": "string",
                  "description": "environmentId"
                },
                "agentIdentifier": {
                  "type": "string",
                  "description": "agentIdentifier"
                },
                "message": {
                  "type": "string",
                  "description": "message"
                },
                "conversationId": {
                  "type": "string",
                  "description": "Optional. Set to continue a conversation context"
                }
              },
              "default": {
                "environmentId": "YOUR_ENVIRONMENT_ID",
                "agentIdentifier": "YOUR_AGENT_IDENTIFIER",
                "message": "Hello, how can you help me?",
                "conversationId": "YOUR_CONVERSATION_ID"
              }
            },
            "required": true
          }
        ],
        "responses": {
          "default": {
            "description": "default",
            "schema": {}
          }
        }
      }
    }
  },
  "definitions": {},
  "parameters": {},
  "responses": {},
  "securityDefinitions": {
    "oauth2-auth": {
      "type": "oauth2",
      "flow": "accessCode",
      "tokenUrl": "https://login.windows.net/common/oauth2/authorize",
      "scopes": {
        "CopilotStudio.Copilots.Invoke": "CopilotStudio.Copilots.Invoke"
      },
      "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize"
    }
  },
  "security": [
    {
      "oauth2-auth": [
        "CopilotStudio.Copilots.Invoke"
      ]
    }
  ],
  "tags": []
}