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