@agent-os-sdk/client 0.1.2 → 0.2.2
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/dist/client/AgentOsClient.d.ts +39 -44
- package/dist/client/AgentOsClient.d.ts.map +1 -1
- package/dist/client/AgentOsClient.js +162 -44
- package/dist/client/auth.d.ts +102 -0
- package/dist/client/auth.d.ts.map +1 -0
- package/dist/client/auth.js +44 -0
- package/dist/generated/openapi.d.ts +914 -202
- package/dist/generated/openapi.d.ts.map +1 -1
- package/dist/index.d.ts +10 -9
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +3 -1
- package/dist/modules/approvals.d.ts +8 -22
- package/dist/modules/approvals.d.ts.map +1 -1
- package/dist/modules/approvals.js +27 -130
- package/dist/modules/artifacts.d.ts +28 -79
- package/dist/modules/artifacts.d.ts.map +1 -1
- package/dist/modules/artifacts.js +30 -197
- package/dist/modules/budgets.d.ts +47 -70
- package/dist/modules/budgets.d.ts.map +1 -1
- package/dist/modules/budgets.js +28 -139
- package/dist/modules/builder.d.ts +21 -1
- package/dist/modules/builder.d.ts.map +1 -1
- package/dist/modules/builder.js +25 -3
- package/dist/modules/capabilities.d.ts +39 -50
- package/dist/modules/capabilities.d.ts.map +1 -1
- package/dist/modules/capabilities.js +32 -95
- package/dist/modules/deployments.d.ts +49 -92
- package/dist/modules/deployments.d.ts.map +1 -1
- package/dist/modules/deployments.js +37 -209
- package/dist/modules/flows.d.ts +11 -31
- package/dist/modules/flows.d.ts.map +1 -1
- package/dist/modules/flows.js +33 -157
- package/dist/modules/handoff.d.ts +7 -4
- package/dist/modules/handoff.d.ts.map +1 -1
- package/dist/modules/handoff.js +25 -88
- package/dist/modules/incidents.d.ts +40 -101
- package/dist/modules/incidents.d.ts.map +1 -1
- package/dist/modules/incidents.js +31 -208
- package/dist/modules/policies.d.ts +42 -69
- package/dist/modules/policies.d.ts.map +1 -1
- package/dist/modules/policies.js +25 -159
- package/dist/modules/runs.d.ts +89 -3
- package/dist/modules/runs.d.ts.map +1 -1
- package/dist/modules/runs.js +75 -4
- package/package.json +1 -1
- package/src/client/AgentOsClient.ts +185 -67
- package/src/client/auth.ts +148 -0
- package/src/generated/openapi.ts +914 -202
- package/src/generated/swagger.json +770 -630
- package/src/index.ts +22 -10
- package/src/modules/approvals.ts +31 -132
- package/src/modules/artifacts.ts +41 -245
- package/src/modules/budgets.ts +65 -181
- package/src/modules/builder.ts +25 -3
- package/src/modules/capabilities.ts +58 -139
- package/src/modules/deployments.ts +67 -271
- package/src/modules/flows.ts +37 -163
- package/src/modules/handoff.ts +29 -93
- package/src/modules/incidents.ts +56 -282
- package/src/modules/policies.ts +57 -203
- package/src/modules/runs.ts +123 -5
|
@@ -88,17 +88,23 @@ export interface paths {
|
|
|
88
88
|
};
|
|
89
89
|
get?: never;
|
|
90
90
|
put?: never;
|
|
91
|
-
/**
|
|
91
|
+
/**
|
|
92
|
+
* Import an agent bundle.
|
|
93
|
+
* @description Imports an agent bundle into the current tenant/workspace.
|
|
94
|
+
* The agent and all versions are created with new IDs to avoid conflicts.
|
|
95
|
+
*
|
|
96
|
+
* **Security:**
|
|
97
|
+
* - Tenant and workspace are resolved from the authenticated context
|
|
98
|
+
* - Original IDs from the bundle are replaced with new GUIDs
|
|
99
|
+
*/
|
|
92
100
|
post: {
|
|
93
101
|
parameters: {
|
|
94
102
|
query?: never;
|
|
95
|
-
header?:
|
|
96
|
-
"X-Tenant-Id"?: string;
|
|
97
|
-
"X-Workspace-Id"?: string;
|
|
98
|
-
};
|
|
103
|
+
header?: never;
|
|
99
104
|
path?: never;
|
|
100
105
|
cookie?: never;
|
|
101
106
|
};
|
|
107
|
+
/** @description The agent bundle to import. */
|
|
102
108
|
requestBody?: {
|
|
103
109
|
content: {
|
|
104
110
|
"application/json": components["schemas"]["AgentBundle"];
|
|
@@ -107,13 +113,31 @@ export interface paths {
|
|
|
107
113
|
};
|
|
108
114
|
};
|
|
109
115
|
responses: {
|
|
110
|
-
/** @description
|
|
111
|
-
|
|
116
|
+
/** @description Agent imported successfully. */
|
|
117
|
+
201: {
|
|
112
118
|
headers: {
|
|
113
119
|
[name: string]: unknown;
|
|
114
120
|
};
|
|
115
121
|
content?: never;
|
|
116
122
|
};
|
|
123
|
+
/** @description Invalid bundle format. */
|
|
124
|
+
400: {
|
|
125
|
+
headers: {
|
|
126
|
+
[name: string]: unknown;
|
|
127
|
+
};
|
|
128
|
+
content: {
|
|
129
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
130
|
+
};
|
|
131
|
+
};
|
|
132
|
+
/** @description Authentication required or missing workspace context. */
|
|
133
|
+
401: {
|
|
134
|
+
headers: {
|
|
135
|
+
[name: string]: unknown;
|
|
136
|
+
};
|
|
137
|
+
content: {
|
|
138
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
139
|
+
};
|
|
140
|
+
};
|
|
117
141
|
};
|
|
118
142
|
};
|
|
119
143
|
delete?: never;
|
|
@@ -129,10 +153,21 @@ export interface paths {
|
|
|
129
153
|
path?: never;
|
|
130
154
|
cookie?: never;
|
|
131
155
|
};
|
|
156
|
+
/**
|
|
157
|
+
* Lists all agents in the current workspace with pagination.
|
|
158
|
+
* @description Returns a paginated list of agents accessible to the current user within the specified workspace.
|
|
159
|
+
* Results are ordered by creation date (newest first).
|
|
160
|
+
*
|
|
161
|
+
* **Pagination:**
|
|
162
|
+
* Use `skip` and `take` parameters to paginate through large result sets.
|
|
163
|
+
* Default page size is 20, maximum is 100.
|
|
164
|
+
*/
|
|
132
165
|
get: {
|
|
133
166
|
parameters: {
|
|
134
167
|
query?: {
|
|
168
|
+
/** @description Number of records to skip for pagination. Default: 0. */
|
|
135
169
|
skip?: number;
|
|
170
|
+
/** @description Maximum number of records to return. Default: 20, Max: 100. */
|
|
136
171
|
take?: number;
|
|
137
172
|
};
|
|
138
173
|
header?: never;
|
|
@@ -141,16 +176,48 @@ export interface paths {
|
|
|
141
176
|
};
|
|
142
177
|
requestBody?: never;
|
|
143
178
|
responses: {
|
|
144
|
-
/** @description
|
|
179
|
+
/** @description Returns the list of agents. */
|
|
145
180
|
200: {
|
|
146
181
|
headers: {
|
|
147
182
|
[name: string]: unknown;
|
|
148
183
|
};
|
|
149
184
|
content?: never;
|
|
150
185
|
};
|
|
186
|
+
/** @description X-Workspace-Id header is required. */
|
|
187
|
+
400: {
|
|
188
|
+
headers: {
|
|
189
|
+
[name: string]: unknown;
|
|
190
|
+
};
|
|
191
|
+
content: {
|
|
192
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
193
|
+
};
|
|
194
|
+
};
|
|
195
|
+
/** @description Authentication required. */
|
|
196
|
+
401: {
|
|
197
|
+
headers: {
|
|
198
|
+
[name: string]: unknown;
|
|
199
|
+
};
|
|
200
|
+
content: {
|
|
201
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
202
|
+
};
|
|
203
|
+
};
|
|
151
204
|
};
|
|
152
205
|
};
|
|
153
206
|
put?: never;
|
|
207
|
+
/**
|
|
208
|
+
* Creates a new agent in the current workspace.
|
|
209
|
+
* @description Creates a new agent with the specified configuration. The agent is created in draft mode
|
|
210
|
+
* and must have a version published before it can be used for runs.
|
|
211
|
+
*
|
|
212
|
+
* **Example Request:**
|
|
213
|
+
* ```json
|
|
214
|
+
* {
|
|
215
|
+
* "name": "customer-support-agent",
|
|
216
|
+
* "description": "Handles customer inquiries and support tickets",
|
|
217
|
+
* "graph_spec": { "nodes": [...], "edges": [...] }
|
|
218
|
+
* }
|
|
219
|
+
* ```
|
|
220
|
+
*/
|
|
154
221
|
post: {
|
|
155
222
|
parameters: {
|
|
156
223
|
query?: never;
|
|
@@ -158,6 +225,7 @@ export interface paths {
|
|
|
158
225
|
path?: never;
|
|
159
226
|
cookie?: never;
|
|
160
227
|
};
|
|
228
|
+
/** @description The agent creation request containing name, description, and optional graph specification. */
|
|
161
229
|
requestBody?: {
|
|
162
230
|
content: {
|
|
163
231
|
"application/json": components["schemas"]["CreateAgentRequest"];
|
|
@@ -166,13 +234,40 @@ export interface paths {
|
|
|
166
234
|
};
|
|
167
235
|
};
|
|
168
236
|
responses: {
|
|
169
|
-
/** @description
|
|
170
|
-
|
|
237
|
+
/** @description Agent created successfully. Returns the new agent details. */
|
|
238
|
+
201: {
|
|
171
239
|
headers: {
|
|
172
240
|
[name: string]: unknown;
|
|
173
241
|
};
|
|
174
242
|
content?: never;
|
|
175
243
|
};
|
|
244
|
+
/** @description Invalid request body. Check required fields and data formats. */
|
|
245
|
+
400: {
|
|
246
|
+
headers: {
|
|
247
|
+
[name: string]: unknown;
|
|
248
|
+
};
|
|
249
|
+
content: {
|
|
250
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
251
|
+
};
|
|
252
|
+
};
|
|
253
|
+
/** @description Authentication required. Provide a valid Bearer token. */
|
|
254
|
+
401: {
|
|
255
|
+
headers: {
|
|
256
|
+
[name: string]: unknown;
|
|
257
|
+
};
|
|
258
|
+
content: {
|
|
259
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
260
|
+
};
|
|
261
|
+
};
|
|
262
|
+
/** @description An agent with this name already exists in the workspace. */
|
|
263
|
+
409: {
|
|
264
|
+
headers: {
|
|
265
|
+
[name: string]: unknown;
|
|
266
|
+
};
|
|
267
|
+
content: {
|
|
268
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
269
|
+
};
|
|
270
|
+
};
|
|
176
271
|
};
|
|
177
272
|
};
|
|
178
273
|
delete?: never;
|
|
@@ -188,64 +283,132 @@ export interface paths {
|
|
|
188
283
|
path?: never;
|
|
189
284
|
cookie?: never;
|
|
190
285
|
};
|
|
191
|
-
/**
|
|
286
|
+
/**
|
|
287
|
+
* Retrieves a specific agent by its unique identifier.
|
|
288
|
+
* @description Returns the full agent details including configuration, live version reference,
|
|
289
|
+
* and metadata. Access is restricted to agents within your tenant (IDOR protected).
|
|
290
|
+
*/
|
|
192
291
|
get: {
|
|
193
292
|
parameters: {
|
|
194
293
|
query?: never;
|
|
195
294
|
header?: never;
|
|
196
295
|
path: {
|
|
296
|
+
/** @description The unique identifier (GUID) of the agent to retrieve. */
|
|
197
297
|
id: string;
|
|
198
298
|
};
|
|
199
299
|
cookie?: never;
|
|
200
300
|
};
|
|
201
301
|
requestBody?: never;
|
|
202
302
|
responses: {
|
|
203
|
-
/** @description
|
|
303
|
+
/** @description Returns the agent details. */
|
|
204
304
|
200: {
|
|
205
305
|
headers: {
|
|
206
306
|
[name: string]: unknown;
|
|
207
307
|
};
|
|
208
308
|
content?: never;
|
|
209
309
|
};
|
|
310
|
+
/** @description Authentication required. */
|
|
311
|
+
401: {
|
|
312
|
+
headers: {
|
|
313
|
+
[name: string]: unknown;
|
|
314
|
+
};
|
|
315
|
+
content: {
|
|
316
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
317
|
+
};
|
|
318
|
+
};
|
|
319
|
+
/** @description Agent not found or not accessible. */
|
|
320
|
+
404: {
|
|
321
|
+
headers: {
|
|
322
|
+
[name: string]: unknown;
|
|
323
|
+
};
|
|
324
|
+
content: {
|
|
325
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
326
|
+
};
|
|
327
|
+
};
|
|
210
328
|
};
|
|
211
329
|
};
|
|
212
330
|
put?: never;
|
|
213
331
|
post?: never;
|
|
214
|
-
/**
|
|
332
|
+
/**
|
|
333
|
+
* Deletes an agent from the workspace.
|
|
334
|
+
* @description By default, performs a soft delete (marks as deleted but retains data).
|
|
335
|
+
* Use `hardDelete=true` to permanently remove the agent and all associated data.
|
|
336
|
+
*
|
|
337
|
+
* **Warning:** Hard delete is irreversible and will remove:
|
|
338
|
+
* - All agent versions
|
|
339
|
+
* - All associated runs and threads
|
|
340
|
+
* - All credential bindings
|
|
341
|
+
*/
|
|
215
342
|
delete: {
|
|
216
343
|
parameters: {
|
|
217
344
|
query?: {
|
|
345
|
+
/** @description If true, permanently deletes the agent. Default: false (soft delete). */
|
|
218
346
|
hardDelete?: boolean;
|
|
219
347
|
};
|
|
220
348
|
header?: never;
|
|
221
349
|
path: {
|
|
350
|
+
/** @description The unique identifier (GUID) of the agent to delete. */
|
|
222
351
|
id: string;
|
|
223
352
|
};
|
|
224
353
|
cookie?: never;
|
|
225
354
|
};
|
|
226
355
|
requestBody?: never;
|
|
227
356
|
responses: {
|
|
228
|
-
/** @description
|
|
229
|
-
|
|
357
|
+
/** @description Agent deleted successfully. */
|
|
358
|
+
204: {
|
|
230
359
|
headers: {
|
|
231
360
|
[name: string]: unknown;
|
|
232
361
|
};
|
|
233
362
|
content?: never;
|
|
234
363
|
};
|
|
364
|
+
/** @description Authentication required. */
|
|
365
|
+
401: {
|
|
366
|
+
headers: {
|
|
367
|
+
[name: string]: unknown;
|
|
368
|
+
};
|
|
369
|
+
content: {
|
|
370
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
371
|
+
};
|
|
372
|
+
};
|
|
373
|
+
/** @description Agent not found or not accessible. */
|
|
374
|
+
404: {
|
|
375
|
+
headers: {
|
|
376
|
+
[name: string]: unknown;
|
|
377
|
+
};
|
|
378
|
+
content: {
|
|
379
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
380
|
+
};
|
|
381
|
+
};
|
|
235
382
|
};
|
|
236
383
|
};
|
|
237
384
|
options?: never;
|
|
238
385
|
head?: never;
|
|
239
|
-
/**
|
|
386
|
+
/**
|
|
387
|
+
* Updates an existing agent's metadata and configuration.
|
|
388
|
+
* @description Performs a partial update (PATCH) on the agent. Only provided fields are updated.
|
|
389
|
+
*
|
|
390
|
+
* **Note:** This updates the agent metadata, not the version. To update the agent's
|
|
391
|
+
* behavior/graph, create a new version instead.
|
|
392
|
+
*
|
|
393
|
+
* **Example Request:**
|
|
394
|
+
* ```json
|
|
395
|
+
* {
|
|
396
|
+
* "name": "updated-agent-name",
|
|
397
|
+
* "description": "New description for the agent"
|
|
398
|
+
* }
|
|
399
|
+
* ```
|
|
400
|
+
*/
|
|
240
401
|
patch: {
|
|
241
402
|
parameters: {
|
|
242
403
|
query?: never;
|
|
243
404
|
header?: never;
|
|
244
405
|
path: {
|
|
406
|
+
/** @description The unique identifier (GUID) of the agent to update. */
|
|
245
407
|
id: string;
|
|
246
408
|
};
|
|
247
409
|
cookie?: never;
|
|
248
410
|
};
|
|
411
|
+
/** @description The fields to update. Only non-null fields will be modified. */
|
|
249
412
|
requestBody?: {
|
|
250
413
|
content: {
|
|
251
414
|
"application/json": components["schemas"]["UpdateAgentRequest"];
|
|
@@ -254,13 +417,40 @@ export interface paths {
|
|
|
254
417
|
};
|
|
255
418
|
};
|
|
256
419
|
responses: {
|
|
257
|
-
/** @description
|
|
420
|
+
/** @description Agent updated successfully. Returns updated agent. */
|
|
258
421
|
200: {
|
|
259
422
|
headers: {
|
|
260
423
|
[name: string]: unknown;
|
|
261
424
|
};
|
|
262
425
|
content?: never;
|
|
263
426
|
};
|
|
427
|
+
/** @description Invalid request body. */
|
|
428
|
+
400: {
|
|
429
|
+
headers: {
|
|
430
|
+
[name: string]: unknown;
|
|
431
|
+
};
|
|
432
|
+
content: {
|
|
433
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
434
|
+
};
|
|
435
|
+
};
|
|
436
|
+
/** @description Authentication required. */
|
|
437
|
+
401: {
|
|
438
|
+
headers: {
|
|
439
|
+
[name: string]: unknown;
|
|
440
|
+
};
|
|
441
|
+
content: {
|
|
442
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
443
|
+
};
|
|
444
|
+
};
|
|
445
|
+
/** @description Agent not found or not accessible. */
|
|
446
|
+
404: {
|
|
447
|
+
headers: {
|
|
448
|
+
[name: string]: unknown;
|
|
449
|
+
};
|
|
450
|
+
content: {
|
|
451
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
452
|
+
};
|
|
453
|
+
};
|
|
264
454
|
};
|
|
265
455
|
};
|
|
266
456
|
trace?: never;
|
|
@@ -272,25 +462,57 @@ export interface paths {
|
|
|
272
462
|
path?: never;
|
|
273
463
|
cookie?: never;
|
|
274
464
|
};
|
|
275
|
-
/**
|
|
465
|
+
/**
|
|
466
|
+
* Gets a Mermaid diagram representation of the agent's graph.
|
|
467
|
+
* @description Returns the agent's workflow as a Mermaid diagram string that can be rendered
|
|
468
|
+
* in any Mermaid-compatible viewer. Uses the currently live version of the agent.
|
|
469
|
+
*
|
|
470
|
+
* **Example Response:**
|
|
471
|
+
* ```json
|
|
472
|
+
* {
|
|
473
|
+
* "mermaid": "graph TD\n START --> LLM --> END",
|
|
474
|
+
* "agent_id": "...",
|
|
475
|
+
* "live_version_id": "..."
|
|
476
|
+
* }
|
|
477
|
+
* ```
|
|
478
|
+
*/
|
|
276
479
|
get: {
|
|
277
480
|
parameters: {
|
|
278
481
|
query?: never;
|
|
279
482
|
header?: never;
|
|
280
483
|
path: {
|
|
484
|
+
/** @description The unique identifier (GUID) of the agent. */
|
|
281
485
|
id: string;
|
|
282
486
|
};
|
|
283
487
|
cookie?: never;
|
|
284
488
|
};
|
|
285
489
|
requestBody?: never;
|
|
286
490
|
responses: {
|
|
287
|
-
/** @description
|
|
491
|
+
/** @description Returns the Mermaid graph representation. */
|
|
288
492
|
200: {
|
|
289
493
|
headers: {
|
|
290
494
|
[name: string]: unknown;
|
|
291
495
|
};
|
|
292
496
|
content?: never;
|
|
293
497
|
};
|
|
498
|
+
/** @description Authentication required. */
|
|
499
|
+
401: {
|
|
500
|
+
headers: {
|
|
501
|
+
[name: string]: unknown;
|
|
502
|
+
};
|
|
503
|
+
content: {
|
|
504
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
505
|
+
};
|
|
506
|
+
};
|
|
507
|
+
/** @description Agent not found or not accessible. */
|
|
508
|
+
404: {
|
|
509
|
+
headers: {
|
|
510
|
+
[name: string]: unknown;
|
|
511
|
+
};
|
|
512
|
+
content: {
|
|
513
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
514
|
+
};
|
|
515
|
+
};
|
|
294
516
|
};
|
|
295
517
|
};
|
|
296
518
|
put?: never;
|
|
@@ -382,38 +604,67 @@ export interface paths {
|
|
|
382
604
|
path?: never;
|
|
383
605
|
cookie?: never;
|
|
384
606
|
};
|
|
385
|
-
/**
|
|
607
|
+
/**
|
|
608
|
+
* Lists all versions for an agent.
|
|
609
|
+
* @description Returns all versions of the specified agent, ordered by creation date (newest first).
|
|
610
|
+
* The response includes which version is currently set as "live".
|
|
611
|
+
*/
|
|
386
612
|
get: {
|
|
387
613
|
parameters: {
|
|
388
614
|
query?: never;
|
|
389
615
|
header?: never;
|
|
390
616
|
path: {
|
|
617
|
+
/** @description The unique identifier of the agent. */
|
|
391
618
|
agentId: string;
|
|
392
619
|
};
|
|
393
620
|
cookie?: never;
|
|
394
621
|
};
|
|
395
622
|
requestBody?: never;
|
|
396
623
|
responses: {
|
|
397
|
-
/** @description
|
|
624
|
+
/** @description Returns the list of versions. */
|
|
398
625
|
200: {
|
|
399
626
|
headers: {
|
|
400
627
|
[name: string]: unknown;
|
|
401
628
|
};
|
|
402
629
|
content?: never;
|
|
403
630
|
};
|
|
631
|
+
/** @description Authentication required. */
|
|
632
|
+
401: {
|
|
633
|
+
headers: {
|
|
634
|
+
[name: string]: unknown;
|
|
635
|
+
};
|
|
636
|
+
content: {
|
|
637
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
638
|
+
};
|
|
639
|
+
};
|
|
404
640
|
};
|
|
405
641
|
};
|
|
406
642
|
put?: never;
|
|
407
|
-
/**
|
|
643
|
+
/**
|
|
644
|
+
* Creates a new version for an agent.
|
|
645
|
+
* @description Creates an immutable snapshot of the agent's configuration. The new version
|
|
646
|
+
* can optionally be marked as the live version immediately.
|
|
647
|
+
*
|
|
648
|
+
* **Example Request:**
|
|
649
|
+
* ```json
|
|
650
|
+
* {
|
|
651
|
+
* "version_tag": "v1.2.0",
|
|
652
|
+
* "graph_spec": { "nodes": [...], "edges": [...] },
|
|
653
|
+
* "set_live": true
|
|
654
|
+
* }
|
|
655
|
+
* ```
|
|
656
|
+
*/
|
|
408
657
|
post: {
|
|
409
658
|
parameters: {
|
|
410
659
|
query?: never;
|
|
411
660
|
header?: never;
|
|
412
661
|
path: {
|
|
662
|
+
/** @description The unique identifier of the parent agent. */
|
|
413
663
|
agentId: string;
|
|
414
664
|
};
|
|
415
665
|
cookie?: never;
|
|
416
666
|
};
|
|
667
|
+
/** @description The version creation request with graph specification. */
|
|
417
668
|
requestBody?: {
|
|
418
669
|
content: {
|
|
419
670
|
"application/json": components["schemas"]["CreateAgentVersionRequest"];
|
|
@@ -422,13 +673,40 @@ export interface paths {
|
|
|
422
673
|
};
|
|
423
674
|
};
|
|
424
675
|
responses: {
|
|
425
|
-
/** @description
|
|
426
|
-
|
|
676
|
+
/** @description Version created successfully. */
|
|
677
|
+
201: {
|
|
427
678
|
headers: {
|
|
428
679
|
[name: string]: unknown;
|
|
429
680
|
};
|
|
430
681
|
content?: never;
|
|
431
682
|
};
|
|
683
|
+
/** @description Invalid request body or validation error. */
|
|
684
|
+
400: {
|
|
685
|
+
headers: {
|
|
686
|
+
[name: string]: unknown;
|
|
687
|
+
};
|
|
688
|
+
content: {
|
|
689
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
690
|
+
};
|
|
691
|
+
};
|
|
692
|
+
/** @description Authentication required. */
|
|
693
|
+
401: {
|
|
694
|
+
headers: {
|
|
695
|
+
[name: string]: unknown;
|
|
696
|
+
};
|
|
697
|
+
content: {
|
|
698
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
699
|
+
};
|
|
700
|
+
};
|
|
701
|
+
/** @description Parent agent not found. */
|
|
702
|
+
404: {
|
|
703
|
+
headers: {
|
|
704
|
+
[name: string]: unknown;
|
|
705
|
+
};
|
|
706
|
+
content: {
|
|
707
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
708
|
+
};
|
|
709
|
+
};
|
|
432
710
|
};
|
|
433
711
|
};
|
|
434
712
|
delete?: never;
|
|
@@ -444,26 +722,50 @@ export interface paths {
|
|
|
444
722
|
path?: never;
|
|
445
723
|
cookie?: never;
|
|
446
724
|
};
|
|
447
|
-
/**
|
|
725
|
+
/**
|
|
726
|
+
* Retrieves a specific version by its identifier.
|
|
727
|
+
* @description Returns the full details of a specific agent version, including its
|
|
728
|
+
* graph specification and all configuration settings.
|
|
729
|
+
*/
|
|
448
730
|
get: {
|
|
449
731
|
parameters: {
|
|
450
732
|
query?: never;
|
|
451
733
|
header?: never;
|
|
452
734
|
path: {
|
|
735
|
+
/** @description The unique identifier of the parent agent. */
|
|
453
736
|
agentId: string;
|
|
737
|
+
/** @description The unique identifier of the version to retrieve. */
|
|
454
738
|
versionId: string;
|
|
455
739
|
};
|
|
456
740
|
cookie?: never;
|
|
457
741
|
};
|
|
458
742
|
requestBody?: never;
|
|
459
743
|
responses: {
|
|
460
|
-
/** @description
|
|
744
|
+
/** @description Returns the version details. */
|
|
461
745
|
200: {
|
|
462
746
|
headers: {
|
|
463
747
|
[name: string]: unknown;
|
|
464
748
|
};
|
|
465
749
|
content?: never;
|
|
466
750
|
};
|
|
751
|
+
/** @description Authentication required. */
|
|
752
|
+
401: {
|
|
753
|
+
headers: {
|
|
754
|
+
[name: string]: unknown;
|
|
755
|
+
};
|
|
756
|
+
content: {
|
|
757
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
758
|
+
};
|
|
759
|
+
};
|
|
760
|
+
/** @description Version not found. */
|
|
761
|
+
404: {
|
|
762
|
+
headers: {
|
|
763
|
+
[name: string]: unknown;
|
|
764
|
+
};
|
|
765
|
+
content: {
|
|
766
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
767
|
+
};
|
|
768
|
+
};
|
|
467
769
|
};
|
|
468
770
|
};
|
|
469
771
|
put?: never;
|
|
@@ -471,17 +773,29 @@ export interface paths {
|
|
|
471
773
|
delete?: never;
|
|
472
774
|
options?: never;
|
|
473
775
|
head?: never;
|
|
474
|
-
/**
|
|
776
|
+
/**
|
|
777
|
+
* Updates are not allowed - versions are immutable.
|
|
778
|
+
* @description Agent versions are immutable by design. This endpoint always returns a 409 Conflict
|
|
779
|
+
* to enforce this invariant. To change an agent's behavior, create a new version instead.
|
|
780
|
+
*
|
|
781
|
+
* **Why immutability?**
|
|
782
|
+
* - Reproducibility: Every run can be traced to an exact version
|
|
783
|
+
* - Auditability: Version history provides a complete changelog
|
|
784
|
+
* - Rollback: Easy to revert to any previous version
|
|
785
|
+
*/
|
|
475
786
|
patch: {
|
|
476
787
|
parameters: {
|
|
477
788
|
query?: never;
|
|
478
789
|
header?: never;
|
|
479
790
|
path: {
|
|
791
|
+
/** @description The unique identifier of the parent agent. */
|
|
480
792
|
agentId: string;
|
|
793
|
+
/** @description The unique identifier of the version. */
|
|
481
794
|
versionId: string;
|
|
482
795
|
};
|
|
483
796
|
cookie?: never;
|
|
484
797
|
};
|
|
798
|
+
/** @description The update request (ignored - updates not allowed). */
|
|
485
799
|
requestBody?: {
|
|
486
800
|
content: {
|
|
487
801
|
"application/json": unknown;
|
|
@@ -490,12 +804,14 @@ export interface paths {
|
|
|
490
804
|
};
|
|
491
805
|
};
|
|
492
806
|
responses: {
|
|
493
|
-
/** @description
|
|
494
|
-
|
|
807
|
+
/** @description Versions are immutable. Create a new version instead. */
|
|
808
|
+
409: {
|
|
495
809
|
headers: {
|
|
496
810
|
[name: string]: unknown;
|
|
497
811
|
};
|
|
498
|
-
content
|
|
812
|
+
content: {
|
|
813
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
814
|
+
};
|
|
499
815
|
};
|
|
500
816
|
};
|
|
501
817
|
};
|
|
@@ -509,8 +825,9 @@ export interface paths {
|
|
|
509
825
|
cookie?: never;
|
|
510
826
|
};
|
|
511
827
|
/**
|
|
512
|
-
*
|
|
513
|
-
*
|
|
828
|
+
* Lists all API tokens for the current workspace.
|
|
829
|
+
* @description Returns token metadata without secrets. Token secrets are only
|
|
830
|
+
* available at creation time and cannot be retrieved later.
|
|
514
831
|
*/
|
|
515
832
|
get: {
|
|
516
833
|
parameters: {
|
|
@@ -520,6 +837,44 @@ export interface paths {
|
|
|
520
837
|
cookie?: never;
|
|
521
838
|
};
|
|
522
839
|
requestBody?: never;
|
|
840
|
+
responses: {
|
|
841
|
+
/** @description Returns the list of tokens. */
|
|
842
|
+
200: {
|
|
843
|
+
headers: {
|
|
844
|
+
[name: string]: unknown;
|
|
845
|
+
};
|
|
846
|
+
content?: never;
|
|
847
|
+
};
|
|
848
|
+
/** @description Workspace ID header is required. */
|
|
849
|
+
400: {
|
|
850
|
+
headers: {
|
|
851
|
+
[name: string]: unknown;
|
|
852
|
+
};
|
|
853
|
+
content: {
|
|
854
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
855
|
+
};
|
|
856
|
+
};
|
|
857
|
+
};
|
|
858
|
+
};
|
|
859
|
+
put?: never;
|
|
860
|
+
/**
|
|
861
|
+
* Create a new API token.
|
|
862
|
+
* The token secret is only returned once on creation.
|
|
863
|
+
*/
|
|
864
|
+
post: {
|
|
865
|
+
parameters: {
|
|
866
|
+
query?: never;
|
|
867
|
+
header?: never;
|
|
868
|
+
path?: never;
|
|
869
|
+
cookie?: never;
|
|
870
|
+
};
|
|
871
|
+
requestBody?: {
|
|
872
|
+
content: {
|
|
873
|
+
"application/json": components["schemas"]["CreateTokenRequest"];
|
|
874
|
+
"text/json": components["schemas"]["CreateTokenRequest"];
|
|
875
|
+
"application/*+json": components["schemas"]["CreateTokenRequest"];
|
|
876
|
+
};
|
|
877
|
+
};
|
|
523
878
|
responses: {
|
|
524
879
|
/** @description OK */
|
|
525
880
|
200: {
|
|
@@ -530,25 +885,158 @@ export interface paths {
|
|
|
530
885
|
};
|
|
531
886
|
};
|
|
532
887
|
};
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
888
|
+
delete?: never;
|
|
889
|
+
options?: never;
|
|
890
|
+
head?: never;
|
|
891
|
+
patch?: never;
|
|
892
|
+
trace?: never;
|
|
893
|
+
};
|
|
894
|
+
"/v1/api/tokens/{id}": {
|
|
895
|
+
parameters: {
|
|
896
|
+
query?: never;
|
|
897
|
+
header?: never;
|
|
898
|
+
path?: never;
|
|
899
|
+
cookie?: never;
|
|
900
|
+
};
|
|
901
|
+
get?: never;
|
|
902
|
+
put?: never;
|
|
903
|
+
post?: never;
|
|
904
|
+
/** Revoke an API token immediately. */
|
|
905
|
+
delete: {
|
|
906
|
+
parameters: {
|
|
907
|
+
query?: never;
|
|
908
|
+
header?: never;
|
|
909
|
+
path: {
|
|
910
|
+
id: string;
|
|
911
|
+
};
|
|
912
|
+
cookie?: never;
|
|
913
|
+
};
|
|
914
|
+
requestBody?: never;
|
|
915
|
+
responses: {
|
|
916
|
+
/** @description OK */
|
|
917
|
+
200: {
|
|
918
|
+
headers: {
|
|
919
|
+
[name: string]: unknown;
|
|
920
|
+
};
|
|
921
|
+
content?: never;
|
|
922
|
+
};
|
|
923
|
+
};
|
|
924
|
+
};
|
|
925
|
+
options?: never;
|
|
926
|
+
head?: never;
|
|
927
|
+
patch?: never;
|
|
928
|
+
trace?: never;
|
|
929
|
+
};
|
|
930
|
+
"/v1/api/tokens/{id}/rotate": {
|
|
931
|
+
parameters: {
|
|
932
|
+
query?: never;
|
|
933
|
+
header?: never;
|
|
934
|
+
path?: never;
|
|
935
|
+
cookie?: never;
|
|
936
|
+
};
|
|
937
|
+
get?: never;
|
|
938
|
+
put?: never;
|
|
939
|
+
/**
|
|
940
|
+
* Rotate an API token - revokes current and issues a new one.
|
|
941
|
+
* The new token secret is only returned once.
|
|
942
|
+
* @description Rotation is useful for security hygiene (periodic credential rotation)
|
|
943
|
+
* or when a token may have been compromised. The new token inherits
|
|
944
|
+
* the same scopes and expiration policy as the original.
|
|
945
|
+
*/
|
|
946
|
+
post: {
|
|
947
|
+
parameters: {
|
|
948
|
+
query?: never;
|
|
949
|
+
header?: never;
|
|
950
|
+
path: {
|
|
951
|
+
/** @description Token ID to rotate. */
|
|
952
|
+
id: string;
|
|
953
|
+
};
|
|
954
|
+
cookie?: never;
|
|
955
|
+
};
|
|
956
|
+
requestBody?: never;
|
|
957
|
+
responses: {
|
|
958
|
+
/** @description Token rotated successfully, new secret returned. */
|
|
959
|
+
200: {
|
|
960
|
+
headers: {
|
|
961
|
+
[name: string]: unknown;
|
|
962
|
+
};
|
|
963
|
+
content?: never;
|
|
964
|
+
};
|
|
965
|
+
/** @description Token not found or already revoked. */
|
|
966
|
+
404: {
|
|
967
|
+
headers: {
|
|
968
|
+
[name: string]: unknown;
|
|
969
|
+
};
|
|
970
|
+
content: {
|
|
971
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
972
|
+
};
|
|
973
|
+
};
|
|
974
|
+
};
|
|
975
|
+
};
|
|
976
|
+
delete?: never;
|
|
977
|
+
options?: never;
|
|
978
|
+
head?: never;
|
|
979
|
+
patch?: never;
|
|
980
|
+
trace?: never;
|
|
981
|
+
};
|
|
982
|
+
"/v1/api/workspaces/{workspaceId}/approvals": {
|
|
983
|
+
parameters: {
|
|
984
|
+
query?: never;
|
|
985
|
+
header?: never;
|
|
986
|
+
path?: never;
|
|
987
|
+
cookie?: never;
|
|
988
|
+
};
|
|
989
|
+
/** List approvals for a workspace, optionally filtered by status. */
|
|
990
|
+
get: {
|
|
991
|
+
parameters: {
|
|
992
|
+
query?: {
|
|
993
|
+
status?: string;
|
|
994
|
+
limit?: number;
|
|
995
|
+
};
|
|
996
|
+
header?: never;
|
|
997
|
+
path: {
|
|
998
|
+
workspaceId: string;
|
|
999
|
+
};
|
|
1000
|
+
cookie?: never;
|
|
1001
|
+
};
|
|
1002
|
+
requestBody?: never;
|
|
1003
|
+
responses: {
|
|
1004
|
+
/** @description OK */
|
|
1005
|
+
200: {
|
|
1006
|
+
headers: {
|
|
1007
|
+
[name: string]: unknown;
|
|
1008
|
+
};
|
|
1009
|
+
content?: never;
|
|
1010
|
+
};
|
|
1011
|
+
};
|
|
1012
|
+
};
|
|
1013
|
+
put?: never;
|
|
1014
|
+
post?: never;
|
|
1015
|
+
delete?: never;
|
|
1016
|
+
options?: never;
|
|
1017
|
+
head?: never;
|
|
1018
|
+
patch?: never;
|
|
1019
|
+
trace?: never;
|
|
1020
|
+
};
|
|
1021
|
+
"/v1/api/workspaces/{workspaceId}/approvals/{approvalId}": {
|
|
1022
|
+
parameters: {
|
|
1023
|
+
query?: never;
|
|
1024
|
+
header?: never;
|
|
1025
|
+
path?: never;
|
|
1026
|
+
cookie?: never;
|
|
1027
|
+
};
|
|
1028
|
+
/** Get a specific approval by ID. */
|
|
1029
|
+
get: {
|
|
539
1030
|
parameters: {
|
|
540
1031
|
query?: never;
|
|
541
1032
|
header?: never;
|
|
542
|
-
path
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
requestBody?: {
|
|
546
|
-
content: {
|
|
547
|
-
"application/json": components["schemas"]["CreateTokenRequest"];
|
|
548
|
-
"text/json": components["schemas"]["CreateTokenRequest"];
|
|
549
|
-
"application/*+json": components["schemas"]["CreateTokenRequest"];
|
|
1033
|
+
path: {
|
|
1034
|
+
workspaceId: string;
|
|
1035
|
+
approvalId: string;
|
|
550
1036
|
};
|
|
1037
|
+
cookie?: never;
|
|
551
1038
|
};
|
|
1039
|
+
requestBody?: never;
|
|
552
1040
|
responses: {
|
|
553
1041
|
/** @description OK */
|
|
554
1042
|
200: {
|
|
@@ -559,13 +1047,15 @@ export interface paths {
|
|
|
559
1047
|
};
|
|
560
1048
|
};
|
|
561
1049
|
};
|
|
1050
|
+
put?: never;
|
|
1051
|
+
post?: never;
|
|
562
1052
|
delete?: never;
|
|
563
1053
|
options?: never;
|
|
564
1054
|
head?: never;
|
|
565
1055
|
patch?: never;
|
|
566
1056
|
trace?: never;
|
|
567
1057
|
};
|
|
568
|
-
"/v1/api/
|
|
1058
|
+
"/v1/api/workspaces/{workspaceId}/approvals/{approvalId}/decision": {
|
|
569
1059
|
parameters: {
|
|
570
1060
|
query?: never;
|
|
571
1061
|
header?: never;
|
|
@@ -574,18 +1064,27 @@ export interface paths {
|
|
|
574
1064
|
};
|
|
575
1065
|
get?: never;
|
|
576
1066
|
put?: never;
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
1067
|
+
/**
|
|
1068
|
+
* Decide on an approval: approve or deny.
|
|
1069
|
+
* Idempotent: re-deciding returns 200 no-op.
|
|
1070
|
+
*/
|
|
1071
|
+
post: {
|
|
580
1072
|
parameters: {
|
|
581
1073
|
query?: never;
|
|
582
1074
|
header?: never;
|
|
583
1075
|
path: {
|
|
584
|
-
|
|
1076
|
+
workspaceId: string;
|
|
1077
|
+
approvalId: string;
|
|
585
1078
|
};
|
|
586
1079
|
cookie?: never;
|
|
587
1080
|
};
|
|
588
|
-
requestBody?:
|
|
1081
|
+
requestBody?: {
|
|
1082
|
+
content: {
|
|
1083
|
+
"application/json": components["schemas"]["ApprovalDecision"];
|
|
1084
|
+
"text/json": components["schemas"]["ApprovalDecision"];
|
|
1085
|
+
"application/*+json": components["schemas"]["ApprovalDecision"];
|
|
1086
|
+
};
|
|
1087
|
+
};
|
|
589
1088
|
responses: {
|
|
590
1089
|
/** @description OK */
|
|
591
1090
|
200: {
|
|
@@ -596,6 +1095,7 @@ export interface paths {
|
|
|
596
1095
|
};
|
|
597
1096
|
};
|
|
598
1097
|
};
|
|
1098
|
+
delete?: never;
|
|
599
1099
|
options?: never;
|
|
600
1100
|
head?: never;
|
|
601
1101
|
patch?: never;
|
|
@@ -833,9 +1333,7 @@ export interface paths {
|
|
|
833
1333
|
[name: string]: unknown;
|
|
834
1334
|
};
|
|
835
1335
|
content: {
|
|
836
|
-
"text/plain": components["schemas"]["CheckpointListResponse"];
|
|
837
1336
|
"application/json": components["schemas"]["CheckpointListResponse"];
|
|
838
|
-
"text/json": components["schemas"]["CheckpointListResponse"];
|
|
839
1337
|
};
|
|
840
1338
|
};
|
|
841
1339
|
/** @description Not Found */
|
|
@@ -844,9 +1342,7 @@ export interface paths {
|
|
|
844
1342
|
[name: string]: unknown;
|
|
845
1343
|
};
|
|
846
1344
|
content: {
|
|
847
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
848
1345
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
849
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
850
1346
|
};
|
|
851
1347
|
};
|
|
852
1348
|
};
|
|
@@ -877,9 +1373,7 @@ export interface paths {
|
|
|
877
1373
|
[name: string]: unknown;
|
|
878
1374
|
};
|
|
879
1375
|
content: {
|
|
880
|
-
"text/plain": components["schemas"]["CheckpointDetail"];
|
|
881
1376
|
"application/json": components["schemas"]["CheckpointDetail"];
|
|
882
|
-
"text/json": components["schemas"]["CheckpointDetail"];
|
|
883
1377
|
};
|
|
884
1378
|
};
|
|
885
1379
|
};
|
|
@@ -917,9 +1411,7 @@ export interface paths {
|
|
|
917
1411
|
[name: string]: unknown;
|
|
918
1412
|
};
|
|
919
1413
|
content: {
|
|
920
|
-
"text/plain": components["schemas"]["CheckpointDetail"];
|
|
921
1414
|
"application/json": components["schemas"]["CheckpointDetail"];
|
|
922
|
-
"text/json": components["schemas"]["CheckpointDetail"];
|
|
923
1415
|
};
|
|
924
1416
|
};
|
|
925
1417
|
/** @description Not Found */
|
|
@@ -928,9 +1420,7 @@ export interface paths {
|
|
|
928
1420
|
[name: string]: unknown;
|
|
929
1421
|
};
|
|
930
1422
|
content: {
|
|
931
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
932
1423
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
933
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
934
1424
|
};
|
|
935
1425
|
};
|
|
936
1426
|
};
|
|
@@ -978,9 +1468,7 @@ export interface paths {
|
|
|
978
1468
|
[name: string]: unknown;
|
|
979
1469
|
};
|
|
980
1470
|
content: {
|
|
981
|
-
"text/plain": components["schemas"]["ReplayResponse"];
|
|
982
1471
|
"application/json": components["schemas"]["ReplayResponse"];
|
|
983
|
-
"text/json": components["schemas"]["ReplayResponse"];
|
|
984
1472
|
};
|
|
985
1473
|
};
|
|
986
1474
|
/** @description Not Found */
|
|
@@ -989,9 +1477,7 @@ export interface paths {
|
|
|
989
1477
|
[name: string]: unknown;
|
|
990
1478
|
};
|
|
991
1479
|
content: {
|
|
992
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
993
1480
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
994
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
995
1481
|
};
|
|
996
1482
|
};
|
|
997
1483
|
};
|
|
@@ -1009,38 +1495,55 @@ export interface paths {
|
|
|
1009
1495
|
path?: never;
|
|
1010
1496
|
cookie?: never;
|
|
1011
1497
|
};
|
|
1498
|
+
/**
|
|
1499
|
+
* Lists all credentials accessible to the current tenant/workspace.
|
|
1500
|
+
* @description Returns credentials the user has access to. Does not expose the encrypted values,
|
|
1501
|
+
* only metadata like name, type, scope, and status.
|
|
1502
|
+
*/
|
|
1012
1503
|
get: {
|
|
1013
1504
|
parameters: {
|
|
1014
1505
|
query?: {
|
|
1506
|
+
/** @description Optional filter by workspace. */
|
|
1015
1507
|
workspaceId?: string;
|
|
1016
1508
|
};
|
|
1017
|
-
header?:
|
|
1018
|
-
"X-Tenant-Id"?: string;
|
|
1019
|
-
};
|
|
1509
|
+
header?: never;
|
|
1020
1510
|
path?: never;
|
|
1021
1511
|
cookie?: never;
|
|
1022
1512
|
};
|
|
1023
1513
|
requestBody?: never;
|
|
1024
1514
|
responses: {
|
|
1025
|
-
/** @description
|
|
1515
|
+
/** @description Returns the list of credentials. */
|
|
1026
1516
|
200: {
|
|
1027
1517
|
headers: {
|
|
1028
1518
|
[name: string]: unknown;
|
|
1029
1519
|
};
|
|
1030
1520
|
content?: never;
|
|
1031
1521
|
};
|
|
1522
|
+
/** @description Authentication required. */
|
|
1523
|
+
401: {
|
|
1524
|
+
headers: {
|
|
1525
|
+
[name: string]: unknown;
|
|
1526
|
+
};
|
|
1527
|
+
content: {
|
|
1528
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
1529
|
+
};
|
|
1530
|
+
};
|
|
1032
1531
|
};
|
|
1033
1532
|
};
|
|
1034
1533
|
put?: never;
|
|
1534
|
+
/**
|
|
1535
|
+
* Creates a new credential.
|
|
1536
|
+
* @description Creates a new encrypted credential for storing API keys or secrets.
|
|
1537
|
+
* The credential is encrypted at rest using workspace-specific keys.
|
|
1538
|
+
*/
|
|
1035
1539
|
post: {
|
|
1036
1540
|
parameters: {
|
|
1037
1541
|
query?: never;
|
|
1038
|
-
header?:
|
|
1039
|
-
"X-Member-Id"?: string;
|
|
1040
|
-
};
|
|
1542
|
+
header?: never;
|
|
1041
1543
|
path?: never;
|
|
1042
1544
|
cookie?: never;
|
|
1043
1545
|
};
|
|
1546
|
+
/** @description The credential configuration. */
|
|
1044
1547
|
requestBody?: {
|
|
1045
1548
|
content: {
|
|
1046
1549
|
"application/json": components["schemas"]["CreateCredentialRequest"];
|
|
@@ -1049,13 +1552,31 @@ export interface paths {
|
|
|
1049
1552
|
};
|
|
1050
1553
|
};
|
|
1051
1554
|
responses: {
|
|
1052
|
-
/** @description
|
|
1053
|
-
|
|
1555
|
+
/** @description Credential created successfully. */
|
|
1556
|
+
201: {
|
|
1054
1557
|
headers: {
|
|
1055
1558
|
[name: string]: unknown;
|
|
1056
1559
|
};
|
|
1057
1560
|
content?: never;
|
|
1058
1561
|
};
|
|
1562
|
+
/** @description Invalid request (missing TypeId or WorkspaceId). */
|
|
1563
|
+
400: {
|
|
1564
|
+
headers: {
|
|
1565
|
+
[name: string]: unknown;
|
|
1566
|
+
};
|
|
1567
|
+
content: {
|
|
1568
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
1569
|
+
};
|
|
1570
|
+
};
|
|
1571
|
+
/** @description Authentication required. */
|
|
1572
|
+
401: {
|
|
1573
|
+
headers: {
|
|
1574
|
+
[name: string]: unknown;
|
|
1575
|
+
};
|
|
1576
|
+
content: {
|
|
1577
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
1578
|
+
};
|
|
1579
|
+
};
|
|
1059
1580
|
};
|
|
1060
1581
|
};
|
|
1061
1582
|
delete?: never;
|
|
@@ -1077,17 +1598,18 @@ export interface paths {
|
|
|
1077
1598
|
delete?: never;
|
|
1078
1599
|
options?: never;
|
|
1079
1600
|
head?: never;
|
|
1601
|
+
/** Updates an existing credential. */
|
|
1080
1602
|
patch: {
|
|
1081
1603
|
parameters: {
|
|
1082
1604
|
query?: never;
|
|
1083
|
-
header?:
|
|
1084
|
-
"X-Member-Id"?: string;
|
|
1085
|
-
};
|
|
1605
|
+
header?: never;
|
|
1086
1606
|
path: {
|
|
1607
|
+
/** @description The credential ID. */
|
|
1087
1608
|
id: string;
|
|
1088
1609
|
};
|
|
1089
1610
|
cookie?: never;
|
|
1090
1611
|
};
|
|
1612
|
+
/** @description The update payload. */
|
|
1091
1613
|
requestBody?: {
|
|
1092
1614
|
content: {
|
|
1093
1615
|
"application/json": components["schemas"]["UpdateCredentialRequest"];
|
|
@@ -1096,13 +1618,22 @@ export interface paths {
|
|
|
1096
1618
|
};
|
|
1097
1619
|
};
|
|
1098
1620
|
responses: {
|
|
1099
|
-
/** @description
|
|
1621
|
+
/** @description Credential updated successfully. */
|
|
1100
1622
|
200: {
|
|
1101
1623
|
headers: {
|
|
1102
1624
|
[name: string]: unknown;
|
|
1103
1625
|
};
|
|
1104
1626
|
content?: never;
|
|
1105
1627
|
};
|
|
1628
|
+
/** @description Credential not found. */
|
|
1629
|
+
404: {
|
|
1630
|
+
headers: {
|
|
1631
|
+
[name: string]: unknown;
|
|
1632
|
+
};
|
|
1633
|
+
content: {
|
|
1634
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
1635
|
+
};
|
|
1636
|
+
};
|
|
1106
1637
|
};
|
|
1107
1638
|
};
|
|
1108
1639
|
trace?: never;
|
|
@@ -1116,17 +1647,18 @@ export interface paths {
|
|
|
1116
1647
|
};
|
|
1117
1648
|
get?: never;
|
|
1118
1649
|
put?: never;
|
|
1650
|
+
/** Grants access to a credential for a workspace. */
|
|
1119
1651
|
post: {
|
|
1120
1652
|
parameters: {
|
|
1121
1653
|
query?: never;
|
|
1122
|
-
header?:
|
|
1123
|
-
"X-Member-Id"?: string;
|
|
1124
|
-
};
|
|
1654
|
+
header?: never;
|
|
1125
1655
|
path: {
|
|
1656
|
+
/** @description The credential ID. */
|
|
1126
1657
|
id: string;
|
|
1127
1658
|
};
|
|
1128
1659
|
cookie?: never;
|
|
1129
1660
|
};
|
|
1661
|
+
/** @description The grant configuration. */
|
|
1130
1662
|
requestBody?: {
|
|
1131
1663
|
content: {
|
|
1132
1664
|
"application/json": components["schemas"]["GrantAccessRequest"];
|
|
@@ -1135,13 +1667,22 @@ export interface paths {
|
|
|
1135
1667
|
};
|
|
1136
1668
|
};
|
|
1137
1669
|
responses: {
|
|
1138
|
-
/** @description
|
|
1670
|
+
/** @description Access granted successfully. */
|
|
1139
1671
|
200: {
|
|
1140
1672
|
headers: {
|
|
1141
1673
|
[name: string]: unknown;
|
|
1142
1674
|
};
|
|
1143
1675
|
content?: never;
|
|
1144
1676
|
};
|
|
1677
|
+
/** @description Credential not found. */
|
|
1678
|
+
404: {
|
|
1679
|
+
headers: {
|
|
1680
|
+
[name: string]: unknown;
|
|
1681
|
+
};
|
|
1682
|
+
content: {
|
|
1683
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
1684
|
+
};
|
|
1685
|
+
};
|
|
1145
1686
|
};
|
|
1146
1687
|
};
|
|
1147
1688
|
delete?: never;
|
|
@@ -1160,26 +1701,35 @@ export interface paths {
|
|
|
1160
1701
|
get?: never;
|
|
1161
1702
|
put?: never;
|
|
1162
1703
|
post?: never;
|
|
1704
|
+
/** Revokes access to a credential. */
|
|
1163
1705
|
delete: {
|
|
1164
1706
|
parameters: {
|
|
1165
1707
|
query?: never;
|
|
1166
|
-
header?:
|
|
1167
|
-
"X-Member-Id"?: string;
|
|
1168
|
-
};
|
|
1708
|
+
header?: never;
|
|
1169
1709
|
path: {
|
|
1710
|
+
/** @description The access grant ID to revoke. */
|
|
1170
1711
|
accessId: string;
|
|
1171
1712
|
};
|
|
1172
1713
|
cookie?: never;
|
|
1173
1714
|
};
|
|
1174
1715
|
requestBody?: never;
|
|
1175
1716
|
responses: {
|
|
1176
|
-
/** @description
|
|
1177
|
-
|
|
1717
|
+
/** @description Access revoked successfully. */
|
|
1718
|
+
204: {
|
|
1178
1719
|
headers: {
|
|
1179
1720
|
[name: string]: unknown;
|
|
1180
1721
|
};
|
|
1181
1722
|
content?: never;
|
|
1182
1723
|
};
|
|
1724
|
+
/** @description Access grant not found. */
|
|
1725
|
+
404: {
|
|
1726
|
+
headers: {
|
|
1727
|
+
[name: string]: unknown;
|
|
1728
|
+
};
|
|
1729
|
+
content: {
|
|
1730
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
1731
|
+
};
|
|
1732
|
+
};
|
|
1183
1733
|
};
|
|
1184
1734
|
};
|
|
1185
1735
|
options?: never;
|
|
@@ -1885,9 +2435,7 @@ export interface paths {
|
|
|
1885
2435
|
[name: string]: unknown;
|
|
1886
2436
|
};
|
|
1887
2437
|
content: {
|
|
1888
|
-
"text/plain": components["schemas"]["PresignedUploadResponse"];
|
|
1889
2438
|
"application/json": components["schemas"]["PresignedUploadResponse"];
|
|
1890
|
-
"text/json": components["schemas"]["PresignedUploadResponse"];
|
|
1891
2439
|
};
|
|
1892
2440
|
};
|
|
1893
2441
|
/** @description Bad Request */
|
|
@@ -1896,9 +2444,7 @@ export interface paths {
|
|
|
1896
2444
|
[name: string]: unknown;
|
|
1897
2445
|
};
|
|
1898
2446
|
content: {
|
|
1899
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
1900
2447
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
1901
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
1902
2448
|
};
|
|
1903
2449
|
};
|
|
1904
2450
|
};
|
|
@@ -1943,9 +2489,7 @@ export interface paths {
|
|
|
1943
2489
|
[name: string]: unknown;
|
|
1944
2490
|
};
|
|
1945
2491
|
content: {
|
|
1946
|
-
"text/plain": components["schemas"]["FileConfirmResponse"];
|
|
1947
2492
|
"application/json": components["schemas"]["FileConfirmResponse"];
|
|
1948
|
-
"text/json": components["schemas"]["FileConfirmResponse"];
|
|
1949
2493
|
};
|
|
1950
2494
|
};
|
|
1951
2495
|
/** @description Bad Request */
|
|
@@ -1954,9 +2498,7 @@ export interface paths {
|
|
|
1954
2498
|
[name: string]: unknown;
|
|
1955
2499
|
};
|
|
1956
2500
|
content: {
|
|
1957
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
1958
2501
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
1959
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
1960
2502
|
};
|
|
1961
2503
|
};
|
|
1962
2504
|
/** @description Not Found */
|
|
@@ -1965,9 +2507,7 @@ export interface paths {
|
|
|
1965
2507
|
[name: string]: unknown;
|
|
1966
2508
|
};
|
|
1967
2509
|
content: {
|
|
1968
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
1969
2510
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
1970
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
1971
2511
|
};
|
|
1972
2512
|
};
|
|
1973
2513
|
};
|
|
@@ -2004,9 +2544,7 @@ export interface paths {
|
|
|
2004
2544
|
[name: string]: unknown;
|
|
2005
2545
|
};
|
|
2006
2546
|
content: {
|
|
2007
|
-
"text/plain": components["schemas"]["PresignedDownloadResponse"];
|
|
2008
2547
|
"application/json": components["schemas"]["PresignedDownloadResponse"];
|
|
2009
|
-
"text/json": components["schemas"]["PresignedDownloadResponse"];
|
|
2010
2548
|
};
|
|
2011
2549
|
};
|
|
2012
2550
|
/** @description Not Found */
|
|
@@ -2015,9 +2553,7 @@ export interface paths {
|
|
|
2015
2553
|
[name: string]: unknown;
|
|
2016
2554
|
};
|
|
2017
2555
|
content: {
|
|
2018
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
2019
2556
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
2020
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
2021
2557
|
};
|
|
2022
2558
|
};
|
|
2023
2559
|
};
|
|
@@ -2059,9 +2595,7 @@ export interface paths {
|
|
|
2059
2595
|
[name: string]: unknown;
|
|
2060
2596
|
};
|
|
2061
2597
|
content: {
|
|
2062
|
-
"text/plain": components["schemas"]["FileListItem"][];
|
|
2063
2598
|
"application/json": components["schemas"]["FileListItem"][];
|
|
2064
|
-
"text/json": components["schemas"]["FileListItem"][];
|
|
2065
2599
|
};
|
|
2066
2600
|
};
|
|
2067
2601
|
};
|
|
@@ -2100,9 +2634,7 @@ export interface paths {
|
|
|
2100
2634
|
[name: string]: unknown;
|
|
2101
2635
|
};
|
|
2102
2636
|
content: {
|
|
2103
|
-
"text/plain": components["schemas"]["FileDetail"];
|
|
2104
2637
|
"application/json": components["schemas"]["FileDetail"];
|
|
2105
|
-
"text/json": components["schemas"]["FileDetail"];
|
|
2106
2638
|
};
|
|
2107
2639
|
};
|
|
2108
2640
|
/** @description Not Found */
|
|
@@ -2111,9 +2643,7 @@ export interface paths {
|
|
|
2111
2643
|
[name: string]: unknown;
|
|
2112
2644
|
};
|
|
2113
2645
|
content: {
|
|
2114
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
2115
2646
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
2116
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
2117
2647
|
};
|
|
2118
2648
|
};
|
|
2119
2649
|
};
|
|
@@ -2146,9 +2676,7 @@ export interface paths {
|
|
|
2146
2676
|
[name: string]: unknown;
|
|
2147
2677
|
};
|
|
2148
2678
|
content: {
|
|
2149
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
2150
2679
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
2151
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
2152
2680
|
};
|
|
2153
2681
|
};
|
|
2154
2682
|
};
|
|
@@ -3350,7 +3878,16 @@ export interface paths {
|
|
|
3350
3878
|
path?: never;
|
|
3351
3879
|
cookie?: never;
|
|
3352
3880
|
};
|
|
3353
|
-
/**
|
|
3881
|
+
/**
|
|
3882
|
+
* Lists runs with optional filtering and pagination.
|
|
3883
|
+
* @description Returns a paginated list of runs with filtering options. Results are ordered
|
|
3884
|
+
* by creation date (newest first).
|
|
3885
|
+
*
|
|
3886
|
+
* **Filtering:**
|
|
3887
|
+
* - `agentId`: Show only runs for a specific agent
|
|
3888
|
+
* - `threadId`: Show only runs in a specific thread
|
|
3889
|
+
* - `status`: Filter by status (queued, running, completed, failed, canceled)
|
|
3890
|
+
*/
|
|
3354
3891
|
get: {
|
|
3355
3892
|
parameters: {
|
|
3356
3893
|
query?: {
|
|
@@ -3358,11 +3895,11 @@ export interface paths {
|
|
|
3358
3895
|
agentId?: string;
|
|
3359
3896
|
/** @description Optional filter by thread ID. */
|
|
3360
3897
|
threadId?: string;
|
|
3361
|
-
/** @description Optional filter by status. */
|
|
3898
|
+
/** @description Optional filter by status (queued, running, completed, failed, canceled). */
|
|
3362
3899
|
status?: string;
|
|
3363
|
-
/** @description Max results to return
|
|
3900
|
+
/** @description Max results to return. Default: 20, Max: 100. */
|
|
3364
3901
|
limit?: number;
|
|
3365
|
-
/** @description
|
|
3902
|
+
/** @description Number of records to skip for pagination. */
|
|
3366
3903
|
offset?: number;
|
|
3367
3904
|
};
|
|
3368
3905
|
header?: never;
|
|
@@ -3371,24 +3908,47 @@ export interface paths {
|
|
|
3371
3908
|
};
|
|
3372
3909
|
requestBody?: never;
|
|
3373
3910
|
responses: {
|
|
3374
|
-
/** @description
|
|
3911
|
+
/** @description Returns the list of runs. */
|
|
3375
3912
|
200: {
|
|
3376
3913
|
headers: {
|
|
3377
3914
|
[name: string]: unknown;
|
|
3378
3915
|
};
|
|
3379
3916
|
content: {
|
|
3380
|
-
"text/plain": components["schemas"]["RunListResponse"];
|
|
3381
3917
|
"application/json": components["schemas"]["RunListResponse"];
|
|
3382
|
-
|
|
3918
|
+
};
|
|
3919
|
+
};
|
|
3920
|
+
/** @description Authentication required. */
|
|
3921
|
+
401: {
|
|
3922
|
+
headers: {
|
|
3923
|
+
[name: string]: unknown;
|
|
3924
|
+
};
|
|
3925
|
+
content: {
|
|
3926
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
3383
3927
|
};
|
|
3384
3928
|
};
|
|
3385
3929
|
};
|
|
3386
3930
|
};
|
|
3387
3931
|
put?: never;
|
|
3388
3932
|
/**
|
|
3389
|
-
* Starts a new agent run.
|
|
3390
|
-
* @description
|
|
3391
|
-
*
|
|
3933
|
+
* Starts a new agent run asynchronously.
|
|
3934
|
+
* @description Creates a new run and queues it for execution. The run will be processed
|
|
3935
|
+
* by the data plane and its status can be monitored via polling or SSE.
|
|
3936
|
+
*
|
|
3937
|
+
* **Thread Resolution:**
|
|
3938
|
+
* - If `thread.id` is provided, uses existing thread
|
|
3939
|
+
* - If `thread` is omitted, creates a new thread automatically
|
|
3940
|
+
*
|
|
3941
|
+
* **Idempotency:**
|
|
3942
|
+
* Provide `Idempotency-Key` header to prevent duplicate runs.
|
|
3943
|
+
* If a run with the same key exists and is still valid, returns 200 instead of 201.
|
|
3944
|
+
*
|
|
3945
|
+
* **Example Request:**
|
|
3946
|
+
* ```json
|
|
3947
|
+
* {
|
|
3948
|
+
* "agent_id": "...",
|
|
3949
|
+
* "input": { "messages": [{ "role": "user", "content": "Hello" }] }
|
|
3950
|
+
* }
|
|
3951
|
+
* ```
|
|
3392
3952
|
*/
|
|
3393
3953
|
post: {
|
|
3394
3954
|
parameters: {
|
|
@@ -3397,7 +3957,7 @@ export interface paths {
|
|
|
3397
3957
|
path?: never;
|
|
3398
3958
|
cookie?: never;
|
|
3399
3959
|
};
|
|
3400
|
-
/** @description The run request
|
|
3960
|
+
/** @description The run request with agent ID and input. */
|
|
3401
3961
|
requestBody?: {
|
|
3402
3962
|
content: {
|
|
3403
3963
|
"application/json": components["schemas"]["CreateRunRequest"];
|
|
@@ -3406,26 +3966,40 @@ export interface paths {
|
|
|
3406
3966
|
};
|
|
3407
3967
|
};
|
|
3408
3968
|
responses: {
|
|
3409
|
-
/** @description
|
|
3969
|
+
/** @description Existing run returned (idempotent request). */
|
|
3970
|
+
200: {
|
|
3971
|
+
headers: {
|
|
3972
|
+
[name: string]: unknown;
|
|
3973
|
+
};
|
|
3974
|
+
content: {
|
|
3975
|
+
"application/json": components["schemas"]["RunResponse"];
|
|
3976
|
+
};
|
|
3977
|
+
};
|
|
3978
|
+
/** @description Run created and queued successfully. */
|
|
3410
3979
|
201: {
|
|
3411
3980
|
headers: {
|
|
3412
3981
|
[name: string]: unknown;
|
|
3413
3982
|
};
|
|
3414
3983
|
content: {
|
|
3415
|
-
"text/plain": components["schemas"]["RunResponse"];
|
|
3416
3984
|
"application/json": components["schemas"]["RunResponse"];
|
|
3417
|
-
"text/json": components["schemas"]["RunResponse"];
|
|
3418
3985
|
};
|
|
3419
3986
|
};
|
|
3420
|
-
/** @description
|
|
3987
|
+
/** @description Invalid request (missing agent, invalid input). */
|
|
3421
3988
|
400: {
|
|
3422
3989
|
headers: {
|
|
3423
3990
|
[name: string]: unknown;
|
|
3424
3991
|
};
|
|
3425
3992
|
content: {
|
|
3426
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
3427
3993
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
3428
|
-
|
|
3994
|
+
};
|
|
3995
|
+
};
|
|
3996
|
+
/** @description Authentication required. */
|
|
3997
|
+
401: {
|
|
3998
|
+
headers: {
|
|
3999
|
+
[name: string]: unknown;
|
|
4000
|
+
};
|
|
4001
|
+
content: {
|
|
4002
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
3429
4003
|
};
|
|
3430
4004
|
};
|
|
3431
4005
|
};
|
|
@@ -3462,9 +4036,7 @@ export interface paths {
|
|
|
3462
4036
|
[name: string]: unknown;
|
|
3463
4037
|
};
|
|
3464
4038
|
content: {
|
|
3465
|
-
"text/plain": components["schemas"]["RunDetailResponse"];
|
|
3466
4039
|
"application/json": components["schemas"]["RunDetailResponse"];
|
|
3467
|
-
"text/json": components["schemas"]["RunDetailResponse"];
|
|
3468
4040
|
};
|
|
3469
4041
|
};
|
|
3470
4042
|
/** @description Not Found */
|
|
@@ -3473,9 +4045,7 @@ export interface paths {
|
|
|
3473
4045
|
[name: string]: unknown;
|
|
3474
4046
|
};
|
|
3475
4047
|
content: {
|
|
3476
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
3477
4048
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
3478
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
3479
4049
|
};
|
|
3480
4050
|
};
|
|
3481
4051
|
};
|
|
@@ -3522,9 +4092,7 @@ export interface paths {
|
|
|
3522
4092
|
[name: string]: unknown;
|
|
3523
4093
|
};
|
|
3524
4094
|
content: {
|
|
3525
|
-
"text/plain": components["schemas"]["RunEventsResponse"];
|
|
3526
4095
|
"application/json": components["schemas"]["RunEventsResponse"];
|
|
3527
|
-
"text/json": components["schemas"]["RunEventsResponse"];
|
|
3528
4096
|
};
|
|
3529
4097
|
};
|
|
3530
4098
|
/** @description Not Found */
|
|
@@ -3533,9 +4101,68 @@ export interface paths {
|
|
|
3533
4101
|
[name: string]: unknown;
|
|
3534
4102
|
};
|
|
3535
4103
|
content: {
|
|
3536
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
3537
4104
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
3538
|
-
|
|
4105
|
+
};
|
|
4106
|
+
};
|
|
4107
|
+
};
|
|
4108
|
+
};
|
|
4109
|
+
put?: never;
|
|
4110
|
+
post?: never;
|
|
4111
|
+
delete?: never;
|
|
4112
|
+
options?: never;
|
|
4113
|
+
head?: never;
|
|
4114
|
+
patch?: never;
|
|
4115
|
+
trace?: never;
|
|
4116
|
+
};
|
|
4117
|
+
"/v1/api/runs/{runId}/events/stream": {
|
|
4118
|
+
parameters: {
|
|
4119
|
+
query?: never;
|
|
4120
|
+
header?: never;
|
|
4121
|
+
path?: never;
|
|
4122
|
+
cookie?: never;
|
|
4123
|
+
};
|
|
4124
|
+
/**
|
|
4125
|
+
* Wave 1.0: Get run events for polling-based replay.
|
|
4126
|
+
* Returns events after a specific sequence number for incremental polling.
|
|
4127
|
+
* @description This is the recommended endpoint for SDK/UI event consumption.
|
|
4128
|
+
* Events are ordered by sequence number (ascending) and limited to prevent
|
|
4129
|
+
* large responses. Use `next_after_seq` for pagination.
|
|
4130
|
+
*
|
|
4131
|
+
* **Security:** Only returns events for runs in the caller's workspace.
|
|
4132
|
+
*/
|
|
4133
|
+
get: {
|
|
4134
|
+
parameters: {
|
|
4135
|
+
query?: {
|
|
4136
|
+
/** @description Return events with seq greater than this value (default: 0 = all). */
|
|
4137
|
+
afterSeq?: number;
|
|
4138
|
+
/** @description Max events to return (default: 100, max: 500). */
|
|
4139
|
+
limit?: number;
|
|
4140
|
+
};
|
|
4141
|
+
header?: never;
|
|
4142
|
+
path: {
|
|
4143
|
+
/** @description The unique ID of the run. */
|
|
4144
|
+
runId: string;
|
|
4145
|
+
};
|
|
4146
|
+
cookie?: never;
|
|
4147
|
+
};
|
|
4148
|
+
requestBody?: never;
|
|
4149
|
+
responses: {
|
|
4150
|
+
/** @description OK */
|
|
4151
|
+
200: {
|
|
4152
|
+
headers: {
|
|
4153
|
+
[name: string]: unknown;
|
|
4154
|
+
};
|
|
4155
|
+
content: {
|
|
4156
|
+
"application/json": components["schemas"]["RunEventsPollResponse"];
|
|
4157
|
+
};
|
|
4158
|
+
};
|
|
4159
|
+
/** @description Not Found */
|
|
4160
|
+
404: {
|
|
4161
|
+
headers: {
|
|
4162
|
+
[name: string]: unknown;
|
|
4163
|
+
};
|
|
4164
|
+
content: {
|
|
4165
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
3539
4166
|
};
|
|
3540
4167
|
};
|
|
3541
4168
|
};
|
|
@@ -3580,9 +4207,7 @@ export interface paths {
|
|
|
3580
4207
|
[name: string]: unknown;
|
|
3581
4208
|
};
|
|
3582
4209
|
content: {
|
|
3583
|
-
"text/plain": components["schemas"]["WaitRunResponse"];
|
|
3584
4210
|
"application/json": components["schemas"]["WaitRunResponse"];
|
|
3585
|
-
"text/json": components["schemas"]["WaitRunResponse"];
|
|
3586
4211
|
};
|
|
3587
4212
|
};
|
|
3588
4213
|
/** @description Bad Request */
|
|
@@ -3591,9 +4216,7 @@ export interface paths {
|
|
|
3591
4216
|
[name: string]: unknown;
|
|
3592
4217
|
};
|
|
3593
4218
|
content: {
|
|
3594
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
3595
4219
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
3596
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
3597
4220
|
};
|
|
3598
4221
|
};
|
|
3599
4222
|
/** @description Request Timeout */
|
|
@@ -3602,9 +4225,7 @@ export interface paths {
|
|
|
3602
4225
|
[name: string]: unknown;
|
|
3603
4226
|
};
|
|
3604
4227
|
content: {
|
|
3605
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
3606
4228
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
3607
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
3608
4229
|
};
|
|
3609
4230
|
};
|
|
3610
4231
|
};
|
|
@@ -3647,9 +4268,7 @@ export interface paths {
|
|
|
3647
4268
|
[name: string]: unknown;
|
|
3648
4269
|
};
|
|
3649
4270
|
content: {
|
|
3650
|
-
"text/plain": components["schemas"]["BatchRunResponse"];
|
|
3651
4271
|
"application/json": components["schemas"]["BatchRunResponse"];
|
|
3652
|
-
"text/json": components["schemas"]["BatchRunResponse"];
|
|
3653
4272
|
};
|
|
3654
4273
|
};
|
|
3655
4274
|
/** @description Bad Request */
|
|
@@ -3658,9 +4277,7 @@ export interface paths {
|
|
|
3658
4277
|
[name: string]: unknown;
|
|
3659
4278
|
};
|
|
3660
4279
|
content: {
|
|
3661
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
3662
4280
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
3663
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
3664
4281
|
};
|
|
3665
4282
|
};
|
|
3666
4283
|
};
|
|
@@ -3717,7 +4334,29 @@ export interface paths {
|
|
|
3717
4334
|
};
|
|
3718
4335
|
get?: never;
|
|
3719
4336
|
put?: never;
|
|
3720
|
-
/**
|
|
4337
|
+
/**
|
|
4338
|
+
* Creates a run and streams real-time updates via Server-Sent Events (SSE).
|
|
4339
|
+
* @description This is the recommended endpoint for interactive applications. It creates
|
|
4340
|
+
* a run and maintains an open SSE connection to stream events in real-time.
|
|
4341
|
+
*
|
|
4342
|
+
* **SSE Events:**
|
|
4343
|
+
* - `start`: Run created and queued
|
|
4344
|
+
* - `update`: Run status changed
|
|
4345
|
+
* - `complete`: Run finished successfully (includes output)
|
|
4346
|
+
* - `error`: Run failed or was canceled (includes error details)
|
|
4347
|
+
*
|
|
4348
|
+
* **Example Event Stream:**
|
|
4349
|
+
* ```
|
|
4350
|
+
* event: start
|
|
4351
|
+
* data: {"run_id": "...", "status": "queued"}
|
|
4352
|
+
*
|
|
4353
|
+
* event: update
|
|
4354
|
+
* data: {"run_id": "...", "status": "running"}
|
|
4355
|
+
*
|
|
4356
|
+
* event: complete
|
|
4357
|
+
* data: {"run_id": "...", "status": "completed", "output": {...}}
|
|
4358
|
+
* ```
|
|
4359
|
+
*/
|
|
3721
4360
|
post: {
|
|
3722
4361
|
parameters: {
|
|
3723
4362
|
query?: never;
|
|
@@ -3725,7 +4364,7 @@ export interface paths {
|
|
|
3725
4364
|
path?: never;
|
|
3726
4365
|
cookie?: never;
|
|
3727
4366
|
};
|
|
3728
|
-
/** @description The
|
|
4367
|
+
/** @description The run request with agent ID and input. */
|
|
3729
4368
|
requestBody?: {
|
|
3730
4369
|
content: {
|
|
3731
4370
|
"application/json": components["schemas"]["StreamRunRequest"];
|
|
@@ -3784,9 +4423,7 @@ export interface paths {
|
|
|
3784
4423
|
[name: string]: unknown;
|
|
3785
4424
|
};
|
|
3786
4425
|
content: {
|
|
3787
|
-
"text/plain": components["schemas"]["RerunResponse"];
|
|
3788
4426
|
"application/json": components["schemas"]["RerunResponse"];
|
|
3789
|
-
"text/json": components["schemas"]["RerunResponse"];
|
|
3790
4427
|
};
|
|
3791
4428
|
};
|
|
3792
4429
|
/** @description Not Found */
|
|
@@ -3795,9 +4432,7 @@ export interface paths {
|
|
|
3795
4432
|
[name: string]: unknown;
|
|
3796
4433
|
};
|
|
3797
4434
|
content: {
|
|
3798
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
3799
4435
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
3800
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
3801
4436
|
};
|
|
3802
4437
|
};
|
|
3803
4438
|
};
|
|
@@ -3842,9 +4477,7 @@ export interface paths {
|
|
|
3842
4477
|
[name: string]: unknown;
|
|
3843
4478
|
};
|
|
3844
4479
|
content: {
|
|
3845
|
-
"text/plain": components["schemas"]["ReplayResponse"];
|
|
3846
4480
|
"application/json": components["schemas"]["ReplayResponse"];
|
|
3847
|
-
"text/json": components["schemas"]["ReplayResponse"];
|
|
3848
4481
|
};
|
|
3849
4482
|
};
|
|
3850
4483
|
/** @description Not Found */
|
|
@@ -3853,9 +4486,7 @@ export interface paths {
|
|
|
3853
4486
|
[name: string]: unknown;
|
|
3854
4487
|
};
|
|
3855
4488
|
content: {
|
|
3856
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
3857
4489
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
3858
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
3859
4490
|
};
|
|
3860
4491
|
};
|
|
3861
4492
|
};
|
|
@@ -3891,9 +4522,7 @@ export interface paths {
|
|
|
3891
4522
|
[name: string]: unknown;
|
|
3892
4523
|
};
|
|
3893
4524
|
content: {
|
|
3894
|
-
"text/plain": components["schemas"]["CheckpointIndexResponse"];
|
|
3895
4525
|
"application/json": components["schemas"]["CheckpointIndexResponse"];
|
|
3896
|
-
"text/json": components["schemas"]["CheckpointIndexResponse"];
|
|
3897
4526
|
};
|
|
3898
4527
|
};
|
|
3899
4528
|
/** @description Not Found */
|
|
@@ -3902,9 +4531,7 @@ export interface paths {
|
|
|
3902
4531
|
[name: string]: unknown;
|
|
3903
4532
|
};
|
|
3904
4533
|
content: {
|
|
3905
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
3906
4534
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
3907
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
3908
4535
|
};
|
|
3909
4536
|
};
|
|
3910
4537
|
};
|
|
@@ -3950,9 +4577,7 @@ export interface paths {
|
|
|
3950
4577
|
[name: string]: unknown;
|
|
3951
4578
|
};
|
|
3952
4579
|
content: {
|
|
3953
|
-
"text/plain": components["schemas"]["ResumeResponse"];
|
|
3954
4580
|
"application/json": components["schemas"]["ResumeResponse"];
|
|
3955
|
-
"text/json": components["schemas"]["ResumeResponse"];
|
|
3956
4581
|
};
|
|
3957
4582
|
};
|
|
3958
4583
|
/** @description Bad Request */
|
|
@@ -3961,9 +4586,7 @@ export interface paths {
|
|
|
3961
4586
|
[name: string]: unknown;
|
|
3962
4587
|
};
|
|
3963
4588
|
content: {
|
|
3964
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
3965
4589
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
3966
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
3967
4590
|
};
|
|
3968
4591
|
};
|
|
3969
4592
|
/** @description Not Found */
|
|
@@ -3972,9 +4595,7 @@ export interface paths {
|
|
|
3972
4595
|
[name: string]: unknown;
|
|
3973
4596
|
};
|
|
3974
4597
|
content: {
|
|
3975
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
3976
4598
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
3977
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
3978
4599
|
};
|
|
3979
4600
|
};
|
|
3980
4601
|
};
|
|
@@ -4018,9 +4639,7 @@ export interface paths {
|
|
|
4018
4639
|
[name: string]: unknown;
|
|
4019
4640
|
};
|
|
4020
4641
|
content: {
|
|
4021
|
-
"text/plain": components["schemas"]["CancelRunResponse"];
|
|
4022
4642
|
"application/json": components["schemas"]["CancelRunResponse"];
|
|
4023
|
-
"text/json": components["schemas"]["CancelRunResponse"];
|
|
4024
4643
|
};
|
|
4025
4644
|
};
|
|
4026
4645
|
/** @description Not Found */
|
|
@@ -4029,9 +4648,7 @@ export interface paths {
|
|
|
4029
4648
|
[name: string]: unknown;
|
|
4030
4649
|
};
|
|
4031
4650
|
content: {
|
|
4032
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
4033
4651
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
4034
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
4035
4652
|
};
|
|
4036
4653
|
};
|
|
4037
4654
|
};
|
|
@@ -4369,7 +4986,19 @@ export interface paths {
|
|
|
4369
4986
|
};
|
|
4370
4987
|
};
|
|
4371
4988
|
put?: never;
|
|
4372
|
-
/**
|
|
4989
|
+
/**
|
|
4990
|
+
* Creates a new conversation thread.
|
|
4991
|
+
* @description Creates an empty thread that can be used for agent runs. Threads persist
|
|
4992
|
+
* conversation state between multiple runs.
|
|
4993
|
+
*
|
|
4994
|
+
* **Example Request:**
|
|
4995
|
+
* ```json
|
|
4996
|
+
* {
|
|
4997
|
+
* "channel": "http",
|
|
4998
|
+
* "metadata": { "user_id": "abc123" }
|
|
4999
|
+
* }
|
|
5000
|
+
* ```
|
|
5001
|
+
*/
|
|
4373
5002
|
post: {
|
|
4374
5003
|
parameters: {
|
|
4375
5004
|
query?: never;
|
|
@@ -4377,6 +5006,7 @@ export interface paths {
|
|
|
4377
5006
|
path?: never;
|
|
4378
5007
|
cookie?: never;
|
|
4379
5008
|
};
|
|
5009
|
+
/** @description Thread creation options including channel and metadata. */
|
|
4380
5010
|
requestBody?: {
|
|
4381
5011
|
content: {
|
|
4382
5012
|
"application/json": components["schemas"]["CreateThreadRequest"];
|
|
@@ -4385,13 +5015,22 @@ export interface paths {
|
|
|
4385
5015
|
};
|
|
4386
5016
|
};
|
|
4387
5017
|
responses: {
|
|
4388
|
-
/** @description
|
|
4389
|
-
|
|
5018
|
+
/** @description Thread created successfully. */
|
|
5019
|
+
201: {
|
|
4390
5020
|
headers: {
|
|
4391
5021
|
[name: string]: unknown;
|
|
4392
5022
|
};
|
|
4393
5023
|
content?: never;
|
|
4394
5024
|
};
|
|
5025
|
+
/** @description Authentication required. */
|
|
5026
|
+
401: {
|
|
5027
|
+
headers: {
|
|
5028
|
+
[name: string]: unknown;
|
|
5029
|
+
};
|
|
5030
|
+
content: {
|
|
5031
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
5032
|
+
};
|
|
5033
|
+
};
|
|
4395
5034
|
};
|
|
4396
5035
|
};
|
|
4397
5036
|
delete?: never;
|
|
@@ -4407,25 +5046,39 @@ export interface paths {
|
|
|
4407
5046
|
path?: never;
|
|
4408
5047
|
cookie?: never;
|
|
4409
5048
|
};
|
|
4410
|
-
/**
|
|
5049
|
+
/**
|
|
5050
|
+
* Retrieves a thread by its unique identifier.
|
|
5051
|
+
* @description Returns the thread details including channel, external ID, and metadata.
|
|
5052
|
+
* Access is restricted to threads within your tenant (IDOR protected).
|
|
5053
|
+
*/
|
|
4411
5054
|
get: {
|
|
4412
5055
|
parameters: {
|
|
4413
5056
|
query?: never;
|
|
4414
5057
|
header?: never;
|
|
4415
5058
|
path: {
|
|
5059
|
+
/** @description The unique identifier of the thread. */
|
|
4416
5060
|
id: string;
|
|
4417
5061
|
};
|
|
4418
5062
|
cookie?: never;
|
|
4419
5063
|
};
|
|
4420
5064
|
requestBody?: never;
|
|
4421
5065
|
responses: {
|
|
4422
|
-
/** @description
|
|
5066
|
+
/** @description Returns the thread. */
|
|
4423
5067
|
200: {
|
|
4424
5068
|
headers: {
|
|
4425
5069
|
[name: string]: unknown;
|
|
4426
5070
|
};
|
|
4427
5071
|
content?: never;
|
|
4428
5072
|
};
|
|
5073
|
+
/** @description Thread not found. */
|
|
5074
|
+
404: {
|
|
5075
|
+
headers: {
|
|
5076
|
+
[name: string]: unknown;
|
|
5077
|
+
};
|
|
5078
|
+
content: {
|
|
5079
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
5080
|
+
};
|
|
5081
|
+
};
|
|
4429
5082
|
};
|
|
4430
5083
|
};
|
|
4431
5084
|
put?: never;
|
|
@@ -4464,27 +5117,43 @@ export interface paths {
|
|
|
4464
5117
|
cookie?: never;
|
|
4465
5118
|
};
|
|
4466
5119
|
/**
|
|
4467
|
-
*
|
|
4468
|
-
*
|
|
5120
|
+
* Gets a comprehensive state summary for a thread.
|
|
5121
|
+
* @description Returns aggregated information about the thread including:
|
|
5122
|
+
* - Run count and status of the last run
|
|
5123
|
+
* - Last checkpoint information
|
|
5124
|
+
* - Message count
|
|
5125
|
+
* - Pointers to related endpoints (runs, messages, history)
|
|
5126
|
+
*
|
|
5127
|
+
* This is the recommended endpoint for building thread detail UIs.
|
|
4469
5128
|
*/
|
|
4470
5129
|
get: {
|
|
4471
5130
|
parameters: {
|
|
4472
5131
|
query?: never;
|
|
4473
5132
|
header?: never;
|
|
4474
5133
|
path: {
|
|
5134
|
+
/** @description The unique identifier of the thread. */
|
|
4475
5135
|
id: string;
|
|
4476
5136
|
};
|
|
4477
5137
|
cookie?: never;
|
|
4478
5138
|
};
|
|
4479
5139
|
requestBody?: never;
|
|
4480
5140
|
responses: {
|
|
4481
|
-
/** @description
|
|
5141
|
+
/** @description Returns the thread state summary. */
|
|
4482
5142
|
200: {
|
|
4483
5143
|
headers: {
|
|
4484
5144
|
[name: string]: unknown;
|
|
4485
5145
|
};
|
|
4486
5146
|
content?: never;
|
|
4487
5147
|
};
|
|
5148
|
+
/** @description Thread not found. */
|
|
5149
|
+
404: {
|
|
5150
|
+
headers: {
|
|
5151
|
+
[name: string]: unknown;
|
|
5152
|
+
};
|
|
5153
|
+
content: {
|
|
5154
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
5155
|
+
};
|
|
5156
|
+
};
|
|
4488
5157
|
};
|
|
4489
5158
|
};
|
|
4490
5159
|
put?: never;
|
|
@@ -5616,24 +6285,33 @@ export interface paths {
|
|
|
5616
6285
|
[name: string]: unknown;
|
|
5617
6286
|
};
|
|
5618
6287
|
content: {
|
|
5619
|
-
"text/plain": components["schemas"]["VectorStoreResponse"][];
|
|
5620
6288
|
"application/json": components["schemas"]["VectorStoreResponse"][];
|
|
5621
|
-
"text/json": components["schemas"]["VectorStoreResponse"][];
|
|
5622
6289
|
};
|
|
5623
6290
|
};
|
|
5624
6291
|
};
|
|
5625
6292
|
};
|
|
5626
6293
|
put?: never;
|
|
5627
|
-
/**
|
|
6294
|
+
/**
|
|
6295
|
+
* Creates a new vector store for semantic document search.
|
|
6296
|
+
* @description Creates a vector store with the specified embedding configuration.
|
|
6297
|
+
* The store is ready to accept file attachments immediately after creation.
|
|
6298
|
+
*
|
|
6299
|
+
* **Default Configuration:**
|
|
6300
|
+
* - Provider: `openai`
|
|
6301
|
+
* - Model: `text-embedding-3-small`
|
|
6302
|
+
* - Dimension: `1536`
|
|
6303
|
+
*/
|
|
5628
6304
|
post: {
|
|
5629
6305
|
parameters: {
|
|
5630
6306
|
query?: never;
|
|
5631
6307
|
header?: never;
|
|
5632
6308
|
path: {
|
|
6309
|
+
/** @description The workspace to create the vector store in. */
|
|
5633
6310
|
workspaceId: string;
|
|
5634
6311
|
};
|
|
5635
6312
|
cookie?: never;
|
|
5636
6313
|
};
|
|
6314
|
+
/** @description Vector store configuration. */
|
|
5637
6315
|
requestBody?: {
|
|
5638
6316
|
content: {
|
|
5639
6317
|
"application/json": components["schemas"]["CreateVectorStoreRequest"];
|
|
@@ -5642,15 +6320,22 @@ export interface paths {
|
|
|
5642
6320
|
};
|
|
5643
6321
|
};
|
|
5644
6322
|
responses: {
|
|
5645
|
-
/** @description
|
|
6323
|
+
/** @description Vector store created successfully. */
|
|
5646
6324
|
201: {
|
|
5647
6325
|
headers: {
|
|
5648
6326
|
[name: string]: unknown;
|
|
5649
6327
|
};
|
|
5650
6328
|
content: {
|
|
5651
|
-
"text/plain": components["schemas"]["VectorStoreResponse"];
|
|
5652
6329
|
"application/json": components["schemas"]["VectorStoreResponse"];
|
|
5653
|
-
|
|
6330
|
+
};
|
|
6331
|
+
};
|
|
6332
|
+
/** @description Workspace not found. */
|
|
6333
|
+
404: {
|
|
6334
|
+
headers: {
|
|
6335
|
+
[name: string]: unknown;
|
|
6336
|
+
};
|
|
6337
|
+
content: {
|
|
6338
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
5654
6339
|
};
|
|
5655
6340
|
};
|
|
5656
6341
|
};
|
|
@@ -5687,9 +6372,7 @@ export interface paths {
|
|
|
5687
6372
|
[name: string]: unknown;
|
|
5688
6373
|
};
|
|
5689
6374
|
content: {
|
|
5690
|
-
"text/plain": components["schemas"]["VectorStoreResponse"];
|
|
5691
6375
|
"application/json": components["schemas"]["VectorStoreResponse"];
|
|
5692
|
-
"text/json": components["schemas"]["VectorStoreResponse"];
|
|
5693
6376
|
};
|
|
5694
6377
|
};
|
|
5695
6378
|
/** @description Not Found */
|
|
@@ -5698,9 +6381,7 @@ export interface paths {
|
|
|
5698
6381
|
[name: string]: unknown;
|
|
5699
6382
|
};
|
|
5700
6383
|
content: {
|
|
5701
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
5702
6384
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
5703
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
5704
6385
|
};
|
|
5705
6386
|
};
|
|
5706
6387
|
};
|
|
@@ -5733,9 +6414,7 @@ export interface paths {
|
|
|
5733
6414
|
[name: string]: unknown;
|
|
5734
6415
|
};
|
|
5735
6416
|
content: {
|
|
5736
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
5737
6417
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
5738
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
5739
6418
|
};
|
|
5740
6419
|
};
|
|
5741
6420
|
};
|
|
@@ -5779,9 +6458,7 @@ export interface paths {
|
|
|
5779
6458
|
[name: string]: unknown;
|
|
5780
6459
|
};
|
|
5781
6460
|
content: {
|
|
5782
|
-
"text/plain": components["schemas"]["VectorStoreFileResponse"];
|
|
5783
6461
|
"application/json": components["schemas"]["VectorStoreFileResponse"];
|
|
5784
|
-
"text/json": components["schemas"]["VectorStoreFileResponse"];
|
|
5785
6462
|
};
|
|
5786
6463
|
};
|
|
5787
6464
|
/** @description Not Found */
|
|
@@ -5790,9 +6467,7 @@ export interface paths {
|
|
|
5790
6467
|
[name: string]: unknown;
|
|
5791
6468
|
};
|
|
5792
6469
|
content: {
|
|
5793
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
5794
6470
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
5795
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
5796
6471
|
};
|
|
5797
6472
|
};
|
|
5798
6473
|
};
|
|
@@ -5812,17 +6487,36 @@ export interface paths {
|
|
|
5812
6487
|
};
|
|
5813
6488
|
get?: never;
|
|
5814
6489
|
put?: never;
|
|
5815
|
-
/**
|
|
6490
|
+
/**
|
|
6491
|
+
* Performs semantic similarity search against the vector store.
|
|
6492
|
+
* @description Executes a cosine similarity search to find document chunks most relevant
|
|
6493
|
+
* to the query. Results are ranked by similarity score.
|
|
6494
|
+
*
|
|
6495
|
+
* **Note:** The query is automatically embedded using the store's configured
|
|
6496
|
+
* embedding provider before search.
|
|
6497
|
+
*
|
|
6498
|
+
* **Example Request:**
|
|
6499
|
+
* ```json
|
|
6500
|
+
* {
|
|
6501
|
+
* "query": "How do I configure authentication?",
|
|
6502
|
+
* "top_k": 5,
|
|
6503
|
+
* "min_score": 0.7
|
|
6504
|
+
* }
|
|
6505
|
+
* ```
|
|
6506
|
+
*/
|
|
5816
6507
|
post: {
|
|
5817
6508
|
parameters: {
|
|
5818
6509
|
query?: never;
|
|
5819
6510
|
header?: never;
|
|
5820
6511
|
path: {
|
|
6512
|
+
/** @description The workspace containing the vector store. */
|
|
5821
6513
|
workspaceId: string;
|
|
6514
|
+
/** @description The vector store to query. */
|
|
5822
6515
|
vectorStoreId: string;
|
|
5823
6516
|
};
|
|
5824
6517
|
cookie?: never;
|
|
5825
6518
|
};
|
|
6519
|
+
/** @description Query parameters including text and result limits. */
|
|
5826
6520
|
requestBody?: {
|
|
5827
6521
|
content: {
|
|
5828
6522
|
"application/json": components["schemas"]["VectorQueryRequest"];
|
|
@@ -5831,26 +6525,22 @@ export interface paths {
|
|
|
5831
6525
|
};
|
|
5832
6526
|
};
|
|
5833
6527
|
responses: {
|
|
5834
|
-
/** @description
|
|
6528
|
+
/** @description Returns matching results. */
|
|
5835
6529
|
200: {
|
|
5836
6530
|
headers: {
|
|
5837
6531
|
[name: string]: unknown;
|
|
5838
6532
|
};
|
|
5839
6533
|
content: {
|
|
5840
|
-
"text/plain": components["schemas"]["VectorQueryResponse"];
|
|
5841
6534
|
"application/json": components["schemas"]["VectorQueryResponse"];
|
|
5842
|
-
"text/json": components["schemas"]["VectorQueryResponse"];
|
|
5843
6535
|
};
|
|
5844
6536
|
};
|
|
5845
|
-
/** @description
|
|
6537
|
+
/** @description Vector store not found. */
|
|
5846
6538
|
404: {
|
|
5847
6539
|
headers: {
|
|
5848
6540
|
[name: string]: unknown;
|
|
5849
6541
|
};
|
|
5850
6542
|
content: {
|
|
5851
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
5852
6543
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
5853
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
5854
6544
|
};
|
|
5855
6545
|
};
|
|
5856
6546
|
};
|
|
@@ -5902,9 +6592,7 @@ export interface paths {
|
|
|
5902
6592
|
[name: string]: unknown;
|
|
5903
6593
|
};
|
|
5904
6594
|
content: {
|
|
5905
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
5906
6595
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
5907
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
5908
6596
|
};
|
|
5909
6597
|
};
|
|
5910
6598
|
};
|
|
@@ -6178,6 +6866,10 @@ export interface components {
|
|
|
6178
6866
|
/** Format: date-time */
|
|
6179
6867
|
created_at?: string;
|
|
6180
6868
|
};
|
|
6869
|
+
ApprovalDecision: {
|
|
6870
|
+
decision?: string | null;
|
|
6871
|
+
comment?: string | null;
|
|
6872
|
+
};
|
|
6181
6873
|
AttachFileRequest: {
|
|
6182
6874
|
/** Format: uuid */
|
|
6183
6875
|
file_id?: string;
|
|
@@ -6647,6 +7339,18 @@ export interface components {
|
|
|
6647
7339
|
/** Format: date-time */
|
|
6648
7340
|
created_at?: string;
|
|
6649
7341
|
};
|
|
7342
|
+
RunEventDto: {
|
|
7343
|
+
/** Format: uuid */
|
|
7344
|
+
id?: string;
|
|
7345
|
+
/** Format: int64 */
|
|
7346
|
+
seq?: number;
|
|
7347
|
+
type?: string | null;
|
|
7348
|
+
/** Format: date-time */
|
|
7349
|
+
timestamp?: string;
|
|
7350
|
+
/** Format: uuid */
|
|
7351
|
+
attempt_id?: string;
|
|
7352
|
+
payload?: unknown;
|
|
7353
|
+
};
|
|
6650
7354
|
RunEventItem: {
|
|
6651
7355
|
id?: string | null;
|
|
6652
7356
|
type?: string | null;
|
|
@@ -6654,6 +7358,14 @@ export interface components {
|
|
|
6654
7358
|
timestamp?: string;
|
|
6655
7359
|
data?: unknown;
|
|
6656
7360
|
};
|
|
7361
|
+
RunEventsPollResponse: {
|
|
7362
|
+
events?: components["schemas"]["RunEventDto"][] | null;
|
|
7363
|
+
/** Format: int64 */
|
|
7364
|
+
latest_seq?: number;
|
|
7365
|
+
/** Format: int64 */
|
|
7366
|
+
next_after_seq?: number;
|
|
7367
|
+
has_more?: boolean;
|
|
7368
|
+
};
|
|
6657
7369
|
RunEventsResponse: {
|
|
6658
7370
|
items?: components["schemas"]["RunEventItem"][] | null;
|
|
6659
7371
|
/** Format: int32 */
|