@agent-os-sdk/client 0.1.1 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client/AgentOsClient.d.ts +57 -38
- package/dist/client/AgentOsClient.d.ts.map +1 -1
- package/dist/client/AgentOsClient.js +192 -37
- 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 +1009 -204
- package/dist/generated/openapi.d.ts.map +1 -1
- package/dist/index.d.ts +12 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +12 -0
- package/dist/modules/approvals.d.ts +64 -0
- package/dist/modules/approvals.d.ts.map +1 -0
- package/dist/modules/approvals.js +54 -0
- package/dist/modules/artifacts.d.ts +49 -0
- package/dist/modules/artifacts.d.ts.map +1 -0
- package/dist/modules/artifacts.js +50 -0
- package/dist/modules/budgets.d.ts +81 -0
- package/dist/modules/budgets.d.ts.map +1 -0
- package/dist/modules/budgets.js +50 -0
- package/dist/modules/builder.d.ts +23 -3
- package/dist/modules/builder.d.ts.map +1 -1
- package/dist/modules/builder.js +28 -6
- package/dist/modules/capabilities.d.ts +57 -0
- package/dist/modules/capabilities.d.ts.map +1 -0
- package/dist/modules/capabilities.js +50 -0
- package/dist/modules/deployments.d.ts +67 -0
- package/dist/modules/deployments.d.ts.map +1 -0
- package/dist/modules/deployments.js +58 -0
- package/dist/modules/flows.d.ts +84 -0
- package/dist/modules/flows.d.ts.map +1 -0
- package/dist/modules/flows.js +66 -0
- package/dist/modules/handoff.d.ts +91 -0
- package/dist/modules/handoff.d.ts.map +1 -0
- package/dist/modules/handoff.js +65 -0
- package/dist/modules/incidents.d.ts +72 -0
- package/dist/modules/incidents.d.ts.map +1 -0
- package/dist/modules/incidents.js +54 -0
- package/dist/modules/members.d.ts +5 -0
- package/dist/modules/members.d.ts.map +1 -1
- package/dist/modules/members.js +10 -0
- package/dist/modules/policies.d.ts +76 -0
- package/dist/modules/policies.d.ts.map +1 -0
- package/dist/modules/policies.js +46 -0
- 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/dist/modules/tenants.d.ts +4 -0
- package/dist/modules/tenants.d.ts.map +1 -1
- package/dist/modules/tenants.js +8 -0
- package/package.json +49 -48
- package/src/client/AgentOsClient.ts +217 -61
- package/src/client/auth.ts +148 -0
- package/src/generated/openapi.ts +1009 -204
- package/src/generated/swagger.json +947 -700
- package/src/index.ts +25 -2
- package/src/modules/approvals.ts +109 -0
- package/src/modules/artifacts.ts +83 -0
- package/src/modules/budgets.ts +120 -0
- package/src/modules/builder.ts +26 -4
- package/src/modules/capabilities.ts +95 -0
- package/src/modules/deployments.ts +111 -0
- package/src/modules/flows.ts +133 -0
- package/src/modules/handoff.ts +140 -0
- package/src/modules/incidents.ts +113 -0
- package/src/modules/members.ts +11 -0
- package/src/modules/policies.ts +112 -0
- package/src/modules/runs.ts +123 -5
- package/src/modules/tenants.ts +9 -0
|
@@ -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: {
|
|
@@ -521,13 +838,22 @@ export interface paths {
|
|
|
521
838
|
};
|
|
522
839
|
requestBody?: never;
|
|
523
840
|
responses: {
|
|
524
|
-
/** @description
|
|
841
|
+
/** @description Returns the list of tokens. */
|
|
525
842
|
200: {
|
|
526
843
|
headers: {
|
|
527
844
|
[name: string]: unknown;
|
|
528
845
|
};
|
|
529
846
|
content?: never;
|
|
530
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
|
+
};
|
|
531
857
|
};
|
|
532
858
|
};
|
|
533
859
|
put?: never;
|
|
@@ -601,6 +927,180 @@ export interface paths {
|
|
|
601
927
|
patch?: never;
|
|
602
928
|
trace?: never;
|
|
603
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: {
|
|
1030
|
+
parameters: {
|
|
1031
|
+
query?: never;
|
|
1032
|
+
header?: never;
|
|
1033
|
+
path: {
|
|
1034
|
+
workspaceId: string;
|
|
1035
|
+
approvalId: string;
|
|
1036
|
+
};
|
|
1037
|
+
cookie?: never;
|
|
1038
|
+
};
|
|
1039
|
+
requestBody?: never;
|
|
1040
|
+
responses: {
|
|
1041
|
+
/** @description OK */
|
|
1042
|
+
200: {
|
|
1043
|
+
headers: {
|
|
1044
|
+
[name: string]: unknown;
|
|
1045
|
+
};
|
|
1046
|
+
content?: never;
|
|
1047
|
+
};
|
|
1048
|
+
};
|
|
1049
|
+
};
|
|
1050
|
+
put?: never;
|
|
1051
|
+
post?: never;
|
|
1052
|
+
delete?: never;
|
|
1053
|
+
options?: never;
|
|
1054
|
+
head?: never;
|
|
1055
|
+
patch?: never;
|
|
1056
|
+
trace?: never;
|
|
1057
|
+
};
|
|
1058
|
+
"/v1/api/workspaces/{workspaceId}/approvals/{approvalId}/decision": {
|
|
1059
|
+
parameters: {
|
|
1060
|
+
query?: never;
|
|
1061
|
+
header?: never;
|
|
1062
|
+
path?: never;
|
|
1063
|
+
cookie?: never;
|
|
1064
|
+
};
|
|
1065
|
+
get?: never;
|
|
1066
|
+
put?: never;
|
|
1067
|
+
/**
|
|
1068
|
+
* Decide on an approval: approve or deny.
|
|
1069
|
+
* Idempotent: re-deciding returns 200 no-op.
|
|
1070
|
+
*/
|
|
1071
|
+
post: {
|
|
1072
|
+
parameters: {
|
|
1073
|
+
query?: never;
|
|
1074
|
+
header?: never;
|
|
1075
|
+
path: {
|
|
1076
|
+
workspaceId: string;
|
|
1077
|
+
approvalId: string;
|
|
1078
|
+
};
|
|
1079
|
+
cookie?: never;
|
|
1080
|
+
};
|
|
1081
|
+
requestBody?: {
|
|
1082
|
+
content: {
|
|
1083
|
+
"application/json": components["schemas"]["ApprovalDecision"];
|
|
1084
|
+
"text/json": components["schemas"]["ApprovalDecision"];
|
|
1085
|
+
"application/*+json": components["schemas"]["ApprovalDecision"];
|
|
1086
|
+
};
|
|
1087
|
+
};
|
|
1088
|
+
responses: {
|
|
1089
|
+
/** @description OK */
|
|
1090
|
+
200: {
|
|
1091
|
+
headers: {
|
|
1092
|
+
[name: string]: unknown;
|
|
1093
|
+
};
|
|
1094
|
+
content?: never;
|
|
1095
|
+
};
|
|
1096
|
+
};
|
|
1097
|
+
};
|
|
1098
|
+
delete?: never;
|
|
1099
|
+
options?: never;
|
|
1100
|
+
head?: never;
|
|
1101
|
+
patch?: never;
|
|
1102
|
+
trace?: never;
|
|
1103
|
+
};
|
|
604
1104
|
"/v1/api/audit": {
|
|
605
1105
|
parameters: {
|
|
606
1106
|
query?: never;
|
|
@@ -644,24 +1144,111 @@ export interface paths {
|
|
|
644
1144
|
patch?: never;
|
|
645
1145
|
trace?: never;
|
|
646
1146
|
};
|
|
647
|
-
"/v1/api/audit/{id}": {
|
|
1147
|
+
"/v1/api/audit/{id}": {
|
|
1148
|
+
parameters: {
|
|
1149
|
+
query?: never;
|
|
1150
|
+
header?: never;
|
|
1151
|
+
path?: never;
|
|
1152
|
+
cookie?: never;
|
|
1153
|
+
};
|
|
1154
|
+
/** Get a specific audit log entry. */
|
|
1155
|
+
get: {
|
|
1156
|
+
parameters: {
|
|
1157
|
+
query?: never;
|
|
1158
|
+
header?: never;
|
|
1159
|
+
path: {
|
|
1160
|
+
id: string;
|
|
1161
|
+
};
|
|
1162
|
+
cookie?: never;
|
|
1163
|
+
};
|
|
1164
|
+
requestBody?: never;
|
|
1165
|
+
responses: {
|
|
1166
|
+
/** @description OK */
|
|
1167
|
+
200: {
|
|
1168
|
+
headers: {
|
|
1169
|
+
[name: string]: unknown;
|
|
1170
|
+
};
|
|
1171
|
+
content?: never;
|
|
1172
|
+
};
|
|
1173
|
+
};
|
|
1174
|
+
};
|
|
1175
|
+
put?: never;
|
|
1176
|
+
post?: never;
|
|
1177
|
+
delete?: never;
|
|
1178
|
+
options?: never;
|
|
1179
|
+
head?: never;
|
|
1180
|
+
patch?: never;
|
|
1181
|
+
trace?: never;
|
|
1182
|
+
};
|
|
1183
|
+
"/v1/api/audit/search": {
|
|
1184
|
+
parameters: {
|
|
1185
|
+
query?: never;
|
|
1186
|
+
header?: never;
|
|
1187
|
+
path?: never;
|
|
1188
|
+
cookie?: never;
|
|
1189
|
+
};
|
|
1190
|
+
/** Search audit logs by action pattern. */
|
|
1191
|
+
get: {
|
|
1192
|
+
parameters: {
|
|
1193
|
+
query?: {
|
|
1194
|
+
query?: string;
|
|
1195
|
+
from?: string;
|
|
1196
|
+
to?: string;
|
|
1197
|
+
skip?: number;
|
|
1198
|
+
take?: number;
|
|
1199
|
+
};
|
|
1200
|
+
header?: never;
|
|
1201
|
+
path?: never;
|
|
1202
|
+
cookie?: never;
|
|
1203
|
+
};
|
|
1204
|
+
requestBody?: never;
|
|
1205
|
+
responses: {
|
|
1206
|
+
/** @description OK */
|
|
1207
|
+
200: {
|
|
1208
|
+
headers: {
|
|
1209
|
+
[name: string]: unknown;
|
|
1210
|
+
};
|
|
1211
|
+
content?: never;
|
|
1212
|
+
};
|
|
1213
|
+
};
|
|
1214
|
+
};
|
|
1215
|
+
put?: never;
|
|
1216
|
+
post?: never;
|
|
1217
|
+
delete?: never;
|
|
1218
|
+
options?: never;
|
|
1219
|
+
head?: never;
|
|
1220
|
+
patch?: never;
|
|
1221
|
+
trace?: never;
|
|
1222
|
+
};
|
|
1223
|
+
"/v1/api/builder/{agentId}/chat": {
|
|
648
1224
|
parameters: {
|
|
649
1225
|
query?: never;
|
|
650
1226
|
header?: never;
|
|
651
1227
|
path?: never;
|
|
652
1228
|
cookie?: never;
|
|
653
1229
|
};
|
|
654
|
-
|
|
655
|
-
|
|
1230
|
+
get?: never;
|
|
1231
|
+
put?: never;
|
|
1232
|
+
/**
|
|
1233
|
+
* Chat with the Meta-Agent to modify an agent's graph.
|
|
1234
|
+
* Returns SSE stream: message, graph_update, done events.
|
|
1235
|
+
*/
|
|
1236
|
+
post: {
|
|
656
1237
|
parameters: {
|
|
657
1238
|
query?: never;
|
|
658
1239
|
header?: never;
|
|
659
1240
|
path: {
|
|
660
|
-
|
|
1241
|
+
agentId: string;
|
|
661
1242
|
};
|
|
662
1243
|
cookie?: never;
|
|
663
1244
|
};
|
|
664
|
-
requestBody?:
|
|
1245
|
+
requestBody?: {
|
|
1246
|
+
content: {
|
|
1247
|
+
"application/json": components["schemas"]["BuilderChatRequest"];
|
|
1248
|
+
"text/json": components["schemas"]["BuilderChatRequest"];
|
|
1249
|
+
"application/*+json": components["schemas"]["BuilderChatRequest"];
|
|
1250
|
+
};
|
|
1251
|
+
};
|
|
665
1252
|
responses: {
|
|
666
1253
|
/** @description OK */
|
|
667
1254
|
200: {
|
|
@@ -672,36 +1259,38 @@ export interface paths {
|
|
|
672
1259
|
};
|
|
673
1260
|
};
|
|
674
1261
|
};
|
|
675
|
-
put?: never;
|
|
676
|
-
post?: never;
|
|
677
1262
|
delete?: never;
|
|
678
1263
|
options?: never;
|
|
679
1264
|
head?: never;
|
|
680
1265
|
patch?: never;
|
|
681
1266
|
trace?: never;
|
|
682
1267
|
};
|
|
683
|
-
"/v1/api/
|
|
1268
|
+
"/v1/api/builder/{agentId}/chat/sync": {
|
|
684
1269
|
parameters: {
|
|
685
1270
|
query?: never;
|
|
686
1271
|
header?: never;
|
|
687
1272
|
path?: never;
|
|
688
1273
|
cookie?: never;
|
|
689
1274
|
};
|
|
690
|
-
|
|
691
|
-
|
|
1275
|
+
get?: never;
|
|
1276
|
+
put?: never;
|
|
1277
|
+
/** Synchronous version of builder chat (for testing). */
|
|
1278
|
+
post: {
|
|
692
1279
|
parameters: {
|
|
693
|
-
query?:
|
|
694
|
-
query?: string;
|
|
695
|
-
from?: string;
|
|
696
|
-
to?: string;
|
|
697
|
-
skip?: number;
|
|
698
|
-
take?: number;
|
|
699
|
-
};
|
|
1280
|
+
query?: never;
|
|
700
1281
|
header?: never;
|
|
701
|
-
path
|
|
1282
|
+
path: {
|
|
1283
|
+
agentId: string;
|
|
1284
|
+
};
|
|
702
1285
|
cookie?: never;
|
|
703
1286
|
};
|
|
704
|
-
requestBody?:
|
|
1287
|
+
requestBody?: {
|
|
1288
|
+
content: {
|
|
1289
|
+
"application/json": components["schemas"]["BuilderChatRequest"];
|
|
1290
|
+
"text/json": components["schemas"]["BuilderChatRequest"];
|
|
1291
|
+
"application/*+json": components["schemas"]["BuilderChatRequest"];
|
|
1292
|
+
};
|
|
1293
|
+
};
|
|
705
1294
|
responses: {
|
|
706
1295
|
/** @description OK */
|
|
707
1296
|
200: {
|
|
@@ -712,8 +1301,6 @@ export interface paths {
|
|
|
712
1301
|
};
|
|
713
1302
|
};
|
|
714
1303
|
};
|
|
715
|
-
put?: never;
|
|
716
|
-
post?: never;
|
|
717
1304
|
delete?: never;
|
|
718
1305
|
options?: never;
|
|
719
1306
|
head?: never;
|
|
@@ -746,9 +1333,7 @@ export interface paths {
|
|
|
746
1333
|
[name: string]: unknown;
|
|
747
1334
|
};
|
|
748
1335
|
content: {
|
|
749
|
-
"text/plain": components["schemas"]["CheckpointListResponse"];
|
|
750
1336
|
"application/json": components["schemas"]["CheckpointListResponse"];
|
|
751
|
-
"text/json": components["schemas"]["CheckpointListResponse"];
|
|
752
1337
|
};
|
|
753
1338
|
};
|
|
754
1339
|
/** @description Not Found */
|
|
@@ -757,9 +1342,7 @@ export interface paths {
|
|
|
757
1342
|
[name: string]: unknown;
|
|
758
1343
|
};
|
|
759
1344
|
content: {
|
|
760
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
761
1345
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
762
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
763
1346
|
};
|
|
764
1347
|
};
|
|
765
1348
|
};
|
|
@@ -790,9 +1373,7 @@ export interface paths {
|
|
|
790
1373
|
[name: string]: unknown;
|
|
791
1374
|
};
|
|
792
1375
|
content: {
|
|
793
|
-
"text/plain": components["schemas"]["CheckpointDetail"];
|
|
794
1376
|
"application/json": components["schemas"]["CheckpointDetail"];
|
|
795
|
-
"text/json": components["schemas"]["CheckpointDetail"];
|
|
796
1377
|
};
|
|
797
1378
|
};
|
|
798
1379
|
};
|
|
@@ -830,9 +1411,7 @@ export interface paths {
|
|
|
830
1411
|
[name: string]: unknown;
|
|
831
1412
|
};
|
|
832
1413
|
content: {
|
|
833
|
-
"text/plain": components["schemas"]["CheckpointDetail"];
|
|
834
1414
|
"application/json": components["schemas"]["CheckpointDetail"];
|
|
835
|
-
"text/json": components["schemas"]["CheckpointDetail"];
|
|
836
1415
|
};
|
|
837
1416
|
};
|
|
838
1417
|
/** @description Not Found */
|
|
@@ -841,9 +1420,7 @@ export interface paths {
|
|
|
841
1420
|
[name: string]: unknown;
|
|
842
1421
|
};
|
|
843
1422
|
content: {
|
|
844
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
845
1423
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
846
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
847
1424
|
};
|
|
848
1425
|
};
|
|
849
1426
|
};
|
|
@@ -891,9 +1468,7 @@ export interface paths {
|
|
|
891
1468
|
[name: string]: unknown;
|
|
892
1469
|
};
|
|
893
1470
|
content: {
|
|
894
|
-
"text/plain": components["schemas"]["ReplayResponse"];
|
|
895
1471
|
"application/json": components["schemas"]["ReplayResponse"];
|
|
896
|
-
"text/json": components["schemas"]["ReplayResponse"];
|
|
897
1472
|
};
|
|
898
1473
|
};
|
|
899
1474
|
/** @description Not Found */
|
|
@@ -902,9 +1477,7 @@ export interface paths {
|
|
|
902
1477
|
[name: string]: unknown;
|
|
903
1478
|
};
|
|
904
1479
|
content: {
|
|
905
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
906
1480
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
907
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
908
1481
|
};
|
|
909
1482
|
};
|
|
910
1483
|
};
|
|
@@ -922,38 +1495,55 @@ export interface paths {
|
|
|
922
1495
|
path?: never;
|
|
923
1496
|
cookie?: never;
|
|
924
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
|
+
*/
|
|
925
1503
|
get: {
|
|
926
1504
|
parameters: {
|
|
927
1505
|
query?: {
|
|
1506
|
+
/** @description Optional filter by workspace. */
|
|
928
1507
|
workspaceId?: string;
|
|
929
1508
|
};
|
|
930
|
-
header?:
|
|
931
|
-
"X-Tenant-Id"?: string;
|
|
932
|
-
};
|
|
1509
|
+
header?: never;
|
|
933
1510
|
path?: never;
|
|
934
1511
|
cookie?: never;
|
|
935
1512
|
};
|
|
936
1513
|
requestBody?: never;
|
|
937
1514
|
responses: {
|
|
938
|
-
/** @description
|
|
1515
|
+
/** @description Returns the list of credentials. */
|
|
939
1516
|
200: {
|
|
940
1517
|
headers: {
|
|
941
1518
|
[name: string]: unknown;
|
|
942
1519
|
};
|
|
943
1520
|
content?: never;
|
|
944
1521
|
};
|
|
1522
|
+
/** @description Authentication required. */
|
|
1523
|
+
401: {
|
|
1524
|
+
headers: {
|
|
1525
|
+
[name: string]: unknown;
|
|
1526
|
+
};
|
|
1527
|
+
content: {
|
|
1528
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
1529
|
+
};
|
|
1530
|
+
};
|
|
945
1531
|
};
|
|
946
1532
|
};
|
|
947
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
|
+
*/
|
|
948
1539
|
post: {
|
|
949
1540
|
parameters: {
|
|
950
1541
|
query?: never;
|
|
951
|
-
header?:
|
|
952
|
-
"X-Member-Id"?: string;
|
|
953
|
-
};
|
|
1542
|
+
header?: never;
|
|
954
1543
|
path?: never;
|
|
955
1544
|
cookie?: never;
|
|
956
1545
|
};
|
|
1546
|
+
/** @description The credential configuration. */
|
|
957
1547
|
requestBody?: {
|
|
958
1548
|
content: {
|
|
959
1549
|
"application/json": components["schemas"]["CreateCredentialRequest"];
|
|
@@ -962,13 +1552,31 @@ export interface paths {
|
|
|
962
1552
|
};
|
|
963
1553
|
};
|
|
964
1554
|
responses: {
|
|
965
|
-
/** @description
|
|
966
|
-
|
|
1555
|
+
/** @description Credential created successfully. */
|
|
1556
|
+
201: {
|
|
967
1557
|
headers: {
|
|
968
1558
|
[name: string]: unknown;
|
|
969
1559
|
};
|
|
970
1560
|
content?: never;
|
|
971
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
|
+
};
|
|
972
1580
|
};
|
|
973
1581
|
};
|
|
974
1582
|
delete?: never;
|
|
@@ -990,17 +1598,18 @@ export interface paths {
|
|
|
990
1598
|
delete?: never;
|
|
991
1599
|
options?: never;
|
|
992
1600
|
head?: never;
|
|
1601
|
+
/** Updates an existing credential. */
|
|
993
1602
|
patch: {
|
|
994
1603
|
parameters: {
|
|
995
1604
|
query?: never;
|
|
996
|
-
header?:
|
|
997
|
-
"X-Member-Id"?: string;
|
|
998
|
-
};
|
|
1605
|
+
header?: never;
|
|
999
1606
|
path: {
|
|
1607
|
+
/** @description The credential ID. */
|
|
1000
1608
|
id: string;
|
|
1001
1609
|
};
|
|
1002
1610
|
cookie?: never;
|
|
1003
1611
|
};
|
|
1612
|
+
/** @description The update payload. */
|
|
1004
1613
|
requestBody?: {
|
|
1005
1614
|
content: {
|
|
1006
1615
|
"application/json": components["schemas"]["UpdateCredentialRequest"];
|
|
@@ -1009,13 +1618,22 @@ export interface paths {
|
|
|
1009
1618
|
};
|
|
1010
1619
|
};
|
|
1011
1620
|
responses: {
|
|
1012
|
-
/** @description
|
|
1621
|
+
/** @description Credential updated successfully. */
|
|
1013
1622
|
200: {
|
|
1014
1623
|
headers: {
|
|
1015
1624
|
[name: string]: unknown;
|
|
1016
1625
|
};
|
|
1017
1626
|
content?: never;
|
|
1018
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
|
+
};
|
|
1019
1637
|
};
|
|
1020
1638
|
};
|
|
1021
1639
|
trace?: never;
|
|
@@ -1029,17 +1647,18 @@ export interface paths {
|
|
|
1029
1647
|
};
|
|
1030
1648
|
get?: never;
|
|
1031
1649
|
put?: never;
|
|
1650
|
+
/** Grants access to a credential for a workspace. */
|
|
1032
1651
|
post: {
|
|
1033
1652
|
parameters: {
|
|
1034
1653
|
query?: never;
|
|
1035
|
-
header?:
|
|
1036
|
-
"X-Member-Id"?: string;
|
|
1037
|
-
};
|
|
1654
|
+
header?: never;
|
|
1038
1655
|
path: {
|
|
1656
|
+
/** @description The credential ID. */
|
|
1039
1657
|
id: string;
|
|
1040
1658
|
};
|
|
1041
1659
|
cookie?: never;
|
|
1042
1660
|
};
|
|
1661
|
+
/** @description The grant configuration. */
|
|
1043
1662
|
requestBody?: {
|
|
1044
1663
|
content: {
|
|
1045
1664
|
"application/json": components["schemas"]["GrantAccessRequest"];
|
|
@@ -1048,13 +1667,22 @@ export interface paths {
|
|
|
1048
1667
|
};
|
|
1049
1668
|
};
|
|
1050
1669
|
responses: {
|
|
1051
|
-
/** @description
|
|
1670
|
+
/** @description Access granted successfully. */
|
|
1052
1671
|
200: {
|
|
1053
1672
|
headers: {
|
|
1054
1673
|
[name: string]: unknown;
|
|
1055
1674
|
};
|
|
1056
1675
|
content?: never;
|
|
1057
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
|
+
};
|
|
1058
1686
|
};
|
|
1059
1687
|
};
|
|
1060
1688
|
delete?: never;
|
|
@@ -1073,26 +1701,35 @@ export interface paths {
|
|
|
1073
1701
|
get?: never;
|
|
1074
1702
|
put?: never;
|
|
1075
1703
|
post?: never;
|
|
1704
|
+
/** Revokes access to a credential. */
|
|
1076
1705
|
delete: {
|
|
1077
1706
|
parameters: {
|
|
1078
1707
|
query?: never;
|
|
1079
|
-
header?:
|
|
1080
|
-
"X-Member-Id"?: string;
|
|
1081
|
-
};
|
|
1708
|
+
header?: never;
|
|
1082
1709
|
path: {
|
|
1710
|
+
/** @description The access grant ID to revoke. */
|
|
1083
1711
|
accessId: string;
|
|
1084
1712
|
};
|
|
1085
1713
|
cookie?: never;
|
|
1086
1714
|
};
|
|
1087
1715
|
requestBody?: never;
|
|
1088
1716
|
responses: {
|
|
1089
|
-
/** @description
|
|
1090
|
-
|
|
1717
|
+
/** @description Access revoked successfully. */
|
|
1718
|
+
204: {
|
|
1091
1719
|
headers: {
|
|
1092
1720
|
[name: string]: unknown;
|
|
1093
1721
|
};
|
|
1094
1722
|
content?: never;
|
|
1095
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
|
+
};
|
|
1096
1733
|
};
|
|
1097
1734
|
};
|
|
1098
1735
|
options?: never;
|
|
@@ -1798,9 +2435,7 @@ export interface paths {
|
|
|
1798
2435
|
[name: string]: unknown;
|
|
1799
2436
|
};
|
|
1800
2437
|
content: {
|
|
1801
|
-
"text/plain": components["schemas"]["PresignedUploadResponse"];
|
|
1802
2438
|
"application/json": components["schemas"]["PresignedUploadResponse"];
|
|
1803
|
-
"text/json": components["schemas"]["PresignedUploadResponse"];
|
|
1804
2439
|
};
|
|
1805
2440
|
};
|
|
1806
2441
|
/** @description Bad Request */
|
|
@@ -1809,9 +2444,7 @@ export interface paths {
|
|
|
1809
2444
|
[name: string]: unknown;
|
|
1810
2445
|
};
|
|
1811
2446
|
content: {
|
|
1812
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
1813
2447
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
1814
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
1815
2448
|
};
|
|
1816
2449
|
};
|
|
1817
2450
|
};
|
|
@@ -1856,9 +2489,7 @@ export interface paths {
|
|
|
1856
2489
|
[name: string]: unknown;
|
|
1857
2490
|
};
|
|
1858
2491
|
content: {
|
|
1859
|
-
"text/plain": components["schemas"]["FileConfirmResponse"];
|
|
1860
2492
|
"application/json": components["schemas"]["FileConfirmResponse"];
|
|
1861
|
-
"text/json": components["schemas"]["FileConfirmResponse"];
|
|
1862
2493
|
};
|
|
1863
2494
|
};
|
|
1864
2495
|
/** @description Bad Request */
|
|
@@ -1867,9 +2498,7 @@ export interface paths {
|
|
|
1867
2498
|
[name: string]: unknown;
|
|
1868
2499
|
};
|
|
1869
2500
|
content: {
|
|
1870
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
1871
2501
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
1872
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
1873
2502
|
};
|
|
1874
2503
|
};
|
|
1875
2504
|
/** @description Not Found */
|
|
@@ -1878,9 +2507,7 @@ export interface paths {
|
|
|
1878
2507
|
[name: string]: unknown;
|
|
1879
2508
|
};
|
|
1880
2509
|
content: {
|
|
1881
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
1882
2510
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
1883
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
1884
2511
|
};
|
|
1885
2512
|
};
|
|
1886
2513
|
};
|
|
@@ -1917,9 +2544,7 @@ export interface paths {
|
|
|
1917
2544
|
[name: string]: unknown;
|
|
1918
2545
|
};
|
|
1919
2546
|
content: {
|
|
1920
|
-
"text/plain": components["schemas"]["PresignedDownloadResponse"];
|
|
1921
2547
|
"application/json": components["schemas"]["PresignedDownloadResponse"];
|
|
1922
|
-
"text/json": components["schemas"]["PresignedDownloadResponse"];
|
|
1923
2548
|
};
|
|
1924
2549
|
};
|
|
1925
2550
|
/** @description Not Found */
|
|
@@ -1928,9 +2553,7 @@ export interface paths {
|
|
|
1928
2553
|
[name: string]: unknown;
|
|
1929
2554
|
};
|
|
1930
2555
|
content: {
|
|
1931
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
1932
2556
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
1933
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
1934
2557
|
};
|
|
1935
2558
|
};
|
|
1936
2559
|
};
|
|
@@ -1972,9 +2595,7 @@ export interface paths {
|
|
|
1972
2595
|
[name: string]: unknown;
|
|
1973
2596
|
};
|
|
1974
2597
|
content: {
|
|
1975
|
-
"text/plain": components["schemas"]["FileListItem"][];
|
|
1976
2598
|
"application/json": components["schemas"]["FileListItem"][];
|
|
1977
|
-
"text/json": components["schemas"]["FileListItem"][];
|
|
1978
2599
|
};
|
|
1979
2600
|
};
|
|
1980
2601
|
};
|
|
@@ -2013,9 +2634,7 @@ export interface paths {
|
|
|
2013
2634
|
[name: string]: unknown;
|
|
2014
2635
|
};
|
|
2015
2636
|
content: {
|
|
2016
|
-
"text/plain": components["schemas"]["FileDetail"];
|
|
2017
2637
|
"application/json": components["schemas"]["FileDetail"];
|
|
2018
|
-
"text/json": components["schemas"]["FileDetail"];
|
|
2019
2638
|
};
|
|
2020
2639
|
};
|
|
2021
2640
|
/** @description Not Found */
|
|
@@ -2024,9 +2643,7 @@ export interface paths {
|
|
|
2024
2643
|
[name: string]: unknown;
|
|
2025
2644
|
};
|
|
2026
2645
|
content: {
|
|
2027
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
2028
2646
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
2029
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
2030
2647
|
};
|
|
2031
2648
|
};
|
|
2032
2649
|
};
|
|
@@ -2059,9 +2676,7 @@ export interface paths {
|
|
|
2059
2676
|
[name: string]: unknown;
|
|
2060
2677
|
};
|
|
2061
2678
|
content: {
|
|
2062
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
2063
2679
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
2064
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
2065
2680
|
};
|
|
2066
2681
|
};
|
|
2067
2682
|
};
|
|
@@ -3263,7 +3878,16 @@ export interface paths {
|
|
|
3263
3878
|
path?: never;
|
|
3264
3879
|
cookie?: never;
|
|
3265
3880
|
};
|
|
3266
|
-
/**
|
|
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
|
+
*/
|
|
3267
3891
|
get: {
|
|
3268
3892
|
parameters: {
|
|
3269
3893
|
query?: {
|
|
@@ -3271,11 +3895,11 @@ export interface paths {
|
|
|
3271
3895
|
agentId?: string;
|
|
3272
3896
|
/** @description Optional filter by thread ID. */
|
|
3273
3897
|
threadId?: string;
|
|
3274
|
-
/** @description Optional filter by status. */
|
|
3898
|
+
/** @description Optional filter by status (queued, running, completed, failed, canceled). */
|
|
3275
3899
|
status?: string;
|
|
3276
|
-
/** @description Max results to return
|
|
3900
|
+
/** @description Max results to return. Default: 20, Max: 100. */
|
|
3277
3901
|
limit?: number;
|
|
3278
|
-
/** @description
|
|
3902
|
+
/** @description Number of records to skip for pagination. */
|
|
3279
3903
|
offset?: number;
|
|
3280
3904
|
};
|
|
3281
3905
|
header?: never;
|
|
@@ -3284,24 +3908,47 @@ export interface paths {
|
|
|
3284
3908
|
};
|
|
3285
3909
|
requestBody?: never;
|
|
3286
3910
|
responses: {
|
|
3287
|
-
/** @description
|
|
3911
|
+
/** @description Returns the list of runs. */
|
|
3288
3912
|
200: {
|
|
3289
3913
|
headers: {
|
|
3290
3914
|
[name: string]: unknown;
|
|
3291
3915
|
};
|
|
3292
3916
|
content: {
|
|
3293
|
-
"text/plain": components["schemas"]["RunListResponse"];
|
|
3294
3917
|
"application/json": components["schemas"]["RunListResponse"];
|
|
3295
|
-
|
|
3918
|
+
};
|
|
3919
|
+
};
|
|
3920
|
+
/** @description Authentication required. */
|
|
3921
|
+
401: {
|
|
3922
|
+
headers: {
|
|
3923
|
+
[name: string]: unknown;
|
|
3924
|
+
};
|
|
3925
|
+
content: {
|
|
3926
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
3296
3927
|
};
|
|
3297
3928
|
};
|
|
3298
3929
|
};
|
|
3299
3930
|
};
|
|
3300
3931
|
put?: never;
|
|
3301
3932
|
/**
|
|
3302
|
-
* Starts a new agent run.
|
|
3303
|
-
* @description
|
|
3304
|
-
*
|
|
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
|
+
* ```
|
|
3305
3952
|
*/
|
|
3306
3953
|
post: {
|
|
3307
3954
|
parameters: {
|
|
@@ -3310,7 +3957,7 @@ export interface paths {
|
|
|
3310
3957
|
path?: never;
|
|
3311
3958
|
cookie?: never;
|
|
3312
3959
|
};
|
|
3313
|
-
/** @description The run request
|
|
3960
|
+
/** @description The run request with agent ID and input. */
|
|
3314
3961
|
requestBody?: {
|
|
3315
3962
|
content: {
|
|
3316
3963
|
"application/json": components["schemas"]["CreateRunRequest"];
|
|
@@ -3319,26 +3966,40 @@ export interface paths {
|
|
|
3319
3966
|
};
|
|
3320
3967
|
};
|
|
3321
3968
|
responses: {
|
|
3322
|
-
/** @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. */
|
|
3323
3979
|
201: {
|
|
3324
3980
|
headers: {
|
|
3325
3981
|
[name: string]: unknown;
|
|
3326
3982
|
};
|
|
3327
3983
|
content: {
|
|
3328
|
-
"text/plain": components["schemas"]["RunResponse"];
|
|
3329
3984
|
"application/json": components["schemas"]["RunResponse"];
|
|
3330
|
-
"text/json": components["schemas"]["RunResponse"];
|
|
3331
3985
|
};
|
|
3332
3986
|
};
|
|
3333
|
-
/** @description
|
|
3987
|
+
/** @description Invalid request (missing agent, invalid input). */
|
|
3334
3988
|
400: {
|
|
3335
3989
|
headers: {
|
|
3336
3990
|
[name: string]: unknown;
|
|
3337
3991
|
};
|
|
3338
3992
|
content: {
|
|
3339
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
3340
3993
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
3341
|
-
|
|
3994
|
+
};
|
|
3995
|
+
};
|
|
3996
|
+
/** @description Authentication required. */
|
|
3997
|
+
401: {
|
|
3998
|
+
headers: {
|
|
3999
|
+
[name: string]: unknown;
|
|
4000
|
+
};
|
|
4001
|
+
content: {
|
|
4002
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
3342
4003
|
};
|
|
3343
4004
|
};
|
|
3344
4005
|
};
|
|
@@ -3375,9 +4036,7 @@ export interface paths {
|
|
|
3375
4036
|
[name: string]: unknown;
|
|
3376
4037
|
};
|
|
3377
4038
|
content: {
|
|
3378
|
-
"text/plain": components["schemas"]["RunDetailResponse"];
|
|
3379
4039
|
"application/json": components["schemas"]["RunDetailResponse"];
|
|
3380
|
-
"text/json": components["schemas"]["RunDetailResponse"];
|
|
3381
4040
|
};
|
|
3382
4041
|
};
|
|
3383
4042
|
/** @description Not Found */
|
|
@@ -3386,9 +4045,7 @@ export interface paths {
|
|
|
3386
4045
|
[name: string]: unknown;
|
|
3387
4046
|
};
|
|
3388
4047
|
content: {
|
|
3389
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
3390
4048
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
3391
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
3392
4049
|
};
|
|
3393
4050
|
};
|
|
3394
4051
|
};
|
|
@@ -3435,9 +4092,7 @@ export interface paths {
|
|
|
3435
4092
|
[name: string]: unknown;
|
|
3436
4093
|
};
|
|
3437
4094
|
content: {
|
|
3438
|
-
"text/plain": components["schemas"]["RunEventsResponse"];
|
|
3439
4095
|
"application/json": components["schemas"]["RunEventsResponse"];
|
|
3440
|
-
"text/json": components["schemas"]["RunEventsResponse"];
|
|
3441
4096
|
};
|
|
3442
4097
|
};
|
|
3443
4098
|
/** @description Not Found */
|
|
@@ -3446,9 +4101,68 @@ export interface paths {
|
|
|
3446
4101
|
[name: string]: unknown;
|
|
3447
4102
|
};
|
|
3448
4103
|
content: {
|
|
3449
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
3450
4104
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
3451
|
-
|
|
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"];
|
|
3452
4166
|
};
|
|
3453
4167
|
};
|
|
3454
4168
|
};
|
|
@@ -3493,9 +4207,7 @@ export interface paths {
|
|
|
3493
4207
|
[name: string]: unknown;
|
|
3494
4208
|
};
|
|
3495
4209
|
content: {
|
|
3496
|
-
"text/plain": components["schemas"]["WaitRunResponse"];
|
|
3497
4210
|
"application/json": components["schemas"]["WaitRunResponse"];
|
|
3498
|
-
"text/json": components["schemas"]["WaitRunResponse"];
|
|
3499
4211
|
};
|
|
3500
4212
|
};
|
|
3501
4213
|
/** @description Bad Request */
|
|
@@ -3504,9 +4216,7 @@ export interface paths {
|
|
|
3504
4216
|
[name: string]: unknown;
|
|
3505
4217
|
};
|
|
3506
4218
|
content: {
|
|
3507
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
3508
4219
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
3509
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
3510
4220
|
};
|
|
3511
4221
|
};
|
|
3512
4222
|
/** @description Request Timeout */
|
|
@@ -3515,9 +4225,7 @@ export interface paths {
|
|
|
3515
4225
|
[name: string]: unknown;
|
|
3516
4226
|
};
|
|
3517
4227
|
content: {
|
|
3518
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
3519
4228
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
3520
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
3521
4229
|
};
|
|
3522
4230
|
};
|
|
3523
4231
|
};
|
|
@@ -3560,9 +4268,7 @@ export interface paths {
|
|
|
3560
4268
|
[name: string]: unknown;
|
|
3561
4269
|
};
|
|
3562
4270
|
content: {
|
|
3563
|
-
"text/plain": components["schemas"]["BatchRunResponse"];
|
|
3564
4271
|
"application/json": components["schemas"]["BatchRunResponse"];
|
|
3565
|
-
"text/json": components["schemas"]["BatchRunResponse"];
|
|
3566
4272
|
};
|
|
3567
4273
|
};
|
|
3568
4274
|
/** @description Bad Request */
|
|
@@ -3571,9 +4277,7 @@ export interface paths {
|
|
|
3571
4277
|
[name: string]: unknown;
|
|
3572
4278
|
};
|
|
3573
4279
|
content: {
|
|
3574
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
3575
4280
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
3576
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
3577
4281
|
};
|
|
3578
4282
|
};
|
|
3579
4283
|
};
|
|
@@ -3630,7 +4334,29 @@ export interface paths {
|
|
|
3630
4334
|
};
|
|
3631
4335
|
get?: never;
|
|
3632
4336
|
put?: never;
|
|
3633
|
-
/**
|
|
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
|
+
*/
|
|
3634
4360
|
post: {
|
|
3635
4361
|
parameters: {
|
|
3636
4362
|
query?: never;
|
|
@@ -3638,7 +4364,7 @@ export interface paths {
|
|
|
3638
4364
|
path?: never;
|
|
3639
4365
|
cookie?: never;
|
|
3640
4366
|
};
|
|
3641
|
-
/** @description The
|
|
4367
|
+
/** @description The run request with agent ID and input. */
|
|
3642
4368
|
requestBody?: {
|
|
3643
4369
|
content: {
|
|
3644
4370
|
"application/json": components["schemas"]["StreamRunRequest"];
|
|
@@ -3697,9 +4423,7 @@ export interface paths {
|
|
|
3697
4423
|
[name: string]: unknown;
|
|
3698
4424
|
};
|
|
3699
4425
|
content: {
|
|
3700
|
-
"text/plain": components["schemas"]["RerunResponse"];
|
|
3701
4426
|
"application/json": components["schemas"]["RerunResponse"];
|
|
3702
|
-
"text/json": components["schemas"]["RerunResponse"];
|
|
3703
4427
|
};
|
|
3704
4428
|
};
|
|
3705
4429
|
/** @description Not Found */
|
|
@@ -3708,9 +4432,7 @@ export interface paths {
|
|
|
3708
4432
|
[name: string]: unknown;
|
|
3709
4433
|
};
|
|
3710
4434
|
content: {
|
|
3711
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
3712
4435
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
3713
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
3714
4436
|
};
|
|
3715
4437
|
};
|
|
3716
4438
|
};
|
|
@@ -3755,9 +4477,7 @@ export interface paths {
|
|
|
3755
4477
|
[name: string]: unknown;
|
|
3756
4478
|
};
|
|
3757
4479
|
content: {
|
|
3758
|
-
"text/plain": components["schemas"]["ReplayResponse"];
|
|
3759
4480
|
"application/json": components["schemas"]["ReplayResponse"];
|
|
3760
|
-
"text/json": components["schemas"]["ReplayResponse"];
|
|
3761
4481
|
};
|
|
3762
4482
|
};
|
|
3763
4483
|
/** @description Not Found */
|
|
@@ -3766,9 +4486,7 @@ export interface paths {
|
|
|
3766
4486
|
[name: string]: unknown;
|
|
3767
4487
|
};
|
|
3768
4488
|
content: {
|
|
3769
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
3770
4489
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
3771
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
3772
4490
|
};
|
|
3773
4491
|
};
|
|
3774
4492
|
};
|
|
@@ -3804,9 +4522,7 @@ export interface paths {
|
|
|
3804
4522
|
[name: string]: unknown;
|
|
3805
4523
|
};
|
|
3806
4524
|
content: {
|
|
3807
|
-
"text/plain": components["schemas"]["CheckpointIndexResponse"];
|
|
3808
4525
|
"application/json": components["schemas"]["CheckpointIndexResponse"];
|
|
3809
|
-
"text/json": components["schemas"]["CheckpointIndexResponse"];
|
|
3810
4526
|
};
|
|
3811
4527
|
};
|
|
3812
4528
|
/** @description Not Found */
|
|
@@ -3815,9 +4531,7 @@ export interface paths {
|
|
|
3815
4531
|
[name: string]: unknown;
|
|
3816
4532
|
};
|
|
3817
4533
|
content: {
|
|
3818
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
3819
4534
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
3820
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
3821
4535
|
};
|
|
3822
4536
|
};
|
|
3823
4537
|
};
|
|
@@ -3863,9 +4577,7 @@ export interface paths {
|
|
|
3863
4577
|
[name: string]: unknown;
|
|
3864
4578
|
};
|
|
3865
4579
|
content: {
|
|
3866
|
-
"text/plain": components["schemas"]["ResumeResponse"];
|
|
3867
4580
|
"application/json": components["schemas"]["ResumeResponse"];
|
|
3868
|
-
"text/json": components["schemas"]["ResumeResponse"];
|
|
3869
4581
|
};
|
|
3870
4582
|
};
|
|
3871
4583
|
/** @description Bad Request */
|
|
@@ -3874,9 +4586,7 @@ export interface paths {
|
|
|
3874
4586
|
[name: string]: unknown;
|
|
3875
4587
|
};
|
|
3876
4588
|
content: {
|
|
3877
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
3878
4589
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
3879
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
3880
4590
|
};
|
|
3881
4591
|
};
|
|
3882
4592
|
/** @description Not Found */
|
|
@@ -3885,9 +4595,7 @@ export interface paths {
|
|
|
3885
4595
|
[name: string]: unknown;
|
|
3886
4596
|
};
|
|
3887
4597
|
content: {
|
|
3888
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
3889
4598
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
3890
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
3891
4599
|
};
|
|
3892
4600
|
};
|
|
3893
4601
|
};
|
|
@@ -3931,9 +4639,7 @@ export interface paths {
|
|
|
3931
4639
|
[name: string]: unknown;
|
|
3932
4640
|
};
|
|
3933
4641
|
content: {
|
|
3934
|
-
"text/plain": components["schemas"]["CancelRunResponse"];
|
|
3935
4642
|
"application/json": components["schemas"]["CancelRunResponse"];
|
|
3936
|
-
"text/json": components["schemas"]["CancelRunResponse"];
|
|
3937
4643
|
};
|
|
3938
4644
|
};
|
|
3939
4645
|
/** @description Not Found */
|
|
@@ -3942,9 +4648,7 @@ export interface paths {
|
|
|
3942
4648
|
[name: string]: unknown;
|
|
3943
4649
|
};
|
|
3944
4650
|
content: {
|
|
3945
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
3946
4651
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
3947
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
3948
4652
|
};
|
|
3949
4653
|
};
|
|
3950
4654
|
};
|
|
@@ -4282,7 +4986,19 @@ export interface paths {
|
|
|
4282
4986
|
};
|
|
4283
4987
|
};
|
|
4284
4988
|
put?: never;
|
|
4285
|
-
/**
|
|
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
|
+
*/
|
|
4286
5002
|
post: {
|
|
4287
5003
|
parameters: {
|
|
4288
5004
|
query?: never;
|
|
@@ -4290,6 +5006,7 @@ export interface paths {
|
|
|
4290
5006
|
path?: never;
|
|
4291
5007
|
cookie?: never;
|
|
4292
5008
|
};
|
|
5009
|
+
/** @description Thread creation options including channel and metadata. */
|
|
4293
5010
|
requestBody?: {
|
|
4294
5011
|
content: {
|
|
4295
5012
|
"application/json": components["schemas"]["CreateThreadRequest"];
|
|
@@ -4298,13 +5015,22 @@ export interface paths {
|
|
|
4298
5015
|
};
|
|
4299
5016
|
};
|
|
4300
5017
|
responses: {
|
|
4301
|
-
/** @description
|
|
4302
|
-
|
|
5018
|
+
/** @description Thread created successfully. */
|
|
5019
|
+
201: {
|
|
4303
5020
|
headers: {
|
|
4304
5021
|
[name: string]: unknown;
|
|
4305
5022
|
};
|
|
4306
5023
|
content?: never;
|
|
4307
5024
|
};
|
|
5025
|
+
/** @description Authentication required. */
|
|
5026
|
+
401: {
|
|
5027
|
+
headers: {
|
|
5028
|
+
[name: string]: unknown;
|
|
5029
|
+
};
|
|
5030
|
+
content: {
|
|
5031
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
5032
|
+
};
|
|
5033
|
+
};
|
|
4308
5034
|
};
|
|
4309
5035
|
};
|
|
4310
5036
|
delete?: never;
|
|
@@ -4320,25 +5046,39 @@ export interface paths {
|
|
|
4320
5046
|
path?: never;
|
|
4321
5047
|
cookie?: never;
|
|
4322
5048
|
};
|
|
4323
|
-
/**
|
|
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
|
+
*/
|
|
4324
5054
|
get: {
|
|
4325
5055
|
parameters: {
|
|
4326
5056
|
query?: never;
|
|
4327
5057
|
header?: never;
|
|
4328
5058
|
path: {
|
|
5059
|
+
/** @description The unique identifier of the thread. */
|
|
4329
5060
|
id: string;
|
|
4330
5061
|
};
|
|
4331
5062
|
cookie?: never;
|
|
4332
5063
|
};
|
|
4333
5064
|
requestBody?: never;
|
|
4334
5065
|
responses: {
|
|
4335
|
-
/** @description
|
|
5066
|
+
/** @description Returns the thread. */
|
|
4336
5067
|
200: {
|
|
4337
5068
|
headers: {
|
|
4338
5069
|
[name: string]: unknown;
|
|
4339
5070
|
};
|
|
4340
5071
|
content?: never;
|
|
4341
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
|
+
};
|
|
4342
5082
|
};
|
|
4343
5083
|
};
|
|
4344
5084
|
put?: never;
|
|
@@ -4377,27 +5117,43 @@ export interface paths {
|
|
|
4377
5117
|
cookie?: never;
|
|
4378
5118
|
};
|
|
4379
5119
|
/**
|
|
4380
|
-
*
|
|
4381
|
-
*
|
|
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.
|
|
4382
5128
|
*/
|
|
4383
5129
|
get: {
|
|
4384
5130
|
parameters: {
|
|
4385
5131
|
query?: never;
|
|
4386
5132
|
header?: never;
|
|
4387
5133
|
path: {
|
|
5134
|
+
/** @description The unique identifier of the thread. */
|
|
4388
5135
|
id: string;
|
|
4389
5136
|
};
|
|
4390
5137
|
cookie?: never;
|
|
4391
5138
|
};
|
|
4392
5139
|
requestBody?: never;
|
|
4393
5140
|
responses: {
|
|
4394
|
-
/** @description
|
|
5141
|
+
/** @description Returns the thread state summary. */
|
|
4395
5142
|
200: {
|
|
4396
5143
|
headers: {
|
|
4397
5144
|
[name: string]: unknown;
|
|
4398
5145
|
};
|
|
4399
5146
|
content?: never;
|
|
4400
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
|
+
};
|
|
4401
5157
|
};
|
|
4402
5158
|
};
|
|
4403
5159
|
put?: never;
|
|
@@ -5529,24 +6285,33 @@ export interface paths {
|
|
|
5529
6285
|
[name: string]: unknown;
|
|
5530
6286
|
};
|
|
5531
6287
|
content: {
|
|
5532
|
-
"text/plain": components["schemas"]["VectorStoreResponse"][];
|
|
5533
6288
|
"application/json": components["schemas"]["VectorStoreResponse"][];
|
|
5534
|
-
"text/json": components["schemas"]["VectorStoreResponse"][];
|
|
5535
6289
|
};
|
|
5536
6290
|
};
|
|
5537
6291
|
};
|
|
5538
6292
|
};
|
|
5539
6293
|
put?: never;
|
|
5540
|
-
/**
|
|
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
|
+
*/
|
|
5541
6304
|
post: {
|
|
5542
6305
|
parameters: {
|
|
5543
6306
|
query?: never;
|
|
5544
6307
|
header?: never;
|
|
5545
6308
|
path: {
|
|
6309
|
+
/** @description The workspace to create the vector store in. */
|
|
5546
6310
|
workspaceId: string;
|
|
5547
6311
|
};
|
|
5548
6312
|
cookie?: never;
|
|
5549
6313
|
};
|
|
6314
|
+
/** @description Vector store configuration. */
|
|
5550
6315
|
requestBody?: {
|
|
5551
6316
|
content: {
|
|
5552
6317
|
"application/json": components["schemas"]["CreateVectorStoreRequest"];
|
|
@@ -5555,15 +6320,22 @@ export interface paths {
|
|
|
5555
6320
|
};
|
|
5556
6321
|
};
|
|
5557
6322
|
responses: {
|
|
5558
|
-
/** @description
|
|
6323
|
+
/** @description Vector store created successfully. */
|
|
5559
6324
|
201: {
|
|
5560
6325
|
headers: {
|
|
5561
6326
|
[name: string]: unknown;
|
|
5562
6327
|
};
|
|
5563
6328
|
content: {
|
|
5564
|
-
"text/plain": components["schemas"]["VectorStoreResponse"];
|
|
5565
6329
|
"application/json": components["schemas"]["VectorStoreResponse"];
|
|
5566
|
-
|
|
6330
|
+
};
|
|
6331
|
+
};
|
|
6332
|
+
/** @description Workspace not found. */
|
|
6333
|
+
404: {
|
|
6334
|
+
headers: {
|
|
6335
|
+
[name: string]: unknown;
|
|
6336
|
+
};
|
|
6337
|
+
content: {
|
|
6338
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
5567
6339
|
};
|
|
5568
6340
|
};
|
|
5569
6341
|
};
|
|
@@ -5600,9 +6372,7 @@ export interface paths {
|
|
|
5600
6372
|
[name: string]: unknown;
|
|
5601
6373
|
};
|
|
5602
6374
|
content: {
|
|
5603
|
-
"text/plain": components["schemas"]["VectorStoreResponse"];
|
|
5604
6375
|
"application/json": components["schemas"]["VectorStoreResponse"];
|
|
5605
|
-
"text/json": components["schemas"]["VectorStoreResponse"];
|
|
5606
6376
|
};
|
|
5607
6377
|
};
|
|
5608
6378
|
/** @description Not Found */
|
|
@@ -5611,9 +6381,7 @@ export interface paths {
|
|
|
5611
6381
|
[name: string]: unknown;
|
|
5612
6382
|
};
|
|
5613
6383
|
content: {
|
|
5614
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
5615
6384
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
5616
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
5617
6385
|
};
|
|
5618
6386
|
};
|
|
5619
6387
|
};
|
|
@@ -5646,9 +6414,7 @@ export interface paths {
|
|
|
5646
6414
|
[name: string]: unknown;
|
|
5647
6415
|
};
|
|
5648
6416
|
content: {
|
|
5649
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
5650
6417
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
5651
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
5652
6418
|
};
|
|
5653
6419
|
};
|
|
5654
6420
|
};
|
|
@@ -5692,9 +6458,7 @@ export interface paths {
|
|
|
5692
6458
|
[name: string]: unknown;
|
|
5693
6459
|
};
|
|
5694
6460
|
content: {
|
|
5695
|
-
"text/plain": components["schemas"]["VectorStoreFileResponse"];
|
|
5696
6461
|
"application/json": components["schemas"]["VectorStoreFileResponse"];
|
|
5697
|
-
"text/json": components["schemas"]["VectorStoreFileResponse"];
|
|
5698
6462
|
};
|
|
5699
6463
|
};
|
|
5700
6464
|
/** @description Not Found */
|
|
@@ -5703,9 +6467,7 @@ export interface paths {
|
|
|
5703
6467
|
[name: string]: unknown;
|
|
5704
6468
|
};
|
|
5705
6469
|
content: {
|
|
5706
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
5707
6470
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
5708
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
5709
6471
|
};
|
|
5710
6472
|
};
|
|
5711
6473
|
};
|
|
@@ -5725,17 +6487,36 @@ export interface paths {
|
|
|
5725
6487
|
};
|
|
5726
6488
|
get?: never;
|
|
5727
6489
|
put?: never;
|
|
5728
|
-
/**
|
|
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
|
+
*/
|
|
5729
6507
|
post: {
|
|
5730
6508
|
parameters: {
|
|
5731
6509
|
query?: never;
|
|
5732
6510
|
header?: never;
|
|
5733
6511
|
path: {
|
|
6512
|
+
/** @description The workspace containing the vector store. */
|
|
5734
6513
|
workspaceId: string;
|
|
6514
|
+
/** @description The vector store to query. */
|
|
5735
6515
|
vectorStoreId: string;
|
|
5736
6516
|
};
|
|
5737
6517
|
cookie?: never;
|
|
5738
6518
|
};
|
|
6519
|
+
/** @description Query parameters including text and result limits. */
|
|
5739
6520
|
requestBody?: {
|
|
5740
6521
|
content: {
|
|
5741
6522
|
"application/json": components["schemas"]["VectorQueryRequest"];
|
|
@@ -5744,26 +6525,22 @@ export interface paths {
|
|
|
5744
6525
|
};
|
|
5745
6526
|
};
|
|
5746
6527
|
responses: {
|
|
5747
|
-
/** @description
|
|
6528
|
+
/** @description Returns matching results. */
|
|
5748
6529
|
200: {
|
|
5749
6530
|
headers: {
|
|
5750
6531
|
[name: string]: unknown;
|
|
5751
6532
|
};
|
|
5752
6533
|
content: {
|
|
5753
|
-
"text/plain": components["schemas"]["VectorQueryResponse"];
|
|
5754
6534
|
"application/json": components["schemas"]["VectorQueryResponse"];
|
|
5755
|
-
"text/json": components["schemas"]["VectorQueryResponse"];
|
|
5756
6535
|
};
|
|
5757
6536
|
};
|
|
5758
|
-
/** @description
|
|
6537
|
+
/** @description Vector store not found. */
|
|
5759
6538
|
404: {
|
|
5760
6539
|
headers: {
|
|
5761
6540
|
[name: string]: unknown;
|
|
5762
6541
|
};
|
|
5763
6542
|
content: {
|
|
5764
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
5765
6543
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
5766
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
5767
6544
|
};
|
|
5768
6545
|
};
|
|
5769
6546
|
};
|
|
@@ -5815,9 +6592,7 @@ export interface paths {
|
|
|
5815
6592
|
[name: string]: unknown;
|
|
5816
6593
|
};
|
|
5817
6594
|
content: {
|
|
5818
|
-
"text/plain": components["schemas"]["ProblemDetails"];
|
|
5819
6595
|
"application/json": components["schemas"]["ProblemDetails"];
|
|
5820
|
-
"text/json": components["schemas"]["ProblemDetails"];
|
|
5821
6596
|
};
|
|
5822
6597
|
};
|
|
5823
6598
|
};
|
|
@@ -6091,6 +6866,10 @@ export interface components {
|
|
|
6091
6866
|
/** Format: date-time */
|
|
6092
6867
|
created_at?: string;
|
|
6093
6868
|
};
|
|
6869
|
+
ApprovalDecision: {
|
|
6870
|
+
decision?: string | null;
|
|
6871
|
+
comment?: string | null;
|
|
6872
|
+
};
|
|
6094
6873
|
AttachFileRequest: {
|
|
6095
6874
|
/** Format: uuid */
|
|
6096
6875
|
file_id?: string;
|
|
@@ -6128,6 +6907,12 @@ export interface components {
|
|
|
6128
6907
|
/** Format: uuid */
|
|
6129
6908
|
agent_id?: string;
|
|
6130
6909
|
};
|
|
6910
|
+
/** @description Request DTO for builder chat. */
|
|
6911
|
+
BuilderChatRequest: {
|
|
6912
|
+
message?: string | null;
|
|
6913
|
+
current_graph_spec?: unknown;
|
|
6914
|
+
thread_id?: string | null;
|
|
6915
|
+
};
|
|
6131
6916
|
CancelRequest: {
|
|
6132
6917
|
reason?: string | null;
|
|
6133
6918
|
};
|
|
@@ -6554,6 +7339,18 @@ export interface components {
|
|
|
6554
7339
|
/** Format: date-time */
|
|
6555
7340
|
created_at?: string;
|
|
6556
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
|
+
};
|
|
6557
7354
|
RunEventItem: {
|
|
6558
7355
|
id?: string | null;
|
|
6559
7356
|
type?: string | null;
|
|
@@ -6561,6 +7358,14 @@ export interface components {
|
|
|
6561
7358
|
timestamp?: string;
|
|
6562
7359
|
data?: unknown;
|
|
6563
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
|
+
};
|
|
6564
7369
|
RunEventsResponse: {
|
|
6565
7370
|
items?: components["schemas"]["RunEventItem"][] | null;
|
|
6566
7371
|
/** Format: int32 */
|