tuix-mcp-host-client 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +47 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/README.md +48 -0
- package/apis/ClientApi.js +771 -0
- package/apis/ClientApi.js.map +1 -0
- package/apis/ClientApi.ts +1142 -0
- package/apis/index.js +20 -0
- package/apis/index.js.map +1 -0
- package/apis/index.ts +3 -0
- package/docs/APIKeyDTO.md +40 -0
- package/docs/AccountDTO.md +34 -0
- package/docs/ApplicationDTO.md +44 -0
- package/docs/ApplicationMCPServerDTO.md +36 -0
- package/docs/ApplicationWithApplicationCountDTO.md +46 -0
- package/docs/ClientApi.md +1397 -0
- package/docs/CreateAPIKeyRequestDTO.md +34 -0
- package/docs/CreateAPIKeyResponseDTO.md +42 -0
- package/docs/CreateAccountDTO.md +36 -0
- package/docs/CreateApplicationDTO.md +38 -0
- package/docs/CreateMCPServerDTO.md +36 -0
- package/docs/ErrorDTO.md +34 -0
- package/docs/GetAPIKeysResponseDTO.md +42 -0
- package/docs/InternalStreamChatRequest.md +36 -0
- package/docs/InternalStreamCreateSessionRequest.md +34 -0
- package/docs/InternalStreamCreateSessionResponse.md +38 -0
- package/docs/MCPServerDTO.md +38 -0
- package/docs/PaginatedApplicationsDTO.md +42 -0
- package/docs/PaginatedMCPServerDTO.md +42 -0
- package/docs/UpdateApplicationDTO.md +38 -0
- package/docs/UpdateMCPServerDTO.md +36 -0
- package/index.js +22 -0
- package/index.js.map +1 -0
- package/index.ts +5 -0
- package/models/APIKeyDTO.js +55 -0
- package/models/APIKeyDTO.js.map +1 -0
- package/models/APIKeyDTO.ts +89 -0
- package/models/AccountDTO.js +49 -0
- package/models/AccountDTO.js.map +1 -0
- package/models/AccountDTO.ts +65 -0
- package/models/ApplicationDTO.js +59 -0
- package/models/ApplicationDTO.js.map +1 -0
- package/models/ApplicationDTO.ts +105 -0
- package/models/ApplicationMCPServerDTO.js +51 -0
- package/models/ApplicationMCPServerDTO.js.map +1 -0
- package/models/ApplicationMCPServerDTO.ts +73 -0
- package/models/ApplicationWithApplicationCountDTO.js +61 -0
- package/models/ApplicationWithApplicationCountDTO.js.map +1 -0
- package/models/ApplicationWithApplicationCountDTO.ts +113 -0
- package/models/CreateAPIKeyRequestDTO.js +51 -0
- package/models/CreateAPIKeyRequestDTO.js.map +1 -0
- package/models/CreateAPIKeyRequestDTO.ts +66 -0
- package/models/CreateAPIKeyResponseDTO.js +57 -0
- package/models/CreateAPIKeyResponseDTO.js.map +1 -0
- package/models/CreateAPIKeyResponseDTO.ts +97 -0
- package/models/CreateAccountDTO.js +55 -0
- package/models/CreateAccountDTO.js.map +1 -0
- package/models/CreateAccountDTO.ts +75 -0
- package/models/CreateApplicationDTO.js +59 -0
- package/models/CreateApplicationDTO.js.map +1 -0
- package/models/CreateApplicationDTO.ts +84 -0
- package/models/CreateMCPServerDTO.js +51 -0
- package/models/CreateMCPServerDTO.js.map +1 -0
- package/models/CreateMCPServerDTO.ts +73 -0
- package/models/ErrorDTO.js +49 -0
- package/models/ErrorDTO.js.map +1 -0
- package/models/ErrorDTO.ts +65 -0
- package/models/GetAPIKeysResponseDTO.js +58 -0
- package/models/GetAPIKeysResponseDTO.js.map +1 -0
- package/models/GetAPIKeysResponseDTO.ts +105 -0
- package/models/InternalStreamChatRequest.js +51 -0
- package/models/InternalStreamChatRequest.js.map +1 -0
- package/models/InternalStreamChatRequest.ts +73 -0
- package/models/InternalStreamCreateSessionRequest.js +49 -0
- package/models/InternalStreamCreateSessionRequest.js.map +1 -0
- package/models/InternalStreamCreateSessionRequest.ts +65 -0
- package/models/InternalStreamCreateSessionResponse.js +53 -0
- package/models/InternalStreamCreateSessionResponse.js.map +1 -0
- package/models/InternalStreamCreateSessionResponse.ts +81 -0
- package/models/MCPServerDTO.js +53 -0
- package/models/MCPServerDTO.js.map +1 -0
- package/models/MCPServerDTO.ts +81 -0
- package/models/PaginatedApplicationsDTO.js +68 -0
- package/models/PaginatedApplicationsDTO.js.map +1 -0
- package/models/PaginatedApplicationsDTO.ts +110 -0
- package/models/PaginatedMCPServerDTO.js +58 -0
- package/models/PaginatedMCPServerDTO.js.map +1 -0
- package/models/PaginatedMCPServerDTO.ts +105 -0
- package/models/UpdateApplicationDTO.js +53 -0
- package/models/UpdateApplicationDTO.js.map +1 -0
- package/models/UpdateApplicationDTO.ts +81 -0
- package/models/UpdateMCPServerDTO.js +51 -0
- package/models/UpdateMCPServerDTO.js.map +1 -0
- package/models/UpdateMCPServerDTO.ts +73 -0
- package/models/index.js +39 -0
- package/models/index.js.map +1 -0
- package/models/index.ts +22 -0
- package/package.json +17 -0
- package/runtime.js +330 -0
- package/runtime.js.map +1 -0
- package/runtime.ts +432 -0
- package/tsconfig.build.tsbuildinfo +1 -0
|
@@ -0,0 +1,1397 @@
|
|
|
1
|
+
# ClientApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost:3000*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
| [**apiKeysGet**](ClientApi.md#apikeysget) | **GET** /api-keys | Get all API keys for the authenticated user |
|
|
8
|
+
| [**apiKeysIdDelete**](ClientApi.md#apikeysiddelete) | **DELETE** /api-keys/{id} | Delete an API key |
|
|
9
|
+
| [**apiKeysPost**](ClientApi.md#apikeyspost) | **POST** /api-keys | Create a new API key |
|
|
10
|
+
| [**attachMCPServer**](ClientApi.md#attachmcpserver) | **POST** /applications/{applicationId}/mcp-servers | Attach MCP server to application |
|
|
11
|
+
| [**chatStream**](ClientApi.md#chatstream) | **POST** /applications/{applicationId}/stream/session/chat | chat with streaming response |
|
|
12
|
+
| [**createAccount**](ClientApi.md#createaccount) | **POST** /accounts | Creates a new account |
|
|
13
|
+
| [**createApplication**](ClientApi.md#createapplication) | **POST** /applications | Create a new application |
|
|
14
|
+
| [**createMCPServer**](ClientApi.md#createmcpserver) | **POST** /mcp-servers | Create a new MCP server |
|
|
15
|
+
| [**createSession**](ClientApi.md#createsession) | **POST** /applications/{applicationId}/stream/session | create a new streaming session |
|
|
16
|
+
| [**deleteApplication**](ClientApi.md#deleteapplication) | **DELETE** /applications/{applicationId} | Delete an application |
|
|
17
|
+
| [**deleteMCPServer**](ClientApi.md#deletemcpserver) | **DELETE** /mcp-servers/{mcpServerId} | Delete an MCP server |
|
|
18
|
+
| [**deleteSession**](ClientApi.md#deletesession) | **DELETE** /applications/{applicationId}/stream/session/{sessionId} | delete an existing streaming session |
|
|
19
|
+
| [**detachMCPServer**](ClientApi.md#detachmcpserver) | **DELETE** /applications/{applicationId}/mcp-servers/{mcpServerId} | Detach MCP server from application |
|
|
20
|
+
| [**getApplicationByID**](ClientApi.md#getapplicationbyid) | **GET** /applications/{applicationId} | Get an application by applicationId |
|
|
21
|
+
| [**getApplicationMCPServers**](ClientApi.md#getapplicationmcpservers) | **GET** /applications/{applicationId}/mcp-servers | List MCP servers for application |
|
|
22
|
+
| [**getApplications**](ClientApi.md#getapplications) | **GET** /applications | Get all applications for the account |
|
|
23
|
+
| [**getMCPServers**](ClientApi.md#getmcpservers) | **GET** /mcp-servers | List MCP servers for account |
|
|
24
|
+
| [**updateApplication**](ClientApi.md#updateapplication) | **PATCH** /applications/{applicationId} | Update an application |
|
|
25
|
+
| [**updateMCPServer**](ClientApi.md#updatemcpserver) | **PATCH** /mcp-servers/{mcpServerId} | Update an existing MCP server |
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
## apiKeysGet
|
|
30
|
+
|
|
31
|
+
> GetAPIKeysResponseDTO apiKeysGet(page, pageSize)
|
|
32
|
+
|
|
33
|
+
Get all API keys for the authenticated user
|
|
34
|
+
|
|
35
|
+
Retrieve all API keys associated with the authenticated user\'s account with pagination.
|
|
36
|
+
|
|
37
|
+
### Example
|
|
38
|
+
|
|
39
|
+
```ts
|
|
40
|
+
import {
|
|
41
|
+
Configuration,
|
|
42
|
+
ClientApi,
|
|
43
|
+
} from '';
|
|
44
|
+
import type { ApiKeysGetRequest } from '';
|
|
45
|
+
|
|
46
|
+
async function example() {
|
|
47
|
+
console.log("🚀 Testing SDK...");
|
|
48
|
+
const api = new ClientApi();
|
|
49
|
+
|
|
50
|
+
const body = {
|
|
51
|
+
// number | Page number for pagination(default: 1) (optional)
|
|
52
|
+
page: 56,
|
|
53
|
+
// number | Limit number of items per page (default: 10) (optional)
|
|
54
|
+
pageSize: 56,
|
|
55
|
+
} satisfies ApiKeysGetRequest;
|
|
56
|
+
|
|
57
|
+
try {
|
|
58
|
+
const data = await api.apiKeysGet(body);
|
|
59
|
+
console.log(data);
|
|
60
|
+
} catch (error) {
|
|
61
|
+
console.error(error);
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
// Run the test
|
|
66
|
+
example().catch(console.error);
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### Parameters
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
| Name | Type | Description | Notes |
|
|
73
|
+
|------------- | ------------- | ------------- | -------------|
|
|
74
|
+
| **page** | `number` | Page number for pagination(default: 1) | [Optional] [Defaults to `1`] |
|
|
75
|
+
| **pageSize** | `number` | Limit number of items per page (default: 10) | [Optional] [Defaults to `10`] |
|
|
76
|
+
|
|
77
|
+
### Return type
|
|
78
|
+
|
|
79
|
+
[**GetAPIKeysResponseDTO**](GetAPIKeysResponseDTO.md)
|
|
80
|
+
|
|
81
|
+
### Authorization
|
|
82
|
+
|
|
83
|
+
No authorization required
|
|
84
|
+
|
|
85
|
+
### HTTP request headers
|
|
86
|
+
|
|
87
|
+
- **Content-Type**: Not defined
|
|
88
|
+
- **Accept**: `application/json`
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
### HTTP response details
|
|
92
|
+
| Status code | Description | Response headers |
|
|
93
|
+
|-------------|-------------|------------------|
|
|
94
|
+
| **200** | Returns a paginated list of API keys | - |
|
|
95
|
+
| **401** | Unauthorized | - |
|
|
96
|
+
| **500** | Internal server error: Failed to retrieve API keys | - |
|
|
97
|
+
|
|
98
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
## apiKeysIdDelete
|
|
102
|
+
|
|
103
|
+
> apiKeysIdDelete(id)
|
|
104
|
+
|
|
105
|
+
Delete an API key
|
|
106
|
+
|
|
107
|
+
Delete a specific API key belonging to the authenticated user.
|
|
108
|
+
|
|
109
|
+
### Example
|
|
110
|
+
|
|
111
|
+
```ts
|
|
112
|
+
import {
|
|
113
|
+
Configuration,
|
|
114
|
+
ClientApi,
|
|
115
|
+
} from '';
|
|
116
|
+
import type { ApiKeysIdDeleteRequest } from '';
|
|
117
|
+
|
|
118
|
+
async function example() {
|
|
119
|
+
console.log("🚀 Testing SDK...");
|
|
120
|
+
const api = new ClientApi();
|
|
121
|
+
|
|
122
|
+
const body = {
|
|
123
|
+
// string | API Key ID
|
|
124
|
+
id: id_example,
|
|
125
|
+
} satisfies ApiKeysIdDeleteRequest;
|
|
126
|
+
|
|
127
|
+
try {
|
|
128
|
+
const data = await api.apiKeysIdDelete(body);
|
|
129
|
+
console.log(data);
|
|
130
|
+
} catch (error) {
|
|
131
|
+
console.error(error);
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
// Run the test
|
|
136
|
+
example().catch(console.error);
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
### Parameters
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
| Name | Type | Description | Notes |
|
|
143
|
+
|------------- | ------------- | ------------- | -------------|
|
|
144
|
+
| **id** | `string` | API Key ID | [Defaults to `undefined`] |
|
|
145
|
+
|
|
146
|
+
### Return type
|
|
147
|
+
|
|
148
|
+
`void` (Empty response body)
|
|
149
|
+
|
|
150
|
+
### Authorization
|
|
151
|
+
|
|
152
|
+
No authorization required
|
|
153
|
+
|
|
154
|
+
### HTTP request headers
|
|
155
|
+
|
|
156
|
+
- **Content-Type**: Not defined
|
|
157
|
+
- **Accept**: `application/json`
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
### HTTP response details
|
|
161
|
+
| Status code | Description | Response headers |
|
|
162
|
+
|-------------|-------------|------------------|
|
|
163
|
+
| **204** | API key deleted successfully | - |
|
|
164
|
+
| **400** | Invalid key ID format | - |
|
|
165
|
+
| **401** | Unauthorized | - |
|
|
166
|
+
| **404** | API key not found | - |
|
|
167
|
+
| **500** | Internal server error: Failed to delete API key | - |
|
|
168
|
+
|
|
169
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
## apiKeysPost
|
|
173
|
+
|
|
174
|
+
> CreateAPIKeyResponseDTO apiKeysPost(createAPIKeyRequestDTO)
|
|
175
|
+
|
|
176
|
+
Create a new API key
|
|
177
|
+
|
|
178
|
+
Create a new API key for accessing the RAG service.
|
|
179
|
+
|
|
180
|
+
### Example
|
|
181
|
+
|
|
182
|
+
```ts
|
|
183
|
+
import {
|
|
184
|
+
Configuration,
|
|
185
|
+
ClientApi,
|
|
186
|
+
} from '';
|
|
187
|
+
import type { ApiKeysPostRequest } from '';
|
|
188
|
+
|
|
189
|
+
async function example() {
|
|
190
|
+
console.log("🚀 Testing SDK...");
|
|
191
|
+
const api = new ClientApi();
|
|
192
|
+
|
|
193
|
+
const body = {
|
|
194
|
+
// CreateAPIKeyRequestDTO | Create API Key request
|
|
195
|
+
createAPIKeyRequestDTO: ...,
|
|
196
|
+
} satisfies ApiKeysPostRequest;
|
|
197
|
+
|
|
198
|
+
try {
|
|
199
|
+
const data = await api.apiKeysPost(body);
|
|
200
|
+
console.log(data);
|
|
201
|
+
} catch (error) {
|
|
202
|
+
console.error(error);
|
|
203
|
+
}
|
|
204
|
+
}
|
|
205
|
+
|
|
206
|
+
// Run the test
|
|
207
|
+
example().catch(console.error);
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
### Parameters
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
| Name | Type | Description | Notes |
|
|
214
|
+
|------------- | ------------- | ------------- | -------------|
|
|
215
|
+
| **createAPIKeyRequestDTO** | [CreateAPIKeyRequestDTO](CreateAPIKeyRequestDTO.md) | Create API Key request | |
|
|
216
|
+
|
|
217
|
+
### Return type
|
|
218
|
+
|
|
219
|
+
[**CreateAPIKeyResponseDTO**](CreateAPIKeyResponseDTO.md)
|
|
220
|
+
|
|
221
|
+
### Authorization
|
|
222
|
+
|
|
223
|
+
No authorization required
|
|
224
|
+
|
|
225
|
+
### HTTP request headers
|
|
226
|
+
|
|
227
|
+
- **Content-Type**: `application/json`
|
|
228
|
+
- **Accept**: `application/json`
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
### HTTP response details
|
|
232
|
+
| Status code | Description | Response headers |
|
|
233
|
+
|-------------|-------------|------------------|
|
|
234
|
+
| **201** | Create an API key and returns the created key | - |
|
|
235
|
+
| **400** | Invalid request format | - |
|
|
236
|
+
| **401** | Unauthorized | - |
|
|
237
|
+
| **500** | Server Error: Failed to create API key | - |
|
|
238
|
+
|
|
239
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
## attachMCPServer
|
|
243
|
+
|
|
244
|
+
> attachMCPServer(applicationId, applicationMCPServerDTO)
|
|
245
|
+
|
|
246
|
+
Attach MCP server to application
|
|
247
|
+
|
|
248
|
+
Attach an existing MCP server to the specified application within the authenticated account
|
|
249
|
+
|
|
250
|
+
### Example
|
|
251
|
+
|
|
252
|
+
```ts
|
|
253
|
+
import {
|
|
254
|
+
Configuration,
|
|
255
|
+
ClientApi,
|
|
256
|
+
} from '';
|
|
257
|
+
import type { AttachMCPServerRequest } from '';
|
|
258
|
+
|
|
259
|
+
async function example() {
|
|
260
|
+
console.log("🚀 Testing SDK...");
|
|
261
|
+
const api = new ClientApi();
|
|
262
|
+
|
|
263
|
+
const body = {
|
|
264
|
+
// string | Application ID
|
|
265
|
+
applicationId: applicationId_example,
|
|
266
|
+
// ApplicationMCPServerDTO | MCP Server to attach
|
|
267
|
+
applicationMCPServerDTO: ...,
|
|
268
|
+
} satisfies AttachMCPServerRequest;
|
|
269
|
+
|
|
270
|
+
try {
|
|
271
|
+
const data = await api.attachMCPServer(body);
|
|
272
|
+
console.log(data);
|
|
273
|
+
} catch (error) {
|
|
274
|
+
console.error(error);
|
|
275
|
+
}
|
|
276
|
+
}
|
|
277
|
+
|
|
278
|
+
// Run the test
|
|
279
|
+
example().catch(console.error);
|
|
280
|
+
```
|
|
281
|
+
|
|
282
|
+
### Parameters
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
| Name | Type | Description | Notes |
|
|
286
|
+
|------------- | ------------- | ------------- | -------------|
|
|
287
|
+
| **applicationId** | `string` | Application ID | [Defaults to `undefined`] |
|
|
288
|
+
| **applicationMCPServerDTO** | [ApplicationMCPServerDTO](ApplicationMCPServerDTO.md) | MCP Server to attach | |
|
|
289
|
+
|
|
290
|
+
### Return type
|
|
291
|
+
|
|
292
|
+
`void` (Empty response body)
|
|
293
|
+
|
|
294
|
+
### Authorization
|
|
295
|
+
|
|
296
|
+
No authorization required
|
|
297
|
+
|
|
298
|
+
### HTTP request headers
|
|
299
|
+
|
|
300
|
+
- **Content-Type**: `application/json`
|
|
301
|
+
- **Accept**: `application/json`
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
### HTTP response details
|
|
305
|
+
| Status code | Description | Response headers |
|
|
306
|
+
|-------------|-------------|------------------|
|
|
307
|
+
| **204** | MCP server attached successfully | - |
|
|
308
|
+
| **400** | Bad Request | - |
|
|
309
|
+
| **401** | Unauthorized | - |
|
|
310
|
+
| **500** | Internal Server Error | - |
|
|
311
|
+
|
|
312
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
## chatStream
|
|
316
|
+
|
|
317
|
+
> string chatStream(applicationId, internalStreamChatRequest)
|
|
318
|
+
|
|
319
|
+
chat with streaming response
|
|
320
|
+
|
|
321
|
+
chat with streaming response
|
|
322
|
+
|
|
323
|
+
### Example
|
|
324
|
+
|
|
325
|
+
```ts
|
|
326
|
+
import {
|
|
327
|
+
Configuration,
|
|
328
|
+
ClientApi,
|
|
329
|
+
} from '';
|
|
330
|
+
import type { ChatStreamRequest } from '';
|
|
331
|
+
|
|
332
|
+
async function example() {
|
|
333
|
+
console.log("🚀 Testing SDK...");
|
|
334
|
+
const api = new ClientApi();
|
|
335
|
+
|
|
336
|
+
const body = {
|
|
337
|
+
// string | Application ID
|
|
338
|
+
applicationId: applicationId_example,
|
|
339
|
+
// InternalStreamChatRequest | Chat Request Body
|
|
340
|
+
internalStreamChatRequest: ...,
|
|
341
|
+
} satisfies ChatStreamRequest;
|
|
342
|
+
|
|
343
|
+
try {
|
|
344
|
+
const data = await api.chatStream(body);
|
|
345
|
+
console.log(data);
|
|
346
|
+
} catch (error) {
|
|
347
|
+
console.error(error);
|
|
348
|
+
}
|
|
349
|
+
}
|
|
350
|
+
|
|
351
|
+
// Run the test
|
|
352
|
+
example().catch(console.error);
|
|
353
|
+
```
|
|
354
|
+
|
|
355
|
+
### Parameters
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
| Name | Type | Description | Notes |
|
|
359
|
+
|------------- | ------------- | ------------- | -------------|
|
|
360
|
+
| **applicationId** | `string` | Application ID | [Defaults to `undefined`] |
|
|
361
|
+
| **internalStreamChatRequest** | [InternalStreamChatRequest](InternalStreamChatRequest.md) | Chat Request Body | |
|
|
362
|
+
|
|
363
|
+
### Return type
|
|
364
|
+
|
|
365
|
+
**string**
|
|
366
|
+
|
|
367
|
+
### Authorization
|
|
368
|
+
|
|
369
|
+
No authorization required
|
|
370
|
+
|
|
371
|
+
### HTTP request headers
|
|
372
|
+
|
|
373
|
+
- **Content-Type**: `application/json`
|
|
374
|
+
- **Accept**: `text/event-stream`
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
### HTTP response details
|
|
378
|
+
| Status code | Description | Response headers |
|
|
379
|
+
|-------------|-------------|------------------|
|
|
380
|
+
| **200** | Streaming chat response as SSE | - |
|
|
381
|
+
| **400** | Return an error if the request body is invalid | - |
|
|
382
|
+
| **404** | Return an error if the session is not found | - |
|
|
383
|
+
| **500** | Return an error if there is an internal server error | - |
|
|
384
|
+
|
|
385
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
## createAccount
|
|
389
|
+
|
|
390
|
+
> AccountDTO createAccount(createAccountDTO)
|
|
391
|
+
|
|
392
|
+
Creates a new account
|
|
393
|
+
|
|
394
|
+
Create an account
|
|
395
|
+
|
|
396
|
+
### Example
|
|
397
|
+
|
|
398
|
+
```ts
|
|
399
|
+
import {
|
|
400
|
+
Configuration,
|
|
401
|
+
ClientApi,
|
|
402
|
+
} from '';
|
|
403
|
+
import type { CreateAccountRequest } from '';
|
|
404
|
+
|
|
405
|
+
async function example() {
|
|
406
|
+
console.log("🚀 Testing SDK...");
|
|
407
|
+
const api = new ClientApi();
|
|
408
|
+
|
|
409
|
+
const body = {
|
|
410
|
+
// CreateAccountDTO | Account creation data
|
|
411
|
+
createAccountDTO: ...,
|
|
412
|
+
} satisfies CreateAccountRequest;
|
|
413
|
+
|
|
414
|
+
try {
|
|
415
|
+
const data = await api.createAccount(body);
|
|
416
|
+
console.log(data);
|
|
417
|
+
} catch (error) {
|
|
418
|
+
console.error(error);
|
|
419
|
+
}
|
|
420
|
+
}
|
|
421
|
+
|
|
422
|
+
// Run the test
|
|
423
|
+
example().catch(console.error);
|
|
424
|
+
```
|
|
425
|
+
|
|
426
|
+
### Parameters
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
| Name | Type | Description | Notes |
|
|
430
|
+
|------------- | ------------- | ------------- | -------------|
|
|
431
|
+
| **createAccountDTO** | [CreateAccountDTO](CreateAccountDTO.md) | Account creation data | |
|
|
432
|
+
|
|
433
|
+
### Return type
|
|
434
|
+
|
|
435
|
+
[**AccountDTO**](AccountDTO.md)
|
|
436
|
+
|
|
437
|
+
### Authorization
|
|
438
|
+
|
|
439
|
+
No authorization required
|
|
440
|
+
|
|
441
|
+
### HTTP request headers
|
|
442
|
+
|
|
443
|
+
- **Content-Type**: `application/json`
|
|
444
|
+
- **Accept**: `application/json`
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
### HTTP response details
|
|
448
|
+
| Status code | Description | Response headers |
|
|
449
|
+
|-------------|-------------|------------------|
|
|
450
|
+
| **201** | Create an account and returns the created account | - |
|
|
451
|
+
| **400** | Return an error if there is a missing or invalid field | - |
|
|
452
|
+
| **401** | Return an error if the user is not authenticated | - |
|
|
453
|
+
| **403** | Return an error if the user does not have the required permissions | - |
|
|
454
|
+
| **500** | Return an error if the server finds an error | - |
|
|
455
|
+
|
|
456
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
## createApplication
|
|
460
|
+
|
|
461
|
+
> ApplicationDTO createApplication(createApplicationDTO)
|
|
462
|
+
|
|
463
|
+
Create a new application
|
|
464
|
+
|
|
465
|
+
Create a new application for the authenticated account
|
|
466
|
+
|
|
467
|
+
### Example
|
|
468
|
+
|
|
469
|
+
```ts
|
|
470
|
+
import {
|
|
471
|
+
Configuration,
|
|
472
|
+
ClientApi,
|
|
473
|
+
} from '';
|
|
474
|
+
import type { CreateApplicationRequest } from '';
|
|
475
|
+
|
|
476
|
+
async function example() {
|
|
477
|
+
console.log("🚀 Testing SDK...");
|
|
478
|
+
const api = new ClientApi();
|
|
479
|
+
|
|
480
|
+
const body = {
|
|
481
|
+
// CreateApplicationDTO | Application creation data
|
|
482
|
+
createApplicationDTO: ...,
|
|
483
|
+
} satisfies CreateApplicationRequest;
|
|
484
|
+
|
|
485
|
+
try {
|
|
486
|
+
const data = await api.createApplication(body);
|
|
487
|
+
console.log(data);
|
|
488
|
+
} catch (error) {
|
|
489
|
+
console.error(error);
|
|
490
|
+
}
|
|
491
|
+
}
|
|
492
|
+
|
|
493
|
+
// Run the test
|
|
494
|
+
example().catch(console.error);
|
|
495
|
+
```
|
|
496
|
+
|
|
497
|
+
### Parameters
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
| Name | Type | Description | Notes |
|
|
501
|
+
|------------- | ------------- | ------------- | -------------|
|
|
502
|
+
| **createApplicationDTO** | [CreateApplicationDTO](CreateApplicationDTO.md) | Application creation data | |
|
|
503
|
+
|
|
504
|
+
### Return type
|
|
505
|
+
|
|
506
|
+
[**ApplicationDTO**](ApplicationDTO.md)
|
|
507
|
+
|
|
508
|
+
### Authorization
|
|
509
|
+
|
|
510
|
+
No authorization required
|
|
511
|
+
|
|
512
|
+
### HTTP request headers
|
|
513
|
+
|
|
514
|
+
- **Content-Type**: `application/json`
|
|
515
|
+
- **Accept**: `application/json`
|
|
516
|
+
|
|
517
|
+
|
|
518
|
+
### HTTP response details
|
|
519
|
+
| Status code | Description | Response headers |
|
|
520
|
+
|-------------|-------------|------------------|
|
|
521
|
+
| **201** | Create a application and returns the created application | - |
|
|
522
|
+
| **400** | Return an error if there is a missing or invalid field | - |
|
|
523
|
+
| **401** | Return an error if the user is not authenticated | - |
|
|
524
|
+
| **403** | Return an error if the user does not have the required permissions | - |
|
|
525
|
+
| **500** | Return an error if the server founds an error | - |
|
|
526
|
+
|
|
527
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
528
|
+
|
|
529
|
+
|
|
530
|
+
## createMCPServer
|
|
531
|
+
|
|
532
|
+
> MCPServerDTO createMCPServer(createMCPServerDTO)
|
|
533
|
+
|
|
534
|
+
Create a new MCP server
|
|
535
|
+
|
|
536
|
+
Create a new MCP server for the authenticated account
|
|
537
|
+
|
|
538
|
+
### Example
|
|
539
|
+
|
|
540
|
+
```ts
|
|
541
|
+
import {
|
|
542
|
+
Configuration,
|
|
543
|
+
ClientApi,
|
|
544
|
+
} from '';
|
|
545
|
+
import type { CreateMCPServerRequest } from '';
|
|
546
|
+
|
|
547
|
+
async function example() {
|
|
548
|
+
console.log("🚀 Testing SDK...");
|
|
549
|
+
const api = new ClientApi();
|
|
550
|
+
|
|
551
|
+
const body = {
|
|
552
|
+
// CreateMCPServerDTO | MCP server creation data
|
|
553
|
+
createMCPServerDTO: ...,
|
|
554
|
+
} satisfies CreateMCPServerRequest;
|
|
555
|
+
|
|
556
|
+
try {
|
|
557
|
+
const data = await api.createMCPServer(body);
|
|
558
|
+
console.log(data);
|
|
559
|
+
} catch (error) {
|
|
560
|
+
console.error(error);
|
|
561
|
+
}
|
|
562
|
+
}
|
|
563
|
+
|
|
564
|
+
// Run the test
|
|
565
|
+
example().catch(console.error);
|
|
566
|
+
```
|
|
567
|
+
|
|
568
|
+
### Parameters
|
|
569
|
+
|
|
570
|
+
|
|
571
|
+
| Name | Type | Description | Notes |
|
|
572
|
+
|------------- | ------------- | ------------- | -------------|
|
|
573
|
+
| **createMCPServerDTO** | [CreateMCPServerDTO](CreateMCPServerDTO.md) | MCP server creation data | |
|
|
574
|
+
|
|
575
|
+
### Return type
|
|
576
|
+
|
|
577
|
+
[**MCPServerDTO**](MCPServerDTO.md)
|
|
578
|
+
|
|
579
|
+
### Authorization
|
|
580
|
+
|
|
581
|
+
No authorization required
|
|
582
|
+
|
|
583
|
+
### HTTP request headers
|
|
584
|
+
|
|
585
|
+
- **Content-Type**: `application/json`
|
|
586
|
+
- **Accept**: `application/json`
|
|
587
|
+
|
|
588
|
+
|
|
589
|
+
### HTTP response details
|
|
590
|
+
| Status code | Description | Response headers |
|
|
591
|
+
|-------------|-------------|------------------|
|
|
592
|
+
| **201** | Created MCP server | - |
|
|
593
|
+
| **400** | Bad Request | - |
|
|
594
|
+
| **401** | Unauthorized | - |
|
|
595
|
+
| **500** | Internal Server Error | - |
|
|
596
|
+
|
|
597
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
## createSession
|
|
601
|
+
|
|
602
|
+
> InternalStreamCreateSessionResponse createSession(applicationId, internalStreamCreateSessionRequest)
|
|
603
|
+
|
|
604
|
+
create a new streaming session
|
|
605
|
+
|
|
606
|
+
create a new streaming session
|
|
607
|
+
|
|
608
|
+
### Example
|
|
609
|
+
|
|
610
|
+
```ts
|
|
611
|
+
import {
|
|
612
|
+
Configuration,
|
|
613
|
+
ClientApi,
|
|
614
|
+
} from '';
|
|
615
|
+
import type { CreateSessionRequest } from '';
|
|
616
|
+
|
|
617
|
+
async function example() {
|
|
618
|
+
console.log("🚀 Testing SDK...");
|
|
619
|
+
const api = new ClientApi();
|
|
620
|
+
|
|
621
|
+
const body = {
|
|
622
|
+
// string | Application ID
|
|
623
|
+
applicationId: applicationId_example,
|
|
624
|
+
// InternalStreamCreateSessionRequest | Create Session Request Body
|
|
625
|
+
internalStreamCreateSessionRequest: ...,
|
|
626
|
+
} satisfies CreateSessionRequest;
|
|
627
|
+
|
|
628
|
+
try {
|
|
629
|
+
const data = await api.createSession(body);
|
|
630
|
+
console.log(data);
|
|
631
|
+
} catch (error) {
|
|
632
|
+
console.error(error);
|
|
633
|
+
}
|
|
634
|
+
}
|
|
635
|
+
|
|
636
|
+
// Run the test
|
|
637
|
+
example().catch(console.error);
|
|
638
|
+
```
|
|
639
|
+
|
|
640
|
+
### Parameters
|
|
641
|
+
|
|
642
|
+
|
|
643
|
+
| Name | Type | Description | Notes |
|
|
644
|
+
|------------- | ------------- | ------------- | -------------|
|
|
645
|
+
| **applicationId** | `string` | Application ID | [Defaults to `undefined`] |
|
|
646
|
+
| **internalStreamCreateSessionRequest** | [InternalStreamCreateSessionRequest](InternalStreamCreateSessionRequest.md) | Create Session Request Body | |
|
|
647
|
+
|
|
648
|
+
### Return type
|
|
649
|
+
|
|
650
|
+
[**InternalStreamCreateSessionResponse**](InternalStreamCreateSessionResponse.md)
|
|
651
|
+
|
|
652
|
+
### Authorization
|
|
653
|
+
|
|
654
|
+
No authorization required
|
|
655
|
+
|
|
656
|
+
### HTTP request headers
|
|
657
|
+
|
|
658
|
+
- **Content-Type**: `application/json`
|
|
659
|
+
- **Accept**: `application/json`
|
|
660
|
+
|
|
661
|
+
|
|
662
|
+
### HTTP response details
|
|
663
|
+
| Status code | Description | Response headers |
|
|
664
|
+
|-------------|-------------|------------------|
|
|
665
|
+
| **201** | Return the created session details | - |
|
|
666
|
+
| **400** | Return an error if the request body is invalid | - |
|
|
667
|
+
| **500** | Return an error if there is an internal server error | - |
|
|
668
|
+
|
|
669
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
670
|
+
|
|
671
|
+
|
|
672
|
+
## deleteApplication
|
|
673
|
+
|
|
674
|
+
> deleteApplication(applicationId)
|
|
675
|
+
|
|
676
|
+
Delete an application
|
|
677
|
+
|
|
678
|
+
Delete an application belonging to the authenticated account
|
|
679
|
+
|
|
680
|
+
### Example
|
|
681
|
+
|
|
682
|
+
```ts
|
|
683
|
+
import {
|
|
684
|
+
Configuration,
|
|
685
|
+
ClientApi,
|
|
686
|
+
} from '';
|
|
687
|
+
import type { DeleteApplicationRequest } from '';
|
|
688
|
+
|
|
689
|
+
async function example() {
|
|
690
|
+
console.log("🚀 Testing SDK...");
|
|
691
|
+
const api = new ClientApi();
|
|
692
|
+
|
|
693
|
+
const body = {
|
|
694
|
+
// string | Application ID
|
|
695
|
+
applicationId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
696
|
+
} satisfies DeleteApplicationRequest;
|
|
697
|
+
|
|
698
|
+
try {
|
|
699
|
+
const data = await api.deleteApplication(body);
|
|
700
|
+
console.log(data);
|
|
701
|
+
} catch (error) {
|
|
702
|
+
console.error(error);
|
|
703
|
+
}
|
|
704
|
+
}
|
|
705
|
+
|
|
706
|
+
// Run the test
|
|
707
|
+
example().catch(console.error);
|
|
708
|
+
```
|
|
709
|
+
|
|
710
|
+
### Parameters
|
|
711
|
+
|
|
712
|
+
|
|
713
|
+
| Name | Type | Description | Notes |
|
|
714
|
+
|------------- | ------------- | ------------- | -------------|
|
|
715
|
+
| **applicationId** | `string` | Application ID | [Defaults to `undefined`] |
|
|
716
|
+
|
|
717
|
+
### Return type
|
|
718
|
+
|
|
719
|
+
`void` (Empty response body)
|
|
720
|
+
|
|
721
|
+
### Authorization
|
|
722
|
+
|
|
723
|
+
No authorization required
|
|
724
|
+
|
|
725
|
+
### HTTP request headers
|
|
726
|
+
|
|
727
|
+
- **Content-Type**: Not defined
|
|
728
|
+
- **Accept**: `application/json`
|
|
729
|
+
|
|
730
|
+
|
|
731
|
+
### HTTP response details
|
|
732
|
+
| Status code | Description | Response headers |
|
|
733
|
+
|-------------|-------------|------------------|
|
|
734
|
+
| **204** | Application deleted | - |
|
|
735
|
+
| **400** | Return an error if provided ID is not a valid UUID | - |
|
|
736
|
+
| **401** | Return an error if the user is not authenticated | - |
|
|
737
|
+
| **403** | Return an error if the user does not have the required permissions | - |
|
|
738
|
+
| **500** | Return an error if the server founds an error | - |
|
|
739
|
+
|
|
740
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
741
|
+
|
|
742
|
+
|
|
743
|
+
## deleteMCPServer
|
|
744
|
+
|
|
745
|
+
> deleteMCPServer(mcpServerId)
|
|
746
|
+
|
|
747
|
+
Delete an MCP server
|
|
748
|
+
|
|
749
|
+
Delete an MCP server from the authenticated account
|
|
750
|
+
|
|
751
|
+
### Example
|
|
752
|
+
|
|
753
|
+
```ts
|
|
754
|
+
import {
|
|
755
|
+
Configuration,
|
|
756
|
+
ClientApi,
|
|
757
|
+
} from '';
|
|
758
|
+
import type { DeleteMCPServerRequest } from '';
|
|
759
|
+
|
|
760
|
+
async function example() {
|
|
761
|
+
console.log("🚀 Testing SDK...");
|
|
762
|
+
const api = new ClientApi();
|
|
763
|
+
|
|
764
|
+
const body = {
|
|
765
|
+
// string | MCP Server ID
|
|
766
|
+
mcpServerId: mcpServerId_example,
|
|
767
|
+
} satisfies DeleteMCPServerRequest;
|
|
768
|
+
|
|
769
|
+
try {
|
|
770
|
+
const data = await api.deleteMCPServer(body);
|
|
771
|
+
console.log(data);
|
|
772
|
+
} catch (error) {
|
|
773
|
+
console.error(error);
|
|
774
|
+
}
|
|
775
|
+
}
|
|
776
|
+
|
|
777
|
+
// Run the test
|
|
778
|
+
example().catch(console.error);
|
|
779
|
+
```
|
|
780
|
+
|
|
781
|
+
### Parameters
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
| Name | Type | Description | Notes |
|
|
785
|
+
|------------- | ------------- | ------------- | -------------|
|
|
786
|
+
| **mcpServerId** | `string` | MCP Server ID | [Defaults to `undefined`] |
|
|
787
|
+
|
|
788
|
+
### Return type
|
|
789
|
+
|
|
790
|
+
`void` (Empty response body)
|
|
791
|
+
|
|
792
|
+
### Authorization
|
|
793
|
+
|
|
794
|
+
No authorization required
|
|
795
|
+
|
|
796
|
+
### HTTP request headers
|
|
797
|
+
|
|
798
|
+
- **Content-Type**: Not defined
|
|
799
|
+
- **Accept**: `application/json`
|
|
800
|
+
|
|
801
|
+
|
|
802
|
+
### HTTP response details
|
|
803
|
+
| Status code | Description | Response headers |
|
|
804
|
+
|-------------|-------------|------------------|
|
|
805
|
+
| **204** | No content | - |
|
|
806
|
+
| **400** | Bad Request | - |
|
|
807
|
+
| **401** | Unauthorized | - |
|
|
808
|
+
| **500** | Internal Server Error | - |
|
|
809
|
+
|
|
810
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
811
|
+
|
|
812
|
+
|
|
813
|
+
## deleteSession
|
|
814
|
+
|
|
815
|
+
> deleteSession(applicationId, sessionId)
|
|
816
|
+
|
|
817
|
+
delete an existing streaming session
|
|
818
|
+
|
|
819
|
+
delete an existing streaming session
|
|
820
|
+
|
|
821
|
+
### Example
|
|
822
|
+
|
|
823
|
+
```ts
|
|
824
|
+
import {
|
|
825
|
+
Configuration,
|
|
826
|
+
ClientApi,
|
|
827
|
+
} from '';
|
|
828
|
+
import type { DeleteSessionRequest } from '';
|
|
829
|
+
|
|
830
|
+
async function example() {
|
|
831
|
+
console.log("🚀 Testing SDK...");
|
|
832
|
+
const api = new ClientApi();
|
|
833
|
+
|
|
834
|
+
const body = {
|
|
835
|
+
// string | Application ID
|
|
836
|
+
applicationId: applicationId_example,
|
|
837
|
+
// string | Session ID
|
|
838
|
+
sessionId: sessionId_example,
|
|
839
|
+
} satisfies DeleteSessionRequest;
|
|
840
|
+
|
|
841
|
+
try {
|
|
842
|
+
const data = await api.deleteSession(body);
|
|
843
|
+
console.log(data);
|
|
844
|
+
} catch (error) {
|
|
845
|
+
console.error(error);
|
|
846
|
+
}
|
|
847
|
+
}
|
|
848
|
+
|
|
849
|
+
// Run the test
|
|
850
|
+
example().catch(console.error);
|
|
851
|
+
```
|
|
852
|
+
|
|
853
|
+
### Parameters
|
|
854
|
+
|
|
855
|
+
|
|
856
|
+
| Name | Type | Description | Notes |
|
|
857
|
+
|------------- | ------------- | ------------- | -------------|
|
|
858
|
+
| **applicationId** | `string` | Application ID | [Defaults to `undefined`] |
|
|
859
|
+
| **sessionId** | `string` | Session ID | [Defaults to `undefined`] |
|
|
860
|
+
|
|
861
|
+
### Return type
|
|
862
|
+
|
|
863
|
+
`void` (Empty response body)
|
|
864
|
+
|
|
865
|
+
### Authorization
|
|
866
|
+
|
|
867
|
+
No authorization required
|
|
868
|
+
|
|
869
|
+
### HTTP request headers
|
|
870
|
+
|
|
871
|
+
- **Content-Type**: Not defined
|
|
872
|
+
- **Accept**: `application/json`
|
|
873
|
+
|
|
874
|
+
|
|
875
|
+
### HTTP response details
|
|
876
|
+
| Status code | Description | Response headers |
|
|
877
|
+
|-------------|-------------|------------------|
|
|
878
|
+
| **204** | No Content | - |
|
|
879
|
+
| **404** | Return an error if the session is not found | - |
|
|
880
|
+
| **500** | Return an error if there is an internal server error | - |
|
|
881
|
+
|
|
882
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
883
|
+
|
|
884
|
+
|
|
885
|
+
## detachMCPServer
|
|
886
|
+
|
|
887
|
+
> detachMCPServer(applicationId, mcpServerId)
|
|
888
|
+
|
|
889
|
+
Detach MCP server from application
|
|
890
|
+
|
|
891
|
+
Detach an existing MCP server from the specified application within the authenticated account
|
|
892
|
+
|
|
893
|
+
### Example
|
|
894
|
+
|
|
895
|
+
```ts
|
|
896
|
+
import {
|
|
897
|
+
Configuration,
|
|
898
|
+
ClientApi,
|
|
899
|
+
} from '';
|
|
900
|
+
import type { DetachMCPServerRequest } from '';
|
|
901
|
+
|
|
902
|
+
async function example() {
|
|
903
|
+
console.log("🚀 Testing SDK...");
|
|
904
|
+
const api = new ClientApi();
|
|
905
|
+
|
|
906
|
+
const body = {
|
|
907
|
+
// string | Application ID
|
|
908
|
+
applicationId: applicationId_example,
|
|
909
|
+
// string | MCP Server ID
|
|
910
|
+
mcpServerId: mcpServerId_example,
|
|
911
|
+
} satisfies DetachMCPServerRequest;
|
|
912
|
+
|
|
913
|
+
try {
|
|
914
|
+
const data = await api.detachMCPServer(body);
|
|
915
|
+
console.log(data);
|
|
916
|
+
} catch (error) {
|
|
917
|
+
console.error(error);
|
|
918
|
+
}
|
|
919
|
+
}
|
|
920
|
+
|
|
921
|
+
// Run the test
|
|
922
|
+
example().catch(console.error);
|
|
923
|
+
```
|
|
924
|
+
|
|
925
|
+
### Parameters
|
|
926
|
+
|
|
927
|
+
|
|
928
|
+
| Name | Type | Description | Notes |
|
|
929
|
+
|------------- | ------------- | ------------- | -------------|
|
|
930
|
+
| **applicationId** | `string` | Application ID | [Defaults to `undefined`] |
|
|
931
|
+
| **mcpServerId** | `string` | MCP Server ID | [Defaults to `undefined`] |
|
|
932
|
+
|
|
933
|
+
### Return type
|
|
934
|
+
|
|
935
|
+
`void` (Empty response body)
|
|
936
|
+
|
|
937
|
+
### Authorization
|
|
938
|
+
|
|
939
|
+
No authorization required
|
|
940
|
+
|
|
941
|
+
### HTTP request headers
|
|
942
|
+
|
|
943
|
+
- **Content-Type**: Not defined
|
|
944
|
+
- **Accept**: `application/json`
|
|
945
|
+
|
|
946
|
+
|
|
947
|
+
### HTTP response details
|
|
948
|
+
| Status code | Description | Response headers |
|
|
949
|
+
|-------------|-------------|------------------|
|
|
950
|
+
| **204** | MCP server detached successfully | - |
|
|
951
|
+
| **400** | Bad Request | - |
|
|
952
|
+
| **401** | Unauthorized | - |
|
|
953
|
+
| **500** | Internal Server Error | - |
|
|
954
|
+
|
|
955
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
956
|
+
|
|
957
|
+
|
|
958
|
+
## getApplicationByID
|
|
959
|
+
|
|
960
|
+
> ApplicationDTO getApplicationByID(applicationId)
|
|
961
|
+
|
|
962
|
+
Get an application by applicationId
|
|
963
|
+
|
|
964
|
+
Get a specific application belonging to the authenticated account
|
|
965
|
+
|
|
966
|
+
### Example
|
|
967
|
+
|
|
968
|
+
```ts
|
|
969
|
+
import {
|
|
970
|
+
Configuration,
|
|
971
|
+
ClientApi,
|
|
972
|
+
} from '';
|
|
973
|
+
import type { GetApplicationByIDRequest } from '';
|
|
974
|
+
|
|
975
|
+
async function example() {
|
|
976
|
+
console.log("🚀 Testing SDK...");
|
|
977
|
+
const api = new ClientApi();
|
|
978
|
+
|
|
979
|
+
const body = {
|
|
980
|
+
// string | Application ID
|
|
981
|
+
applicationId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
982
|
+
} satisfies GetApplicationByIDRequest;
|
|
983
|
+
|
|
984
|
+
try {
|
|
985
|
+
const data = await api.getApplicationByID(body);
|
|
986
|
+
console.log(data);
|
|
987
|
+
} catch (error) {
|
|
988
|
+
console.error(error);
|
|
989
|
+
}
|
|
990
|
+
}
|
|
991
|
+
|
|
992
|
+
// Run the test
|
|
993
|
+
example().catch(console.error);
|
|
994
|
+
```
|
|
995
|
+
|
|
996
|
+
### Parameters
|
|
997
|
+
|
|
998
|
+
|
|
999
|
+
| Name | Type | Description | Notes |
|
|
1000
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1001
|
+
| **applicationId** | `string` | Application ID | [Defaults to `undefined`] |
|
|
1002
|
+
|
|
1003
|
+
### Return type
|
|
1004
|
+
|
|
1005
|
+
[**ApplicationDTO**](ApplicationDTO.md)
|
|
1006
|
+
|
|
1007
|
+
### Authorization
|
|
1008
|
+
|
|
1009
|
+
No authorization required
|
|
1010
|
+
|
|
1011
|
+
### HTTP request headers
|
|
1012
|
+
|
|
1013
|
+
- **Content-Type**: Not defined
|
|
1014
|
+
- **Accept**: `application/json`
|
|
1015
|
+
|
|
1016
|
+
|
|
1017
|
+
### HTTP response details
|
|
1018
|
+
| Status code | Description | Response headers |
|
|
1019
|
+
|-------------|-------------|------------------|
|
|
1020
|
+
| **200** | Return an application | - |
|
|
1021
|
+
| **400** | Return an error if provided ID is not a valid UUID | - |
|
|
1022
|
+
| **401** | Return an error if the user is not authenticated | - |
|
|
1023
|
+
| **403** | Return an error if the user does not have the required permissions | - |
|
|
1024
|
+
| **404** | Return an error if the application is not found | - |
|
|
1025
|
+
| **500** | Return an error if the server founds an error | - |
|
|
1026
|
+
|
|
1027
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1028
|
+
|
|
1029
|
+
|
|
1030
|
+
## getApplicationMCPServers
|
|
1031
|
+
|
|
1032
|
+
> Array<ApplicationMCPServerDTO> getApplicationMCPServers(applicationId, page, pageSize)
|
|
1033
|
+
|
|
1034
|
+
List MCP servers for application
|
|
1035
|
+
|
|
1036
|
+
Get all MCP servers attached to the specified application within the authenticated account
|
|
1037
|
+
|
|
1038
|
+
### Example
|
|
1039
|
+
|
|
1040
|
+
```ts
|
|
1041
|
+
import {
|
|
1042
|
+
Configuration,
|
|
1043
|
+
ClientApi,
|
|
1044
|
+
} from '';
|
|
1045
|
+
import type { GetApplicationMCPServersRequest } from '';
|
|
1046
|
+
|
|
1047
|
+
async function example() {
|
|
1048
|
+
console.log("🚀 Testing SDK...");
|
|
1049
|
+
const api = new ClientApi();
|
|
1050
|
+
|
|
1051
|
+
const body = {
|
|
1052
|
+
// string | Application ID
|
|
1053
|
+
applicationId: applicationId_example,
|
|
1054
|
+
// number | Page number (optional)
|
|
1055
|
+
page: 56,
|
|
1056
|
+
// number | Page size (optional)
|
|
1057
|
+
pageSize: 56,
|
|
1058
|
+
} satisfies GetApplicationMCPServersRequest;
|
|
1059
|
+
|
|
1060
|
+
try {
|
|
1061
|
+
const data = await api.getApplicationMCPServers(body);
|
|
1062
|
+
console.log(data);
|
|
1063
|
+
} catch (error) {
|
|
1064
|
+
console.error(error);
|
|
1065
|
+
}
|
|
1066
|
+
}
|
|
1067
|
+
|
|
1068
|
+
// Run the test
|
|
1069
|
+
example().catch(console.error);
|
|
1070
|
+
```
|
|
1071
|
+
|
|
1072
|
+
### Parameters
|
|
1073
|
+
|
|
1074
|
+
|
|
1075
|
+
| Name | Type | Description | Notes |
|
|
1076
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1077
|
+
| **applicationId** | `string` | Application ID | [Defaults to `undefined`] |
|
|
1078
|
+
| **page** | `number` | Page number | [Optional] [Defaults to `1`] |
|
|
1079
|
+
| **pageSize** | `number` | Page size | [Optional] [Defaults to `10`] |
|
|
1080
|
+
|
|
1081
|
+
### Return type
|
|
1082
|
+
|
|
1083
|
+
[**Array<ApplicationMCPServerDTO>**](ApplicationMCPServerDTO.md)
|
|
1084
|
+
|
|
1085
|
+
### Authorization
|
|
1086
|
+
|
|
1087
|
+
No authorization required
|
|
1088
|
+
|
|
1089
|
+
### HTTP request headers
|
|
1090
|
+
|
|
1091
|
+
- **Content-Type**: Not defined
|
|
1092
|
+
- **Accept**: `application/json`
|
|
1093
|
+
|
|
1094
|
+
|
|
1095
|
+
### HTTP response details
|
|
1096
|
+
| Status code | Description | Response headers |
|
|
1097
|
+
|-------------|-------------|------------------|
|
|
1098
|
+
| **200** | List of MCP servers attached to the application | - |
|
|
1099
|
+
| **400** | Bad Request | - |
|
|
1100
|
+
| **401** | Unauthorized | - |
|
|
1101
|
+
| **500** | Internal Server Error | - |
|
|
1102
|
+
|
|
1103
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1104
|
+
|
|
1105
|
+
|
|
1106
|
+
## getApplications
|
|
1107
|
+
|
|
1108
|
+
> PaginatedApplicationsDTO getApplications(page, pageSize)
|
|
1109
|
+
|
|
1110
|
+
Get all applications for the account
|
|
1111
|
+
|
|
1112
|
+
Get all applications belonging to the authenticated account
|
|
1113
|
+
|
|
1114
|
+
### Example
|
|
1115
|
+
|
|
1116
|
+
```ts
|
|
1117
|
+
import {
|
|
1118
|
+
Configuration,
|
|
1119
|
+
ClientApi,
|
|
1120
|
+
} from '';
|
|
1121
|
+
import type { GetApplicationsRequest } from '';
|
|
1122
|
+
|
|
1123
|
+
async function example() {
|
|
1124
|
+
console.log("🚀 Testing SDK...");
|
|
1125
|
+
const api = new ClientApi();
|
|
1126
|
+
|
|
1127
|
+
const body = {
|
|
1128
|
+
// number | Page number for pagination (optional)
|
|
1129
|
+
page: 56,
|
|
1130
|
+
// number | Limit number of items per page (optional)
|
|
1131
|
+
pageSize: 56,
|
|
1132
|
+
} satisfies GetApplicationsRequest;
|
|
1133
|
+
|
|
1134
|
+
try {
|
|
1135
|
+
const data = await api.getApplications(body);
|
|
1136
|
+
console.log(data);
|
|
1137
|
+
} catch (error) {
|
|
1138
|
+
console.error(error);
|
|
1139
|
+
}
|
|
1140
|
+
}
|
|
1141
|
+
|
|
1142
|
+
// Run the test
|
|
1143
|
+
example().catch(console.error);
|
|
1144
|
+
```
|
|
1145
|
+
|
|
1146
|
+
### Parameters
|
|
1147
|
+
|
|
1148
|
+
|
|
1149
|
+
| Name | Type | Description | Notes |
|
|
1150
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1151
|
+
| **page** | `number` | Page number for pagination | [Optional] [Defaults to `1`] |
|
|
1152
|
+
| **pageSize** | `number` | Limit number of items per page | [Optional] [Defaults to `10`] |
|
|
1153
|
+
|
|
1154
|
+
### Return type
|
|
1155
|
+
|
|
1156
|
+
[**PaginatedApplicationsDTO**](PaginatedApplicationsDTO.md)
|
|
1157
|
+
|
|
1158
|
+
### Authorization
|
|
1159
|
+
|
|
1160
|
+
No authorization required
|
|
1161
|
+
|
|
1162
|
+
### HTTP request headers
|
|
1163
|
+
|
|
1164
|
+
- **Content-Type**: Not defined
|
|
1165
|
+
- **Accept**: `application/json`
|
|
1166
|
+
|
|
1167
|
+
|
|
1168
|
+
### HTTP response details
|
|
1169
|
+
| Status code | Description | Response headers |
|
|
1170
|
+
|-------------|-------------|------------------|
|
|
1171
|
+
| **200** | Return a list of applications | - |
|
|
1172
|
+
| **401** | Return an error if the user is not authenticated | - |
|
|
1173
|
+
| **403** | Return an error if the user does not have the required permissions | - |
|
|
1174
|
+
| **500** | Return an error if the server founds an error | - |
|
|
1175
|
+
|
|
1176
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1177
|
+
|
|
1178
|
+
|
|
1179
|
+
## getMCPServers
|
|
1180
|
+
|
|
1181
|
+
> PaginatedMCPServerDTO getMCPServers(page, pageSize)
|
|
1182
|
+
|
|
1183
|
+
List MCP servers for account
|
|
1184
|
+
|
|
1185
|
+
Get all MCP servers attached to any application within the authenticated account
|
|
1186
|
+
|
|
1187
|
+
### Example
|
|
1188
|
+
|
|
1189
|
+
```ts
|
|
1190
|
+
import {
|
|
1191
|
+
Configuration,
|
|
1192
|
+
ClientApi,
|
|
1193
|
+
} from '';
|
|
1194
|
+
import type { GetMCPServersRequest } from '';
|
|
1195
|
+
|
|
1196
|
+
async function example() {
|
|
1197
|
+
console.log("🚀 Testing SDK...");
|
|
1198
|
+
const api = new ClientApi();
|
|
1199
|
+
|
|
1200
|
+
const body = {
|
|
1201
|
+
// number | Page number (optional)
|
|
1202
|
+
page: 56,
|
|
1203
|
+
// number | Page size (optional)
|
|
1204
|
+
pageSize: 56,
|
|
1205
|
+
} satisfies GetMCPServersRequest;
|
|
1206
|
+
|
|
1207
|
+
try {
|
|
1208
|
+
const data = await api.getMCPServers(body);
|
|
1209
|
+
console.log(data);
|
|
1210
|
+
} catch (error) {
|
|
1211
|
+
console.error(error);
|
|
1212
|
+
}
|
|
1213
|
+
}
|
|
1214
|
+
|
|
1215
|
+
// Run the test
|
|
1216
|
+
example().catch(console.error);
|
|
1217
|
+
```
|
|
1218
|
+
|
|
1219
|
+
### Parameters
|
|
1220
|
+
|
|
1221
|
+
|
|
1222
|
+
| Name | Type | Description | Notes |
|
|
1223
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1224
|
+
| **page** | `number` | Page number | [Optional] [Defaults to `1`] |
|
|
1225
|
+
| **pageSize** | `number` | Page size | [Optional] [Defaults to `10`] |
|
|
1226
|
+
|
|
1227
|
+
### Return type
|
|
1228
|
+
|
|
1229
|
+
[**PaginatedMCPServerDTO**](PaginatedMCPServerDTO.md)
|
|
1230
|
+
|
|
1231
|
+
### Authorization
|
|
1232
|
+
|
|
1233
|
+
No authorization required
|
|
1234
|
+
|
|
1235
|
+
### HTTP request headers
|
|
1236
|
+
|
|
1237
|
+
- **Content-Type**: Not defined
|
|
1238
|
+
- **Accept**: `application/json`
|
|
1239
|
+
|
|
1240
|
+
|
|
1241
|
+
### HTTP response details
|
|
1242
|
+
| Status code | Description | Response headers |
|
|
1243
|
+
|-------------|-------------|------------------|
|
|
1244
|
+
| **200** | List of MCP servers | - |
|
|
1245
|
+
| **401** | Unauthorized | - |
|
|
1246
|
+
| **500** | Internal Server Error | - |
|
|
1247
|
+
|
|
1248
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1249
|
+
|
|
1250
|
+
|
|
1251
|
+
## updateApplication
|
|
1252
|
+
|
|
1253
|
+
> ApplicationDTO updateApplication(applicationId, updateApplicationDTO)
|
|
1254
|
+
|
|
1255
|
+
Update an application
|
|
1256
|
+
|
|
1257
|
+
Update an application belonging to the authenticated account
|
|
1258
|
+
|
|
1259
|
+
### Example
|
|
1260
|
+
|
|
1261
|
+
```ts
|
|
1262
|
+
import {
|
|
1263
|
+
Configuration,
|
|
1264
|
+
ClientApi,
|
|
1265
|
+
} from '';
|
|
1266
|
+
import type { UpdateApplicationRequest } from '';
|
|
1267
|
+
|
|
1268
|
+
async function example() {
|
|
1269
|
+
console.log("🚀 Testing SDK...");
|
|
1270
|
+
const api = new ClientApi();
|
|
1271
|
+
|
|
1272
|
+
const body = {
|
|
1273
|
+
// string | Application ID
|
|
1274
|
+
applicationId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1275
|
+
// UpdateApplicationDTO | Application update data
|
|
1276
|
+
updateApplicationDTO: ...,
|
|
1277
|
+
} satisfies UpdateApplicationRequest;
|
|
1278
|
+
|
|
1279
|
+
try {
|
|
1280
|
+
const data = await api.updateApplication(body);
|
|
1281
|
+
console.log(data);
|
|
1282
|
+
} catch (error) {
|
|
1283
|
+
console.error(error);
|
|
1284
|
+
}
|
|
1285
|
+
}
|
|
1286
|
+
|
|
1287
|
+
// Run the test
|
|
1288
|
+
example().catch(console.error);
|
|
1289
|
+
```
|
|
1290
|
+
|
|
1291
|
+
### Parameters
|
|
1292
|
+
|
|
1293
|
+
|
|
1294
|
+
| Name | Type | Description | Notes |
|
|
1295
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1296
|
+
| **applicationId** | `string` | Application ID | [Defaults to `undefined`] |
|
|
1297
|
+
| **updateApplicationDTO** | [UpdateApplicationDTO](UpdateApplicationDTO.md) | Application update data | |
|
|
1298
|
+
|
|
1299
|
+
### Return type
|
|
1300
|
+
|
|
1301
|
+
[**ApplicationDTO**](ApplicationDTO.md)
|
|
1302
|
+
|
|
1303
|
+
### Authorization
|
|
1304
|
+
|
|
1305
|
+
No authorization required
|
|
1306
|
+
|
|
1307
|
+
### HTTP request headers
|
|
1308
|
+
|
|
1309
|
+
- **Content-Type**: `application/json`
|
|
1310
|
+
- **Accept**: `application/json`
|
|
1311
|
+
|
|
1312
|
+
|
|
1313
|
+
### HTTP response details
|
|
1314
|
+
| Status code | Description | Response headers |
|
|
1315
|
+
|-------------|-------------|------------------|
|
|
1316
|
+
| **200** | Updates an application and return an updated application if the ID exists | - |
|
|
1317
|
+
| **400** | Return an error if provided ID is not a valid UUID | - |
|
|
1318
|
+
| **401** | Return an error if the user is not authenticated | - |
|
|
1319
|
+
| **403** | Return an error if the user does not have the required permissions | - |
|
|
1320
|
+
| **404** | Return an error if the application is not found | - |
|
|
1321
|
+
| **500** | Return an error if the server founds an error | - |
|
|
1322
|
+
|
|
1323
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1324
|
+
|
|
1325
|
+
|
|
1326
|
+
## updateMCPServer
|
|
1327
|
+
|
|
1328
|
+
> MCPServerDTO updateMCPServer(mcpServerId, updateMCPServerDTO)
|
|
1329
|
+
|
|
1330
|
+
Update an existing MCP server
|
|
1331
|
+
|
|
1332
|
+
Update an existing MCP server for the authenticated account
|
|
1333
|
+
|
|
1334
|
+
### Example
|
|
1335
|
+
|
|
1336
|
+
```ts
|
|
1337
|
+
import {
|
|
1338
|
+
Configuration,
|
|
1339
|
+
ClientApi,
|
|
1340
|
+
} from '';
|
|
1341
|
+
import type { UpdateMCPServerRequest } from '';
|
|
1342
|
+
|
|
1343
|
+
async function example() {
|
|
1344
|
+
console.log("🚀 Testing SDK...");
|
|
1345
|
+
const api = new ClientApi();
|
|
1346
|
+
|
|
1347
|
+
const body = {
|
|
1348
|
+
// string | MCP Server ID
|
|
1349
|
+
mcpServerId: mcpServerId_example,
|
|
1350
|
+
// UpdateMCPServerDTO | MCP server update data
|
|
1351
|
+
updateMCPServerDTO: ...,
|
|
1352
|
+
} satisfies UpdateMCPServerRequest;
|
|
1353
|
+
|
|
1354
|
+
try {
|
|
1355
|
+
const data = await api.updateMCPServer(body);
|
|
1356
|
+
console.log(data);
|
|
1357
|
+
} catch (error) {
|
|
1358
|
+
console.error(error);
|
|
1359
|
+
}
|
|
1360
|
+
}
|
|
1361
|
+
|
|
1362
|
+
// Run the test
|
|
1363
|
+
example().catch(console.error);
|
|
1364
|
+
```
|
|
1365
|
+
|
|
1366
|
+
### Parameters
|
|
1367
|
+
|
|
1368
|
+
|
|
1369
|
+
| Name | Type | Description | Notes |
|
|
1370
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1371
|
+
| **mcpServerId** | `string` | MCP Server ID | [Defaults to `undefined`] |
|
|
1372
|
+
| **updateMCPServerDTO** | [UpdateMCPServerDTO](UpdateMCPServerDTO.md) | MCP server update data | |
|
|
1373
|
+
|
|
1374
|
+
### Return type
|
|
1375
|
+
|
|
1376
|
+
[**MCPServerDTO**](MCPServerDTO.md)
|
|
1377
|
+
|
|
1378
|
+
### Authorization
|
|
1379
|
+
|
|
1380
|
+
No authorization required
|
|
1381
|
+
|
|
1382
|
+
### HTTP request headers
|
|
1383
|
+
|
|
1384
|
+
- **Content-Type**: `application/json`
|
|
1385
|
+
- **Accept**: `application/json`
|
|
1386
|
+
|
|
1387
|
+
|
|
1388
|
+
### HTTP response details
|
|
1389
|
+
| Status code | Description | Response headers |
|
|
1390
|
+
|-------------|-------------|------------------|
|
|
1391
|
+
| **200** | Updated MCP server | - |
|
|
1392
|
+
| **400** | Bad Request | - |
|
|
1393
|
+
| **401** | Unauthorized | - |
|
|
1394
|
+
| **500** | Internal Server Error | - |
|
|
1395
|
+
|
|
1396
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1397
|
+
|