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