@modelrelay/sdk 2.1.0 → 4.0.0

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.
Files changed (42) hide show
  1. package/dist/api-Bitsm1tl.d.cts +5290 -0
  2. package/dist/api-Bitsm1tl.d.ts +5290 -0
  3. package/dist/{api-Ct5bpI3U.d.cts → api-CzFaWgs_.d.cts} +2636 -2113
  4. package/dist/{api-Ct5bpI3U.d.ts → api-CzFaWgs_.d.ts} +2636 -2113
  5. package/dist/{api-Bb7sw9L4.d.cts → api-D0wnVpwn.d.cts} +2598 -2148
  6. package/dist/{api-Bb7sw9L4.d.ts → api-D0wnVpwn.d.ts} +2598 -2148
  7. package/dist/billing/index.d.cts +1 -1
  8. package/dist/billing/index.d.ts +1 -1
  9. package/dist/{chunk-AZD5EKLV.js → chunk-5O4NJXLJ.js} +1 -1
  10. package/dist/{chunk-4FXUTSRZ.js → chunk-ADQ74R7T.js} +1 -1
  11. package/dist/{chunk-CXJZB6MA.js → chunk-CV3DTA6P.js} +1 -1
  12. package/dist/{chunk-VOFLESGQ.js → chunk-EMQKOEF3.js} +10 -8
  13. package/dist/{chunk-R6O6UQYM.js → chunk-JZRSCFQH.js} +1 -1
  14. package/dist/{chunk-MXXJDLGU.js → chunk-LW6SC7NQ.js} +2 -63
  15. package/dist/index.cjs +58 -51
  16. package/dist/index.d.cts +27 -21
  17. package/dist/index.d.ts +27 -21
  18. package/dist/index.js +58 -51
  19. package/dist/node.cjs +1 -1
  20. package/dist/node.js +1 -1
  21. package/dist/{tools-B7444ZtV.d.cts → tools-DAqAFZ8F.d.cts} +11 -13
  22. package/dist/{tools-B7444ZtV.d.ts → tools-DAqAFZ8F.d.ts} +11 -13
  23. package/package.json +1 -1
  24. package/dist/api-DWUVls-S.d.cts +0 -4762
  25. package/dist/api-DWUVls-S.d.ts +0 -4762
  26. package/dist/api-DZpC1zuz.d.cts +0 -4691
  27. package/dist/api-DZpC1zuz.d.ts +0 -4691
  28. package/dist/api-D_hE36Ps.d.cts +0 -4535
  29. package/dist/api-D_hE36Ps.d.ts +0 -4535
  30. package/dist/api-Dz9HcUTt.d.cts +0 -4522
  31. package/dist/api-Dz9HcUTt.d.ts +0 -4522
  32. package/dist/chunk-BP5HUQ4M.js +0 -1194
  33. package/dist/chunk-CYGWZYYJ.js +0 -1194
  34. package/dist/chunk-PLZWDUOP.js +0 -1194
  35. package/dist/chunk-SCOP57J4.js +0 -1194
  36. package/dist/chunk-SXNP5Y5L.js +0 -1194
  37. package/dist/tools-CWEBFsql.d.cts +0 -1192
  38. package/dist/tools-CWEBFsql.d.ts +0 -1192
  39. package/dist/tools-CvfwPjC5.d.cts +0 -1098
  40. package/dist/tools-CvfwPjC5.d.ts +0 -1098
  41. package/dist/tools-DUYHZdZP.d.cts +0 -982
  42. package/dist/tools-DUYHZdZP.d.ts +0 -982
@@ -1,4535 +0,0 @@
1
- /**
2
- * This file was auto-generated by openapi-typescript.
3
- * Do not make direct changes to the file.
4
- */
5
- interface paths {
6
- "/auth/customer-token": {
7
- parameters: {
8
- query?: never;
9
- header?: never;
10
- path?: never;
11
- cookie?: never;
12
- };
13
- get?: never;
14
- put?: never;
15
- /**
16
- * Mint a customer-scoped bearer token
17
- * @description Used by trusted backends to mint short-lived customer-scoped bearer tokens
18
- * for data-plane access (/responses, /runs). Requires a secret API key (mr_sk_*).
19
- * The customer must already exist; use /customers endpoints to create customers first.
20
- */
21
- post: operations["mintCustomerToken"];
22
- delete?: never;
23
- options?: never;
24
- head?: never;
25
- patch?: never;
26
- trace?: never;
27
- };
28
- "/auth/login": {
29
- parameters: {
30
- query?: never;
31
- header?: never;
32
- path?: never;
33
- cookie?: never;
34
- };
35
- get?: never;
36
- put?: never;
37
- /** Exchange credentials for tokens */
38
- post: operations["login"];
39
- delete?: never;
40
- options?: never;
41
- head?: never;
42
- patch?: never;
43
- trace?: never;
44
- };
45
- "/auth/logout": {
46
- parameters: {
47
- query?: never;
48
- header?: never;
49
- path?: never;
50
- cookie?: never;
51
- };
52
- get?: never;
53
- put?: never;
54
- /** Revoke a refresh token */
55
- post: operations["logout"];
56
- delete?: never;
57
- options?: never;
58
- head?: never;
59
- patch?: never;
60
- trace?: never;
61
- };
62
- "/auth/me": {
63
- parameters: {
64
- query?: never;
65
- header?: never;
66
- path?: never;
67
- cookie?: never;
68
- };
69
- /** Fetch the authenticated user profile */
70
- get: operations["getAuthenticatedUser"];
71
- put?: never;
72
- post?: never;
73
- delete?: never;
74
- options?: never;
75
- head?: never;
76
- patch?: never;
77
- trace?: never;
78
- };
79
- "/auth/refresh": {
80
- parameters: {
81
- query?: never;
82
- header?: never;
83
- path?: never;
84
- cookie?: never;
85
- };
86
- get?: never;
87
- put?: never;
88
- /** Refresh an access token */
89
- post: operations["refreshToken"];
90
- delete?: never;
91
- options?: never;
92
- head?: never;
93
- patch?: never;
94
- trace?: never;
95
- };
96
- "/auth/register": {
97
- parameters: {
98
- query?: never;
99
- header?: never;
100
- path?: never;
101
- cookie?: never;
102
- };
103
- get?: never;
104
- put?: never;
105
- /** Register a new owner account */
106
- post: operations["registerOwner"];
107
- delete?: never;
108
- options?: never;
109
- head?: never;
110
- patch?: never;
111
- trace?: never;
112
- };
113
- "/customers": {
114
- parameters: {
115
- query?: never;
116
- header?: never;
117
- path?: never;
118
- cookie?: never;
119
- };
120
- /** List customers */
121
- get: operations["listCustomers"];
122
- /** Upsert a customer by external_id */
123
- put: operations["upsertCustomer"];
124
- /** Create a customer */
125
- post: operations["createProjectCustomer"];
126
- delete?: never;
127
- options?: never;
128
- head?: never;
129
- patch?: never;
130
- trace?: never;
131
- };
132
- "/customers/me": {
133
- parameters: {
134
- query?: never;
135
- header?: never;
136
- path?: never;
137
- cookie?: never;
138
- };
139
- /**
140
- * Get the authenticated customer
141
- * @description Returns the current customer associated with the provided customer-scoped bearer token.
142
- * Includes the customer's subscription and tier when available.
143
- */
144
- get: operations["getCustomerMe"];
145
- put?: never;
146
- post?: never;
147
- delete?: never;
148
- options?: never;
149
- head?: never;
150
- patch?: never;
151
- trace?: never;
152
- };
153
- "/customers/me/balance": {
154
- parameters: {
155
- query?: never;
156
- header?: never;
157
- path?: never;
158
- cookie?: never;
159
- };
160
- /** Get the authenticated customer's PAYGO balance */
161
- get: operations["getCustomerMeBalance"];
162
- put?: never;
163
- post?: never;
164
- delete?: never;
165
- options?: never;
166
- head?: never;
167
- patch?: never;
168
- trace?: never;
169
- };
170
- "/customers/me/balance/history": {
171
- parameters: {
172
- query?: never;
173
- header?: never;
174
- path?: never;
175
- cookie?: never;
176
- };
177
- /** Get the authenticated customer's PAYGO ledger history */
178
- get: operations["getCustomerMeBalanceHistory"];
179
- put?: never;
180
- post?: never;
181
- delete?: never;
182
- options?: never;
183
- head?: never;
184
- patch?: never;
185
- trace?: never;
186
- };
187
- "/customers/me/change-tier": {
188
- parameters: {
189
- query?: never;
190
- header?: never;
191
- path?: never;
192
- cookie?: never;
193
- };
194
- get?: never;
195
- put?: never;
196
- /**
197
- * Change the authenticated customer's subscription tier
198
- * @description Allows customers to upgrade or downgrade their subscription tier. Supports paid-to-paid (with proration), free-to-paid (requires payment method on file), paid-to-free (cancels at period end), and free-to-free transitions.
199
- */
200
- post: operations["changeCustomerMeTier"];
201
- delete?: never;
202
- options?: never;
203
- head?: never;
204
- patch?: never;
205
- trace?: never;
206
- };
207
- "/customers/me/checkout": {
208
- parameters: {
209
- query?: never;
210
- header?: never;
211
- path?: never;
212
- cookie?: never;
213
- };
214
- get?: never;
215
- put?: never;
216
- /**
217
- * Create a checkout session for the authenticated customer
218
- * @description Creates a Stripe checkout session using the customer-first flow. A Stripe Customer is created with the verified OAuth email before checkout, preventing email spoofing. The email field in the Stripe checkout will be locked to the authenticated user's email.
219
- */
220
- post: operations["createCustomerMeCheckout"];
221
- delete?: never;
222
- options?: never;
223
- head?: never;
224
- patch?: never;
225
- trace?: never;
226
- };
227
- "/customers/me/subscription": {
228
- parameters: {
229
- query?: never;
230
- header?: never;
231
- path?: never;
232
- cookie?: never;
233
- };
234
- /**
235
- * Get the authenticated customer's subscription
236
- * @description Returns customer-visible subscription details for the authenticated customer bearer token.
237
- * Includes tier name and subscription price; does not include developer-private usage cost accounting.
238
- */
239
- get: operations["getCustomerMeSubscription"];
240
- put?: never;
241
- post?: never;
242
- delete?: never;
243
- options?: never;
244
- head?: never;
245
- patch?: never;
246
- trace?: never;
247
- };
248
- "/customers/me/topup": {
249
- parameters: {
250
- query?: never;
251
- header?: never;
252
- path?: never;
253
- cookie?: never;
254
- };
255
- get?: never;
256
- put?: never;
257
- /** Create a PAYGO top-up checkout session for the authenticated customer */
258
- post: operations["createCustomerMeTopup"];
259
- delete?: never;
260
- options?: never;
261
- head?: never;
262
- patch?: never;
263
- trace?: never;
264
- };
265
- "/customers/me/usage": {
266
- parameters: {
267
- query?: never;
268
- header?: never;
269
- path?: never;
270
- cookie?: never;
271
- };
272
- /**
273
- * Get the authenticated customer's usage
274
- * @description Returns customer-visible usage metrics for the current billing window.
275
- * Includes request/token counts and (for paid tiers) remaining subscription credits.
276
- * Does not include any developer-private budgets (e.g., internal tier spend caps).
277
- */
278
- get: operations["getCustomerMeUsage"];
279
- put?: never;
280
- post?: never;
281
- delete?: never;
282
- options?: never;
283
- head?: never;
284
- patch?: never;
285
- trace?: never;
286
- };
287
- "/customers/{customer_id}": {
288
- parameters: {
289
- query?: never;
290
- header?: never;
291
- path: {
292
- customer_id: string;
293
- };
294
- cookie?: never;
295
- };
296
- /** Get a customer */
297
- get: operations["getCustomer"];
298
- put?: never;
299
- post?: never;
300
- /** Delete a customer */
301
- delete: operations["deleteProjectCustomer"];
302
- options?: never;
303
- head?: never;
304
- patch?: never;
305
- trace?: never;
306
- };
307
- "/customers/{customer_id}/balance": {
308
- parameters: {
309
- query?: never;
310
- header?: never;
311
- path: {
312
- customer_id: string;
313
- };
314
- cookie?: never;
315
- };
316
- /** Get a customer's PAYGO balance */
317
- get: operations["getCustomerBalance"];
318
- put?: never;
319
- post?: never;
320
- delete?: never;
321
- options?: never;
322
- head?: never;
323
- patch?: never;
324
- trace?: never;
325
- };
326
- "/customers/{customer_id}/balance/history": {
327
- parameters: {
328
- query?: never;
329
- header?: never;
330
- path: {
331
- customer_id: string;
332
- };
333
- cookie?: never;
334
- };
335
- /** Get a customer's PAYGO ledger history */
336
- get: operations["getCustomerBalanceHistory"];
337
- put?: never;
338
- post?: never;
339
- delete?: never;
340
- options?: never;
341
- head?: never;
342
- patch?: never;
343
- trace?: never;
344
- };
345
- "/customers/{customer_id}/subscribe": {
346
- parameters: {
347
- query?: never;
348
- header?: never;
349
- path: {
350
- customer_id: string;
351
- };
352
- cookie?: never;
353
- };
354
- get?: never;
355
- put?: never;
356
- /** Create a customer subscription checkout session */
357
- post: operations["subscribeCustomer"];
358
- delete?: never;
359
- options?: never;
360
- head?: never;
361
- patch?: never;
362
- trace?: never;
363
- };
364
- "/customers/{customer_id}/subscription": {
365
- parameters: {
366
- query?: never;
367
- header?: never;
368
- path: {
369
- customer_id: string;
370
- };
371
- cookie?: never;
372
- };
373
- /** Get a customer's subscription */
374
- get: operations["getCustomerSubscription"];
375
- put?: never;
376
- post?: never;
377
- /** Cancel a customer's subscription */
378
- delete: operations["cancelCustomerSubscription"];
379
- options?: never;
380
- head?: never;
381
- patch?: never;
382
- trace?: never;
383
- };
384
- "/customers/{customer_id}/topup": {
385
- parameters: {
386
- query?: never;
387
- header?: never;
388
- path: {
389
- customer_id: string;
390
- };
391
- cookie?: never;
392
- };
393
- get?: never;
394
- put?: never;
395
- /** Create a PAYGO top-up checkout session for a customer */
396
- post: operations["createCustomerTopup"];
397
- delete?: never;
398
- options?: never;
399
- head?: never;
400
- patch?: never;
401
- trace?: never;
402
- };
403
- "/images/generate": {
404
- parameters: {
405
- query?: never;
406
- header?: never;
407
- path?: never;
408
- cookie?: never;
409
- };
410
- get?: never;
411
- put?: never;
412
- /**
413
- * Generate images from a text prompt
414
- * @description Generate images using AI models. Returns URLs by default (requires storage configuration) or base64-encoded data when response_format is 'b64_json'.
415
- */
416
- post: operations["generateImage"];
417
- delete?: never;
418
- options?: never;
419
- head?: never;
420
- patch?: never;
421
- trace?: never;
422
- };
423
- "/images/{image_id}": {
424
- parameters: {
425
- query?: never;
426
- header?: never;
427
- path: {
428
- /** @description Image ID */
429
- image_id: string;
430
- };
431
- cookie?: never;
432
- };
433
- /**
434
- * Get image details
435
- * @description Retrieve information about a specific image, including its pinned status and URL.
436
- */
437
- get: operations["getImage"];
438
- put?: never;
439
- post?: never;
440
- delete?: never;
441
- options?: never;
442
- head?: never;
443
- patch?: never;
444
- trace?: never;
445
- };
446
- "/images/{image_id}/pin": {
447
- parameters: {
448
- query?: never;
449
- header?: never;
450
- path: {
451
- /** @description Image ID */
452
- image_id: string;
453
- };
454
- cookie?: never;
455
- };
456
- get?: never;
457
- put?: never;
458
- /**
459
- * Pin an image
460
- * @description Pin an image to prevent it from expiring. Pinned images remain accessible permanently (subject to tier limits).
461
- */
462
- post: operations["pinImage"];
463
- /**
464
- * Unpin an image
465
- * @description Unpin an image, setting it to expire after the default ephemeral period (7 days).
466
- */
467
- delete: operations["unpinImage"];
468
- options?: never;
469
- head?: never;
470
- patch?: never;
471
- trace?: never;
472
- };
473
- "/models": {
474
- parameters: {
475
- query?: never;
476
- header?: never;
477
- path?: never;
478
- cookie?: never;
479
- };
480
- /**
481
- * List active models
482
- * @description Returns all active models with rich metadata for building model selectors.
483
- */
484
- get: operations["listModels"];
485
- put?: never;
486
- post?: never;
487
- delete?: never;
488
- options?: never;
489
- head?: never;
490
- patch?: never;
491
- trace?: never;
492
- };
493
- "/projects": {
494
- parameters: {
495
- query?: never;
496
- header?: never;
497
- path?: never;
498
- cookie?: never;
499
- };
500
- /** List projects for the authenticated owner */
501
- get: operations["listProjects"];
502
- put?: never;
503
- /** Create a project */
504
- post: operations["createProject"];
505
- delete?: never;
506
- options?: never;
507
- head?: never;
508
- patch?: never;
509
- trace?: never;
510
- };
511
- "/projects/{id}": {
512
- parameters: {
513
- query?: never;
514
- header?: never;
515
- path: {
516
- id: components["parameters"]["ProjectID"];
517
- };
518
- cookie?: never;
519
- };
520
- /** Get a project */
521
- get: operations["getProject"];
522
- /** Update a project */
523
- put: operations["updateProject"];
524
- post?: never;
525
- /** Delete a project */
526
- delete: operations["deleteProject"];
527
- options?: never;
528
- head?: never;
529
- patch?: never;
530
- trace?: never;
531
- };
532
- "/projects/{id}/customers": {
533
- parameters: {
534
- query?: never;
535
- header?: never;
536
- path: {
537
- id: components["parameters"]["ProjectID"];
538
- };
539
- cookie?: never;
540
- };
541
- /** List customers for a project */
542
- get: operations["listProjectCustomers"];
543
- put?: never;
544
- /** Create a customer */
545
- post: operations["createCustomer"];
546
- delete?: never;
547
- options?: never;
548
- head?: never;
549
- patch?: never;
550
- trace?: never;
551
- };
552
- "/projects/{id}/customers/{customer_id}": {
553
- parameters: {
554
- query?: never;
555
- header?: never;
556
- path: {
557
- id: components["parameters"]["ProjectID"];
558
- customer_id: string;
559
- };
560
- cookie?: never;
561
- };
562
- get?: never;
563
- put?: never;
564
- post?: never;
565
- /** Delete a customer */
566
- delete: operations["deleteCustomer"];
567
- options?: never;
568
- head?: never;
569
- patch?: never;
570
- trace?: never;
571
- };
572
- "/projects/{id}/tiers": {
573
- parameters: {
574
- query?: never;
575
- header?: never;
576
- path: {
577
- id: components["parameters"]["ProjectID"];
578
- };
579
- cookie?: never;
580
- };
581
- /** List tiers for a project */
582
- get: operations["listProjectTiers"];
583
- put?: never;
584
- /** Create a tier */
585
- post: operations["createTier"];
586
- delete?: never;
587
- options?: never;
588
- head?: never;
589
- patch?: never;
590
- trace?: never;
591
- };
592
- "/projects/{id}/tiers/{tier_id}": {
593
- parameters: {
594
- query?: never;
595
- header?: never;
596
- path: {
597
- id: components["parameters"]["ProjectID"];
598
- tier_id: string;
599
- };
600
- cookie?: never;
601
- };
602
- get?: never;
603
- /** Update a tier */
604
- put: operations["updateTier"];
605
- post?: never;
606
- /** Delete a tier */
607
- delete: operations["deleteTier"];
608
- options?: never;
609
- head?: never;
610
- patch?: never;
611
- trace?: never;
612
- };
613
- "/projects/{id}/tool-hooks": {
614
- parameters: {
615
- query?: never;
616
- header?: never;
617
- path: {
618
- id: components["parameters"]["ProjectID"];
619
- };
620
- cookie?: never;
621
- };
622
- /** List project tool hooks */
623
- get: operations["listProjectToolHooks"];
624
- put?: never;
625
- /** Create a project tool hook */
626
- post: operations["createProjectToolHook"];
627
- delete?: never;
628
- options?: never;
629
- head?: never;
630
- patch?: never;
631
- trace?: never;
632
- };
633
- "/projects/{id}/tool-hooks/{hook_id}": {
634
- parameters: {
635
- query?: never;
636
- header?: never;
637
- path: {
638
- id: components["parameters"]["ProjectID"];
639
- hook_id: components["parameters"]["ToolHookID"];
640
- };
641
- cookie?: never;
642
- };
643
- /** Get a project tool hook */
644
- get: operations["getProjectToolHook"];
645
- /** Update a project tool hook */
646
- put: operations["updateProjectToolHook"];
647
- post?: never;
648
- /** Delete a project tool hook */
649
- delete: operations["deleteProjectToolHook"];
650
- options?: never;
651
- head?: never;
652
- patch?: never;
653
- trace?: never;
654
- };
655
- "/projects/{id}/tool-hooks/{hook_id}/events": {
656
- parameters: {
657
- query?: never;
658
- header?: never;
659
- path: {
660
- id: components["parameters"]["ProjectID"];
661
- hook_id: components["parameters"]["ToolHookID"];
662
- };
663
- cookie?: never;
664
- };
665
- /** List tool hook delivery events */
666
- get: operations["listProjectToolHookEvents"];
667
- put?: never;
668
- post?: never;
669
- delete?: never;
670
- options?: never;
671
- head?: never;
672
- patch?: never;
673
- trace?: never;
674
- };
675
- "/projects/{id}/tool-hooks/{hook_id}/test": {
676
- parameters: {
677
- query?: never;
678
- header?: never;
679
- path: {
680
- id: components["parameters"]["ProjectID"];
681
- hook_id: components["parameters"]["ToolHookID"];
682
- };
683
- cookie?: never;
684
- };
685
- get?: never;
686
- put?: never;
687
- /** Test a tool hook */
688
- post: operations["testProjectToolHook"];
689
- delete?: never;
690
- options?: never;
691
- head?: never;
692
- patch?: never;
693
- trace?: never;
694
- };
695
- "/projects/{id}/webhooks": {
696
- parameters: {
697
- query?: never;
698
- header?: never;
699
- path: {
700
- id: components["parameters"]["ProjectID"];
701
- };
702
- cookie?: never;
703
- };
704
- /** List project webhooks */
705
- get: operations["listProjectWebhooks"];
706
- put?: never;
707
- /** Create a project webhook */
708
- post: operations["createProjectWebhook"];
709
- delete?: never;
710
- options?: never;
711
- head?: never;
712
- patch?: never;
713
- trace?: never;
714
- };
715
- "/projects/{id}/webhooks/{webhook_id}": {
716
- parameters: {
717
- query?: never;
718
- header?: never;
719
- path: {
720
- id: components["parameters"]["ProjectID"];
721
- webhook_id: components["parameters"]["WebhookID"];
722
- };
723
- cookie?: never;
724
- };
725
- /** Get a project webhook */
726
- get: operations["getProjectWebhook"];
727
- /** Update a project webhook */
728
- put: operations["updateProjectWebhook"];
729
- post?: never;
730
- /** Delete a project webhook */
731
- delete: operations["deleteProjectWebhook"];
732
- options?: never;
733
- head?: never;
734
- patch?: never;
735
- trace?: never;
736
- };
737
- "/projects/{id}/webhooks/{webhook_id}/events": {
738
- parameters: {
739
- query?: never;
740
- header?: never;
741
- path: {
742
- id: components["parameters"]["ProjectID"];
743
- webhook_id: components["parameters"]["WebhookID"];
744
- };
745
- cookie?: never;
746
- };
747
- /** List webhook delivery events */
748
- get: operations["listProjectWebhookEvents"];
749
- put?: never;
750
- post?: never;
751
- delete?: never;
752
- options?: never;
753
- head?: never;
754
- patch?: never;
755
- trace?: never;
756
- };
757
- "/projects/{id}/webhooks/{webhook_id}/test": {
758
- parameters: {
759
- query?: never;
760
- header?: never;
761
- path: {
762
- id: components["parameters"]["ProjectID"];
763
- webhook_id: components["parameters"]["WebhookID"];
764
- };
765
- cookie?: never;
766
- };
767
- get?: never;
768
- put?: never;
769
- /** Test a webhook */
770
- post: operations["testProjectWebhook"];
771
- delete?: never;
772
- options?: never;
773
- head?: never;
774
- patch?: never;
775
- trace?: never;
776
- };
777
- "/responses": {
778
- parameters: {
779
- query?: never;
780
- header?: never;
781
- path?: never;
782
- cookie?: never;
783
- };
784
- get?: never;
785
- put?: never;
786
- /**
787
- * Create a response via the provider-agnostic API
788
- * @description Creates a model response. Auth accepts secret API keys or bearer tokens. Bearer tokens may be owner session tokens (dashboard/server) or customer tokens; publishable keys are not allowed.
789
- */
790
- post: operations["createResponse"];
791
- delete?: never;
792
- options?: never;
793
- head?: never;
794
- patch?: never;
795
- trace?: never;
796
- };
797
- "/responses:batch": {
798
- parameters: {
799
- query?: never;
800
- header?: never;
801
- path?: never;
802
- cookie?: never;
803
- };
804
- get?: never;
805
- put?: never;
806
- /** Create multiple responses concurrently (batch) */
807
- post: operations["createResponsesBatch"];
808
- delete?: never;
809
- options?: never;
810
- head?: never;
811
- patch?: never;
812
- trace?: never;
813
- };
814
- "/runs": {
815
- parameters: {
816
- query?: never;
817
- header?: never;
818
- path?: never;
819
- cookie?: never;
820
- };
821
- get?: never;
822
- put?: never;
823
- /**
824
- * Start a workflow run (workflow.v0 or workflow.v1)
825
- * @description Starts a run for a `workflow.v0` or `workflow.v1` spec and returns a `run_id`. Auth matches `/responses` (API key or frontend bearer token). Session owner tokens from `/auth/login` are not accepted. Provide `session_id` to link the run to a session; when linked, assistant messages are appended to the session on completion.
826
- */
827
- post: operations["createRun"];
828
- delete?: never;
829
- options?: never;
830
- head?: never;
831
- patch?: never;
832
- trace?: never;
833
- };
834
- "/runs/{run_id}": {
835
- parameters: {
836
- query?: never;
837
- header?: never;
838
- path: {
839
- run_id: string;
840
- };
841
- cookie?: never;
842
- };
843
- /**
844
- * Get a derived run snapshot
845
- * @description Returns a derived snapshot state for the run (folded from event history + artifacts), including outputs and an aggregated cost summary when available.
846
- */
847
- get: operations["getRun"];
848
- put?: never;
849
- post?: never;
850
- delete?: never;
851
- options?: never;
852
- head?: never;
853
- patch?: never;
854
- trace?: never;
855
- };
856
- "/runs/{run_id}/events": {
857
- parameters: {
858
- query?: {
859
- /** @description Returns events where `seq > after_seq`. */
860
- after_seq?: number;
861
- /** @description When false, returns currently available events then closes. */
862
- wait?: boolean;
863
- /** @description Maximum number of events to send before closing. */
864
- limit?: number;
865
- };
866
- header?: never;
867
- path: {
868
- run_id: string;
869
- };
870
- cookie?: never;
871
- };
872
- /**
873
- * Stream run events (append-only)
874
- * @description Streams an append-only, totally ordered history for the run. The wire format is negotiated via `Accept`: NDJSON (`application/x-ndjson`) or Server-Sent Events (`text/event-stream`). Each line/event is a `run_event.v0` envelope; see `/schemas/run_event_v0.schema.json` for the canonical schema.
875
- */
876
- get: operations["streamRunEvents"];
877
- put?: never;
878
- post?: never;
879
- delete?: never;
880
- options?: never;
881
- head?: never;
882
- patch?: never;
883
- trace?: never;
884
- };
885
- "/schemas/run_event_v0.schema.json": {
886
- parameters: {
887
- query?: never;
888
- header?: never;
889
- path?: never;
890
- cookie?: never;
891
- };
892
- /**
893
- * Get JSON Schema for run_event.v0
894
- * @description Returns the canonical JSON Schema (draft-07) for `run_event.v0` (workflow run history events).
895
- */
896
- get: operations["getRunEventV0Schema"];
897
- put?: never;
898
- post?: never;
899
- delete?: never;
900
- options?: never;
901
- head?: never;
902
- patch?: never;
903
- trace?: never;
904
- };
905
- "/schemas/workflow_v0.schema.json": {
906
- parameters: {
907
- query?: never;
908
- header?: never;
909
- path?: never;
910
- cookie?: never;
911
- };
912
- /**
913
- * Get JSON Schema for workflow.v0
914
- * @description Returns the canonical JSON Schema (draft-07) for `workflow.v0`.
915
- */
916
- get: operations["getWorkflowV0Schema"];
917
- put?: never;
918
- post?: never;
919
- delete?: never;
920
- options?: never;
921
- head?: never;
922
- patch?: never;
923
- trace?: never;
924
- };
925
- "/schemas/workflow_v1.schema.json": {
926
- parameters: {
927
- query?: never;
928
- header?: never;
929
- path?: never;
930
- cookie?: never;
931
- };
932
- /**
933
- * Get JSON Schema for workflow.v1
934
- * @description Returns the canonical JSON Schema (draft-07) for `workflow.v1`.
935
- */
936
- get: operations["getWorkflowV1Schema"];
937
- put?: never;
938
- post?: never;
939
- delete?: never;
940
- options?: never;
941
- head?: never;
942
- patch?: never;
943
- trace?: never;
944
- };
945
- "/sessions": {
946
- parameters: {
947
- query?: never;
948
- header?: never;
949
- path?: never;
950
- cookie?: never;
951
- };
952
- /**
953
- * List sessions
954
- * @description Returns a paginated list of sessions for the project.
955
- */
956
- get: operations["listSessions"];
957
- put?: never;
958
- /**
959
- * Create a new session
960
- * @description Creates a new session for multi-turn conversation management. Sessions persist message history on the server for cross-device continuity.
961
- */
962
- post: operations["createSession"];
963
- delete?: never;
964
- options?: never;
965
- head?: never;
966
- patch?: never;
967
- trace?: never;
968
- };
969
- "/sessions/{session_id}": {
970
- parameters: {
971
- query?: never;
972
- header?: never;
973
- path: {
974
- session_id: string;
975
- };
976
- cookie?: never;
977
- };
978
- /**
979
- * Get session with messages
980
- * @description Returns a session including its full message history.
981
- */
982
- get: operations["getSession"];
983
- put?: never;
984
- post?: never;
985
- /**
986
- * Delete a session
987
- * @description Deletes a session and all its messages. Requires a secret API key (mr_sk_*).
988
- */
989
- delete: operations["deleteSession"];
990
- options?: never;
991
- head?: never;
992
- /**
993
- * Update session metadata
994
- * @description Updates session metadata. Keys with null values are removed.
995
- */
996
- patch: operations["updateSession"];
997
- trace?: never;
998
- };
999
- "/sessions/{session_id}/clear": {
1000
- parameters: {
1001
- query?: never;
1002
- header?: never;
1003
- path: {
1004
- session_id: string;
1005
- };
1006
- cookie?: never;
1007
- };
1008
- get?: never;
1009
- put?: never;
1010
- /**
1011
- * Clear session messages
1012
- * @description Deletes all messages in the session and returns the updated session.
1013
- */
1014
- post: operations["clearSession"];
1015
- delete?: never;
1016
- options?: never;
1017
- head?: never;
1018
- patch?: never;
1019
- trace?: never;
1020
- };
1021
- "/sessions/{session_id}/messages": {
1022
- parameters: {
1023
- query?: never;
1024
- header?: never;
1025
- path: {
1026
- session_id: string;
1027
- };
1028
- cookie?: never;
1029
- };
1030
- get?: never;
1031
- put?: never;
1032
- /**
1033
- * Append a session message
1034
- * @description Appends a message to an existing session.
1035
- */
1036
- post: operations["addSessionMessage"];
1037
- delete?: never;
1038
- options?: never;
1039
- head?: never;
1040
- patch?: never;
1041
- trace?: never;
1042
- };
1043
- }
1044
- type webhooks = Record<string, never>;
1045
- interface components {
1046
- schemas: {
1047
- APIError: {
1048
- code: string;
1049
- error: string;
1050
- message: string;
1051
- };
1052
- AuthResponse: {
1053
- access_token?: string;
1054
- refresh_token?: string;
1055
- tokens?: components["schemas"]["AuthTokens"];
1056
- user?: components["schemas"]["User"];
1057
- };
1058
- AuthTokens: {
1059
- access_token?: string;
1060
- /** Format: date-time */
1061
- expires_at?: string;
1062
- refresh_token?: string;
1063
- };
1064
- /**
1065
- * @description Billing mode for a project. 'managed' uses ModelRelay billing with tiers and subscriptions. 'byob' (Bring Your Own Billing) allows external billing.
1066
- * @enum {string}
1067
- */
1068
- BillingMode: "managed" | "byob";
1069
- /**
1070
- * @description Billing provider backing the subscription or tier.
1071
- * @enum {string}
1072
- */
1073
- BillingProvider: "stripe" | "crypto" | "app_store" | "external";
1074
- ChangeTierRequest: {
1075
- /** @description The tier code to switch to */
1076
- tier_code: string;
1077
- };
1078
- CheckoutSessionResponse: {
1079
- /** @description Stripe checkout session ID */
1080
- session_id: string;
1081
- /**
1082
- * Format: uri
1083
- * @description Checkout URL
1084
- */
1085
- url: string;
1086
- };
1087
- Citation: {
1088
- title?: string;
1089
- url?: string;
1090
- };
1091
- ContentPart: {
1092
- text?: string;
1093
- /** @enum {string} */
1094
- type: "text";
1095
- };
1096
- Customer: {
1097
- /** Format: date-time */
1098
- created_at?: string;
1099
- /**
1100
- * Format: email
1101
- * @description Customer email address
1102
- */
1103
- email?: string;
1104
- /** @description External customer identifier from your system */
1105
- external_id?: string;
1106
- /** Format: uuid */
1107
- id?: string;
1108
- metadata?: components["schemas"]["CustomerMetadata"];
1109
- /** Format: uuid */
1110
- project_id?: string;
1111
- /** Format: date-time */
1112
- updated_at?: string;
1113
- };
1114
- CustomerBalanceResponse: {
1115
- /** Format: int64 */
1116
- balance_cents: number;
1117
- /**
1118
- * Format: uuid
1119
- * @description Billing profile UUID for wallet/balance.
1120
- */
1121
- billing_profile_id: string;
1122
- currency: string;
1123
- /**
1124
- * Format: uuid
1125
- * @description Internal customer UUID (identity).
1126
- */
1127
- customer_id: string;
1128
- /** Format: int64 */
1129
- reserved_cents: number;
1130
- };
1131
- CustomerCreate: {
1132
- /**
1133
- * Format: email
1134
- * @description Customer email address
1135
- */
1136
- email: string;
1137
- /** @description External customer identifier from your system */
1138
- external_id: string;
1139
- metadata?: components["schemas"]["CustomerMetadata"];
1140
- };
1141
- CustomerLedgerEntry: {
1142
- /** Format: int64 */
1143
- amount_cents: number;
1144
- /** Format: int64 */
1145
- balance_after_cents?: number;
1146
- /** Format: int64 */
1147
- credit_amount_cents?: number;
1148
- description: string;
1149
- direction: string;
1150
- /** Format: int64 */
1151
- gross_amount_cents?: number;
1152
- /** Format: uuid */
1153
- id: string;
1154
- /** Format: int64 */
1155
- input_tokens?: number;
1156
- model_id?: components["schemas"]["ModelId"];
1157
- /** Format: date-time */
1158
- occurred_at: string;
1159
- /** Format: int64 */
1160
- output_tokens?: number;
1161
- /** Format: int64 */
1162
- owner_revenue_cents?: number;
1163
- /** Format: int64 */
1164
- platform_fee_cents?: number;
1165
- reason: string;
1166
- /** Format: uuid */
1167
- request_id?: string;
1168
- stripe_checkout_session_id?: string;
1169
- stripe_invoice_id?: string;
1170
- stripe_payment_intent_id?: string;
1171
- };
1172
- CustomerLedgerResponse: {
1173
- entries: components["schemas"]["CustomerLedgerEntry"][];
1174
- };
1175
- CustomerMe: {
1176
- customer: components["schemas"]["Customer"];
1177
- subscription?: components["schemas"]["Subscription"];
1178
- tier?: components["schemas"]["Tier"];
1179
- };
1180
- CustomerMeCheckoutRequest: {
1181
- /**
1182
- * Format: uri
1183
- * @description URL to redirect to if checkout is cancelled
1184
- */
1185
- cancel_url: string;
1186
- /**
1187
- * Format: uri
1188
- * @description URL to redirect to after successful checkout
1189
- */
1190
- success_url: string;
1191
- /** @description The tier code to subscribe to */
1192
- tier_code: string;
1193
- };
1194
- CustomerMeResponse: {
1195
- customer: components["schemas"]["CustomerMe"];
1196
- };
1197
- /** @description Customer-visible subscription details for the current tier. */
1198
- CustomerMeSubscription: {
1199
- /**
1200
- * Format: date-time
1201
- * @description End of the current billing period
1202
- */
1203
- current_period_end?: string;
1204
- /**
1205
- * Format: date-time
1206
- * @description Start of the current billing period
1207
- */
1208
- current_period_start?: string;
1209
- /**
1210
- * Format: int64
1211
- * @description Subscription price amount in cents (omitted for free tiers)
1212
- */
1213
- price_amount_cents?: number;
1214
- /** @description Currency code for the price (e.g., 'usd') */
1215
- price_currency?: string;
1216
- price_interval?: components["schemas"]["PriceInterval"];
1217
- subscription_status?: components["schemas"]["SubscriptionStatusKind"];
1218
- tier_code: components["schemas"]["TierCode"];
1219
- /** @description Human-readable tier name */
1220
- tier_display_name: string;
1221
- };
1222
- CustomerMeSubscriptionResponse: {
1223
- subscription: components["schemas"]["CustomerMeSubscription"];
1224
- };
1225
- /** @description Customer-visible usage metrics for the current billing window. */
1226
- CustomerMeUsage: {
1227
- /**
1228
- * Format: int64
1229
- * @description Credits granted for this billing window (only for paid tiers)
1230
- */
1231
- credits_granted_cents?: number;
1232
- /**
1233
- * Format: int64
1234
- * @description Credits remaining in this billing window (only for paid tiers)
1235
- */
1236
- credits_remaining_cents?: number;
1237
- /**
1238
- * Format: int64
1239
- * @description Credits used so far in this billing window (only for paid tiers)
1240
- */
1241
- credits_used_cents?: number;
1242
- daily: components["schemas"]["CustomerUsagePoint"][];
1243
- /** Format: int64 */
1244
- images: number;
1245
- /** @description Whether remaining credits are low (only for paid tiers) */
1246
- low?: boolean;
1247
- /** @description True when PAYGO wallet can cover subscription overages */
1248
- overage_enabled?: boolean;
1249
- /**
1250
- * Format: float
1251
- * @description Percentage of granted credits used (only for paid tiers)
1252
- */
1253
- percentage_used?: number;
1254
- /** Format: int64 */
1255
- requests: number;
1256
- /** Format: int64 */
1257
- tokens: number;
1258
- /**
1259
- * Format: int64
1260
- * @description PAYGO wallet balance in cents (available when PAYGO wallet is enabled)
1261
- */
1262
- wallet_balance_cents?: number;
1263
- /**
1264
- * Format: int64
1265
- * @description PAYGO wallet reserved amount in cents
1266
- */
1267
- wallet_reserved_cents?: number;
1268
- /**
1269
- * Format: date-time
1270
- * @description End of the current billing window
1271
- */
1272
- window_end: string;
1273
- /**
1274
- * Format: date-time
1275
- * @description Start of the current billing window
1276
- */
1277
- window_start: string;
1278
- };
1279
- CustomerMeUsageResponse: {
1280
- usage: components["schemas"]["CustomerMeUsage"];
1281
- };
1282
- /** @description Arbitrary customer metadata (max 10KB). Keys are limited to 40 characters. Values can be any JSON type. Nesting depth limited to 5 levels. */
1283
- CustomerMetadata: {
1284
- [key: string]: unknown;
1285
- };
1286
- CustomerTokenResponse: {
1287
- /**
1288
- * Format: uuid
1289
- * @description Billing profile UUID for managed billing customers.
1290
- */
1291
- billing_profile_id?: string;
1292
- /** @description External customer identifier */
1293
- customer_external_id: string;
1294
- /**
1295
- * Format: uuid
1296
- * @description Internal customer UUID (identity).
1297
- */
1298
- customer_id: string;
1299
- /**
1300
- * Format: date-time
1301
- * @description Token expiration timestamp
1302
- */
1303
- expires_at: string;
1304
- /**
1305
- * Format: uint32
1306
- * @description Seconds until token expires
1307
- */
1308
- expires_in: number;
1309
- /**
1310
- * Format: uuid
1311
- * @description Project the token is scoped to
1312
- */
1313
- project_id: string;
1314
- tier_code?: components["schemas"]["TierCode"];
1315
- /** @description The customer bearer token */
1316
- token: string;
1317
- };
1318
- CustomerTopupRequest: {
1319
- /** Format: uri */
1320
- cancel_url: string;
1321
- /** Format: int64 */
1322
- credit_amount_cents: number;
1323
- /** Format: uri */
1324
- success_url: string;
1325
- };
1326
- CustomerTopupResponse: {
1327
- /** Format: uri */
1328
- checkout_url: string;
1329
- /** Format: int64 */
1330
- credit_amount_cents: number;
1331
- /** Format: int64 */
1332
- gross_amount_cents: number;
1333
- /** Format: int64 */
1334
- owner_revenue_cents: number;
1335
- /** Format: int64 */
1336
- platform_fee_cents: number;
1337
- session_id: string;
1338
- status: string;
1339
- };
1340
- CustomerUsagePoint: {
1341
- /**
1342
- * Format: int64
1343
- * @description Credits used in this day bucket (only for paid tiers)
1344
- */
1345
- credits_used_cents?: number;
1346
- /**
1347
- * Format: date-time
1348
- * @description UTC day bucket
1349
- */
1350
- day: string;
1351
- /** Format: int64 */
1352
- images?: number;
1353
- /** Format: int64 */
1354
- requests: number;
1355
- /** Format: int64 */
1356
- tokens: number;
1357
- };
1358
- CustomerWithSubscription: {
1359
- /** @description Billing provider customer ID (e.g., Stripe customer ID) */
1360
- billing_customer_id?: string;
1361
- customer: components["schemas"]["Customer"];
1362
- subscription?: components["schemas"]["Subscription"];
1363
- };
1364
- /** @description A single generated image. */
1365
- ImageData: {
1366
- /** @description Base64-encoded image data (when response_format is 'b64_json') */
1367
- b64_json?: string;
1368
- /**
1369
- * Format: date-time
1370
- * @description When the image URL expires (null if pinned)
1371
- */
1372
- expires_at?: string;
1373
- /** @description Unique identifier for the image (used for pinning) */
1374
- image_id?: string;
1375
- /** @description MIME type of the image (e.g., 'image/png', 'image/webp') */
1376
- mime_type?: string;
1377
- /** @description URL to pin this image for permanent storage */
1378
- pin_url?: string;
1379
- /** @description URL of the generated image (when response_format is 'url') */
1380
- url?: string;
1381
- };
1382
- /** @description Response from pin/unpin operations. */
1383
- ImagePinResponse: {
1384
- /**
1385
- * Format: date-time
1386
- * @description When the image expires (null if pinned)
1387
- */
1388
- expires_at?: string;
1389
- /** @description Image ID */
1390
- id: string;
1391
- /** @description Whether the image is currently pinned */
1392
- pinned: boolean;
1393
- /** @description URL of the image */
1394
- url: string;
1395
- };
1396
- /** @description Request to generate images from a text prompt. */
1397
- ImageRequest: {
1398
- /** @description Image generation model ID (e.g., gemini-2.5-flash-image). Optional when using a customer token with a tier that defines a default model. */
1399
- model?: string;
1400
- /**
1401
- * @description Number of images to generate (1-10, default 1)
1402
- * @default 1
1403
- */
1404
- n: number;
1405
- /** @description Text description of the image to generate */
1406
- prompt: string;
1407
- response_format?: components["schemas"]["ImageResponseFormat"];
1408
- };
1409
- /** @description Response containing generated images. */
1410
- ImageResponse: {
1411
- /** @description Generated images */
1412
- data: components["schemas"]["ImageData"][];
1413
- /** @description Unique identifier for this generation request */
1414
- id: string;
1415
- /** @description Model used for generation */
1416
- model: string;
1417
- usage: components["schemas"]["ImageUsage"];
1418
- };
1419
- /**
1420
- * @description Output format for generated images.
1421
- * @default url
1422
- * @enum {string}
1423
- */
1424
- ImageResponseFormat: "url" | "b64_json";
1425
- /** @description Usage statistics for image generation. */
1426
- ImageUsage: {
1427
- /**
1428
- * Format: int32
1429
- * @description Number of images generated
1430
- */
1431
- images: number;
1432
- };
1433
- InputItem: {
1434
- content?: components["schemas"]["ContentPart"][];
1435
- role?: components["schemas"]["MessageRole"];
1436
- tool_call_id?: components["schemas"]["ToolCallId"];
1437
- tool_calls?: components["schemas"]["ToolCall"][];
1438
- /** @enum {string} */
1439
- type: "message";
1440
- };
1441
- JSONPatchOperation: {
1442
- from?: string;
1443
- /** @enum {string} */
1444
- op: "add" | "remove" | "replace" | "move" | "copy" | "test";
1445
- path: string;
1446
- value?: {
1447
- [key: string]: unknown;
1448
- };
1449
- };
1450
- JSONSchemaFormat: {
1451
- description?: string;
1452
- name: string;
1453
- schema?: {
1454
- [key: string]: unknown;
1455
- };
1456
- strict?: boolean;
1457
- };
1458
- /** @enum {string} */
1459
- MessageRole: "system" | "user" | "assistant" | "tool";
1460
- Model: {
1461
- capabilities: components["schemas"]["ModelCapability"][];
1462
- /** Format: int32 */
1463
- context_window: number;
1464
- deprecated: boolean;
1465
- deprecation_message: string;
1466
- description: string;
1467
- display_name: string;
1468
- /** Format: uint64 */
1469
- input_cost_per_million_cents: number;
1470
- /** Format: int32 */
1471
- max_output_tokens: number;
1472
- model_id: components["schemas"]["ModelId"];
1473
- /** Format: uint64 */
1474
- output_cost_per_million_cents: number;
1475
- provider: components["schemas"]["ProviderId"];
1476
- /** @description Training cutoff in YYYY-MM format */
1477
- training_cutoff: string;
1478
- };
1479
- /**
1480
- * @description Workflow-critical model capability identifier.
1481
- * @enum {string}
1482
- */
1483
- ModelCapability: "text_generation" | "tools" | "vision" | "web_search" | "web_fetch" | "computer_use" | "code_execution" | "image_generation";
1484
- /** @description LLM model identifier (e.g., claude-sonnet-4-5, gpt-4o). */
1485
- ModelId: string;
1486
- ModelsResponse: {
1487
- models: components["schemas"]["Model"][];
1488
- };
1489
- /**
1490
- * @description Events sent during streaming responses (application/x-ndjson).
1491
- * Each line is a JSON object with an "event" field indicating the type.
1492
- */
1493
- NDJSONStreamEvent: {
1494
- /**
1495
- * @description Event type
1496
- * @enum {string}
1497
- */
1498
- event: "message_start" | "message_delta" | "message_stop" | "tool_use_start" | "tool_use_delta" | "tool_use_stop" | "ping" | "keepalive";
1499
- model?: components["schemas"]["ModelId"];
1500
- /** @description Response identifier (message_start) */
1501
- response_id?: string;
1502
- /** @description Why generation stopped (message_stop) */
1503
- stop_reason?: string;
1504
- /** @description Text content fragment (message_delta) */
1505
- text_delta?: string;
1506
- tool_call_delta?: components["schemas"]["ToolCallDelta"];
1507
- /** @description Completed tool calls (tool_use_stop, message_stop) */
1508
- tool_calls?: components["schemas"]["ToolCall"][];
1509
- usage?: components["schemas"]["Usage"];
1510
- };
1511
- NodeErrorV0: {
1512
- code?: string;
1513
- /** @description Raw error details from the provider */
1514
- detail?: string;
1515
- message: string;
1516
- };
1517
- /** @description Workflow node identifier. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. */
1518
- NodeId: string;
1519
- NodeResultV0: {
1520
- /** Format: date-time */
1521
- ended_at?: string;
1522
- error?: components["schemas"]["NodeErrorV0"];
1523
- id: components["schemas"]["NodeId"];
1524
- output?: {
1525
- [key: string]: unknown;
1526
- };
1527
- /** Format: date-time */
1528
- started_at?: string;
1529
- status: components["schemas"]["NodeStatusV0"];
1530
- type: components["schemas"]["NodeTypeV0"];
1531
- };
1532
- /** @enum {string} */
1533
- NodeStatusV0: "pending" | "running" | "waiting" | "succeeded" | "failed" | "canceled";
1534
- /**
1535
- * @description Type of workflow node.
1536
- * @enum {string}
1537
- */
1538
- NodeTypeV0: "llm.responses" | "route.switch" | "join.all" | "join.any" | "join.collect" | "map.fanout" | "transform.json";
1539
- OutboundWebhookEvent: {
1540
- /** Format: int32 */
1541
- attempt_count?: number;
1542
- /** Format: date-time */
1543
- created_at?: string;
1544
- error?: string;
1545
- event_id?: string;
1546
- event_type?: string;
1547
- /** Format: uuid */
1548
- id?: string;
1549
- /** Format: date-time */
1550
- last_attempt_at?: string;
1551
- /** Format: int32 */
1552
- latency_ms?: number;
1553
- /** Format: date-time */
1554
- next_attempt_at?: string;
1555
- payload?: Record<string, never>;
1556
- response_body?: string;
1557
- /** Format: int32 */
1558
- response_status?: number;
1559
- status?: string;
1560
- /** Format: date-time */
1561
- updated_at?: string;
1562
- /** Format: uuid */
1563
- webhook_config_id?: string;
1564
- };
1565
- OutputFormat: {
1566
- json_schema?: components["schemas"]["JSONSchemaFormat"];
1567
- /** @enum {string} */
1568
- type: "text" | "json_schema";
1569
- };
1570
- OutputItem: {
1571
- content?: components["schemas"]["ContentPart"][];
1572
- role?: components["schemas"]["MessageRole"];
1573
- tool_calls?: components["schemas"]["ToolCall"][];
1574
- /** @enum {string} */
1575
- type: "message";
1576
- };
1577
- /** @description SHA-256 hash of the compiled workflow plan (64 hex characters). */
1578
- PlanHash: string;
1579
- PluginAgentV0: {
1580
- name: string;
1581
- system_prompt: string;
1582
- };
1583
- PluginCommandV0: {
1584
- agent_refs?: string[];
1585
- name: string;
1586
- prompt: string;
1587
- };
1588
- PluginGitHubRefV0: {
1589
- owner?: string;
1590
- path?: string;
1591
- ref?: string;
1592
- repo?: string;
1593
- };
1594
- PluginManifestV0: {
1595
- agents?: string[];
1596
- commands?: string[];
1597
- description?: string;
1598
- name?: string;
1599
- version?: string;
1600
- };
1601
- /**
1602
- * @description Billing interval for a tier.
1603
- * @enum {string}
1604
- */
1605
- PriceInterval: "month" | "year";
1606
- Project: {
1607
- billing_mode?: components["schemas"]["BillingMode"];
1608
- /** Format: date-time */
1609
- created_at?: string;
1610
- description?: string;
1611
- /** Format: uuid */
1612
- id?: string;
1613
- markup_percentage?: number;
1614
- name?: string;
1615
- /** Format: uuid */
1616
- owner_id?: string;
1617
- /** Format: date-time */
1618
- updated_at?: string;
1619
- };
1620
- /**
1621
- * @description LLM provider identifier.
1622
- * @enum {string}
1623
- */
1624
- ProviderId: "anthropic" | "openai" | "xai" | "google-ai-studio";
1625
- /**
1626
- * Format: uuid
1627
- * @description Unique identifier for an LLM request within a workflow run.
1628
- */
1629
- RequestId: string;
1630
- ResponsesBatchError: {
1631
- code?: string;
1632
- /** @description Raw error details from the provider */
1633
- detail?: string;
1634
- message: string;
1635
- status: number;
1636
- };
1637
- ResponsesBatchRequest: {
1638
- options?: {
1639
- abort_on_error?: boolean;
1640
- /** Format: uint32 */
1641
- max_parallelism?: number;
1642
- };
1643
- requests: components["schemas"]["ResponsesRequest"][];
1644
- };
1645
- ResponsesBatchResponse: {
1646
- request_id?: string;
1647
- results: components["schemas"]["ResponsesBatchResult"][];
1648
- };
1649
- ResponsesBatchResult: {
1650
- error?: components["schemas"]["ResponsesBatchError"];
1651
- /** Format: uint32 */
1652
- index: number;
1653
- ok: boolean;
1654
- response?: components["schemas"]["ResponsesResponse"];
1655
- };
1656
- ResponsesRequest: {
1657
- input: components["schemas"]["InputItem"][];
1658
- /** Format: uint32 */
1659
- max_output_tokens?: number;
1660
- model?: components["schemas"]["ModelId"];
1661
- output_format?: components["schemas"]["OutputFormat"];
1662
- provider?: components["schemas"]["ProviderId"];
1663
- stop?: string[];
1664
- temperature?: number;
1665
- tool_choice?: components["schemas"]["ToolChoice"];
1666
- tools?: components["schemas"]["Tool"][];
1667
- };
1668
- ResponsesResponse: {
1669
- /** @description Sources from web search results */
1670
- citations?: components["schemas"]["Citation"][];
1671
- /** @description Response identifier from the provider */
1672
- id: string;
1673
- model: components["schemas"]["ModelId"];
1674
- output: components["schemas"]["OutputItem"][];
1675
- provider?: components["schemas"]["ProviderId"];
1676
- /** @description Why generation stopped (stop, max_tokens, tool_use, etc.) */
1677
- stop_reason?: string;
1678
- usage: components["schemas"]["Usage"];
1679
- };
1680
- ResponsesStreamEnvelope: {
1681
- code?: string;
1682
- complete_fields?: string[];
1683
- content?: string;
1684
- delta?: string;
1685
- message?: string;
1686
- model?: components["schemas"]["ModelId"];
1687
- patch?: components["schemas"]["JSONPatchOperation"][];
1688
- payload?: {
1689
- [key: string]: unknown;
1690
- };
1691
- provider?: components["schemas"]["ProviderId"];
1692
- request_id?: string;
1693
- status?: number;
1694
- stop_reason?: string;
1695
- /** @enum {string} */
1696
- stream_mode?: "text-delta" | "structured-patch";
1697
- /** @enum {string} */
1698
- stream_version?: "v2";
1699
- /** @enum {string} */
1700
- type: "start" | "update" | "completion" | "error" | "keepalive" | "tool_use_start" | "tool_use_delta" | "tool_use_stop";
1701
- usage?: components["schemas"]["Usage"];
1702
- };
1703
- RunCostLineItemV0: {
1704
- /** Format: uint64 */
1705
- input_tokens: number;
1706
- model: components["schemas"]["ModelId"];
1707
- /** Format: uint64 */
1708
- output_tokens: number;
1709
- provider_id: components["schemas"]["ProviderId"];
1710
- /** Format: uint64 */
1711
- requests: number;
1712
- /** Format: uint64 */
1713
- usd_cents: number;
1714
- };
1715
- RunCostSummaryV0: {
1716
- line_items?: components["schemas"]["RunCostLineItemV0"][];
1717
- /** Format: uint64 */
1718
- total_usd_cents: number;
1719
- };
1720
- /**
1721
- * Format: uuid
1722
- * @description Unique identifier for a workflow run.
1723
- */
1724
- RunId: string;
1725
- /** @enum {string} */
1726
- RunStatusV0: "running" | "waiting" | "succeeded" | "failed" | "canceled";
1727
- RunsCreateOptionsV0: {
1728
- idempotency_key?: string;
1729
- };
1730
- RunsCreateRequest: {
1731
- /** @description Runtime inputs for the workflow. Required when the spec uses from_input references (e.g., map.fanout with items.from_input). Each key is the input name, and the value is the JSON data to provide. */
1732
- input?: {
1733
- [key: string]: unknown;
1734
- };
1735
- options?: components["schemas"]["RunsCreateOptionsV0"];
1736
- /**
1737
- * Format: uuid
1738
- * @description Optional session ID to link this run to a session.
1739
- */
1740
- session_id?: string;
1741
- spec: components["schemas"]["WorkflowSpecV0"] | components["schemas"]["WorkflowSpecV1"];
1742
- };
1743
- RunsCreateResponse: {
1744
- plan_hash: components["schemas"]["PlanHash"];
1745
- run_id: components["schemas"]["RunId"];
1746
- status: components["schemas"]["RunStatusV0"];
1747
- };
1748
- RunsGetResponse: {
1749
- cost_summary: components["schemas"]["RunCostSummaryV0"];
1750
- nodes?: components["schemas"]["NodeResultV0"][];
1751
- outputs?: {
1752
- [key: string]: unknown;
1753
- };
1754
- plan_hash: components["schemas"]["PlanHash"];
1755
- run_id: components["schemas"]["RunId"];
1756
- status: components["schemas"]["RunStatusV0"];
1757
- };
1758
- /** @description A pending tool call waiting for a result. */
1759
- RunsPendingToolCallV0: {
1760
- /** @description JSON-encoded arguments for the tool call */
1761
- arguments: string;
1762
- /** @description Name of the tool to be called */
1763
- name: components["schemas"]["ToolName"];
1764
- /** @description Unique identifier for this tool call */
1765
- tool_call_id: components["schemas"]["ToolCallId"];
1766
- };
1767
- /** @description A node with pending tool calls. */
1768
- RunsPendingToolsNodeV0: {
1769
- node_id: components["schemas"]["NodeId"];
1770
- request_id: components["schemas"]["RequestId"];
1771
- /**
1772
- * Format: uint64
1773
- * @description The step number within the node execution
1774
- */
1775
- step: number;
1776
- tool_calls?: components["schemas"]["RunsPendingToolCallV0"][];
1777
- };
1778
- /** @description Response containing pending tool calls for a workflow run. */
1779
- RunsPendingToolsResponse: {
1780
- pending?: components["schemas"]["RunsPendingToolsNodeV0"][];
1781
- run_id: components["schemas"]["RunId"];
1782
- };
1783
- /** @description Request body for creating a session. */
1784
- SessionCreateRequest: {
1785
- /**
1786
- * Format: uuid
1787
- * @description Optional customer ID to associate with the session
1788
- */
1789
- customer_id?: string;
1790
- /** @description Optional metadata for the session */
1791
- metadata?: {
1792
- [key: string]: unknown;
1793
- };
1794
- };
1795
- /** @description Paginated list of sessions. */
1796
- SessionListResponse: {
1797
- /** @description Cursor for fetching the next page (if more results exist) */
1798
- next_cursor?: string;
1799
- /** @description List of sessions */
1800
- sessions: components["schemas"]["SessionResponse"][];
1801
- };
1802
- /** @description Request body for appending a message to a session. */
1803
- SessionMessageCreateRequest: {
1804
- /** @description Message content parts */
1805
- content: {
1806
- [key: string]: unknown;
1807
- }[];
1808
- /** @description Message role (user, assistant, tool) */
1809
- role: string;
1810
- /**
1811
- * Format: uuid
1812
- * @description Run ID that generated this message (for assistant messages)
1813
- */
1814
- run_id?: string;
1815
- };
1816
- /** @description A message within a session. */
1817
- SessionMessageResponse: {
1818
- /** @description Message content parts */
1819
- content: {
1820
- [key: string]: unknown;
1821
- }[];
1822
- /**
1823
- * Format: date-time
1824
- * @description Message creation timestamp
1825
- */
1826
- created_at: string;
1827
- /**
1828
- * Format: uuid
1829
- * @description Message unique identifier
1830
- */
1831
- id: string;
1832
- /** @description Message role (user, assistant, tool) */
1833
- role: string;
1834
- /**
1835
- * Format: uuid
1836
- * @description Run ID that generated this message (for assistant messages)
1837
- */
1838
- run_id?: string;
1839
- /**
1840
- * Format: int32
1841
- * @description Sequence number within the session
1842
- */
1843
- seq: number;
1844
- };
1845
- /** @description A session resource. */
1846
- SessionResponse: {
1847
- /**
1848
- * Format: date-time
1849
- * @description Session creation timestamp
1850
- */
1851
- created_at: string;
1852
- /**
1853
- * Format: uuid
1854
- * @description Customer associated with the session (if any)
1855
- */
1856
- customer_id?: string;
1857
- /**
1858
- * Format: uuid
1859
- * @description Session unique identifier
1860
- */
1861
- id: string;
1862
- /**
1863
- * Format: int64
1864
- * @description Number of messages in the session
1865
- */
1866
- message_count: number;
1867
- /** @description Session metadata */
1868
- metadata: {
1869
- [key: string]: unknown;
1870
- };
1871
- /**
1872
- * Format: uuid
1873
- * @description Project the session belongs to
1874
- */
1875
- project_id: string;
1876
- /**
1877
- * Format: date-time
1878
- * @description Session last update timestamp
1879
- */
1880
- updated_at: string;
1881
- };
1882
- /** @description Request body for updating session metadata. Null values remove keys. */
1883
- SessionUpdateRequest: {
1884
- /** @description Metadata fields to set or remove */
1885
- metadata: {
1886
- [key: string]: unknown;
1887
- };
1888
- };
1889
- /** @description A session with its full message history. */
1890
- SessionWithMessagesResponse: components["schemas"]["SessionResponse"] & {
1891
- /** @description All messages in the session */
1892
- messages: components["schemas"]["SessionMessageResponse"][];
1893
- };
1894
- /** @description SHA-256 hash (64 hex characters). */
1895
- Sha256Hash: string;
1896
- Subscription: {
1897
- billing_provider?: components["schemas"]["BillingProvider"];
1898
- /** @description Billing subscription ID from the provider */
1899
- billing_subscription_id?: string;
1900
- /** Format: date-time */
1901
- created_at?: string;
1902
- /**
1903
- * Format: date-time
1904
- * @description End of the current billing period
1905
- */
1906
- current_period_end?: string;
1907
- /**
1908
- * Format: date-time
1909
- * @description Start of the current billing period
1910
- */
1911
- current_period_start?: string;
1912
- /** Format: uuid */
1913
- customer_id?: string;
1914
- /** Format: uuid */
1915
- id?: string;
1916
- /** Format: uuid */
1917
- project_id?: string;
1918
- subscription_status?: components["schemas"]["SubscriptionStatusKind"];
1919
- tier_code?: components["schemas"]["TierCode"];
1920
- /** Format: uuid */
1921
- tier_id?: string;
1922
- /** Format: date-time */
1923
- updated_at?: string;
1924
- };
1925
- /** @description Subscription status for a customer. */
1926
- SubscriptionStatus: {
1927
- /** @description Whether the subscription is currently active */
1928
- active: boolean;
1929
- /**
1930
- * Format: date-time
1931
- * @description End of the current billing period
1932
- */
1933
- current_period_end?: string;
1934
- /**
1935
- * Format: date-time
1936
- * @description Start of the current billing period
1937
- */
1938
- current_period_start?: string;
1939
- status?: components["schemas"]["SubscriptionStatusKind"];
1940
- /** @description Stripe subscription ID */
1941
- subscription_id?: string;
1942
- };
1943
- /**
1944
- * @description Subscription status (active, past_due, canceled, etc.)
1945
- * @enum {string}
1946
- */
1947
- SubscriptionStatusKind: "active" | "trialing" | "past_due" | "canceled" | "unpaid" | "incomplete" | "incomplete_expired" | "paused";
1948
- Tier: {
1949
- billing_mode?: components["schemas"]["TierBillingMode"];
1950
- /** @description Billing provider price reference for this tier */
1951
- billing_price_ref?: string;
1952
- billing_provider?: components["schemas"]["BillingProvider"];
1953
- /** Format: date-time */
1954
- created_at?: string;
1955
- /** @description Human-readable tier name */
1956
- display_name?: string;
1957
- /** Format: uuid */
1958
- id?: string;
1959
- models?: components["schemas"]["TierModel"][];
1960
- /**
1961
- * Format: uint64
1962
- * @description Subscription price amount in cents
1963
- */
1964
- price_amount_cents?: number;
1965
- /** @description Currency code for the price (e.g., 'usd') */
1966
- price_currency?: string;
1967
- price_interval?: components["schemas"]["PriceInterval"];
1968
- /** Format: uuid */
1969
- project_id?: string;
1970
- /**
1971
- * Format: uint64
1972
- * @description Monthly spend limit in cents (e.g., 2000 = $20/month). Must be non-negative.
1973
- */
1974
- spend_limit_cents?: number;
1975
- tier_code?: components["schemas"]["TierCode"];
1976
- /**
1977
- * Format: uint32
1978
- * @description Number of trial days for new subscriptions
1979
- */
1980
- trial_days?: number;
1981
- /** Format: date-time */
1982
- updated_at?: string;
1983
- };
1984
- /**
1985
- * @description Billing mode for a tier. 'subscription' uses monthly spend limits; 'paygo' uses prepaid balances.
1986
- * @enum {string}
1987
- */
1988
- TierBillingMode: "subscription" | "paygo";
1989
- /** @description Tier code identifier (e.g., free, pro, enterprise). */
1990
- TierCode: string;
1991
- TierCreate: {
1992
- billing_mode?: components["schemas"]["TierBillingMode"];
1993
- billing_provider?: components["schemas"]["BillingProvider"];
1994
- /** @description Human-readable tier name */
1995
- display_name: string;
1996
- models: components["schemas"]["TierModelCreate"][];
1997
- /**
1998
- * Format: uint64
1999
- * @description Subscription price amount in cents (paid tiers)
2000
- */
2001
- price_amount_cents?: number;
2002
- price_interval?: components["schemas"]["PriceInterval"];
2003
- /**
2004
- * Format: uint64
2005
- * @description Monthly spend limit in cents (e.g., 2000 = $20/month). Must be non-negative.
2006
- */
2007
- spend_limit_cents: number;
2008
- tier_code: components["schemas"]["TierCode"];
2009
- /**
2010
- * Format: uint32
2011
- * @description Number of trial days for new subscriptions (paid tiers)
2012
- */
2013
- trial_days?: number;
2014
- };
2015
- TierModel: {
2016
- /** @description Workflow-critical capability flags for the model */
2017
- capabilities: components["schemas"]["ModelCapability"][];
2018
- /**
2019
- * Format: int32
2020
- * @description Maximum supported context window in tokens (if known)
2021
- */
2022
- context_window: number;
2023
- /** Format: date-time */
2024
- created_at: string;
2025
- /** @description Whether the model is deprecated */
2026
- deprecated: boolean;
2027
- /** @description Human-friendly description of what the model is good at */
2028
- description: string;
2029
- /** Format: uuid */
2030
- id: string;
2031
- /** @description Whether this is the default model for the tier */
2032
- is_default: boolean;
2033
- /**
2034
- * Format: int32
2035
- * @description Maximum supported output tokens (if known)
2036
- */
2037
- max_output_tokens: number;
2038
- /** @description Human-friendly model name resolved from pricing (e.g., 'GPT-4o Mini') */
2039
- model_display_name: string;
2040
- model_id: components["schemas"]["ModelId"];
2041
- /**
2042
- * Format: int64
2043
- * @description Provider input cost in cents per million tokens. Customer price is derived as cost * (1 + platformFeePercent/100).
2044
- */
2045
- model_input_cost_cents: number;
2046
- /**
2047
- * Format: int64
2048
- * @description Provider output cost in cents per million tokens. Customer price is derived as cost * (1 + platformFeePercent/100).
2049
- */
2050
- model_output_cost_cents: number;
2051
- /** Format: uuid */
2052
- tier_id: string;
2053
- /** Format: date-time */
2054
- updated_at: string;
2055
- };
2056
- /** @description Model to add to a tier. Pricing is derived from the model_pricing table. */
2057
- TierModelCreate: {
2058
- /** @default false */
2059
- is_default: boolean;
2060
- model_id: components["schemas"]["ModelId"];
2061
- };
2062
- TierUpdate: {
2063
- billing_provider?: components["schemas"]["BillingProvider"];
2064
- /** @description Human-readable tier name */
2065
- display_name: string;
2066
- models?: components["schemas"]["TierModelCreate"][];
2067
- /**
2068
- * Format: uint64
2069
- * @description Subscription price amount in cents (paid tiers)
2070
- */
2071
- price_amount_cents?: number;
2072
- price_interval?: components["schemas"]["PriceInterval"];
2073
- /**
2074
- * Format: uint64
2075
- * @description Monthly spend limit in cents (e.g., 2000 = $20/month). Must be non-negative.
2076
- */
2077
- spend_limit_cents: number;
2078
- tier_code: components["schemas"]["TierCode"];
2079
- /**
2080
- * Format: uint32
2081
- * @description Number of trial days for new subscriptions (paid tiers)
2082
- */
2083
- trial_days?: number;
2084
- };
2085
- Tool: {
2086
- code_execution?: {
2087
- [key: string]: unknown;
2088
- };
2089
- function?: {
2090
- description?: string;
2091
- name?: components["schemas"]["ToolName"];
2092
- parameters?: {
2093
- [key: string]: unknown;
2094
- };
2095
- };
2096
- /** @description Configuration for server-side image generation tool */
2097
- image_generation?: {
2098
- /** @description Image generation model ID (e.g., gemini-2.5-flash-image) */
2099
- model: string;
2100
- };
2101
- /** @enum {string} */
2102
- type: "function" | "web" | "x_search" | "code_execution" | "image_generation";
2103
- web?: {
2104
- [key: string]: unknown;
2105
- };
2106
- x_search?: {
2107
- [key: string]: unknown;
2108
- };
2109
- };
2110
- ToolCall: {
2111
- function?: {
2112
- /** @description JSON string of function arguments */
2113
- arguments?: string;
2114
- name?: components["schemas"]["ToolName"];
2115
- };
2116
- id: components["schemas"]["ToolCallId"];
2117
- /** @enum {string} */
2118
- type: "function" | "web" | "x_search" | "code_execution" | "image_generation";
2119
- };
2120
- /** @description Incremental tool call data during streaming */
2121
- ToolCallDelta: {
2122
- function?: {
2123
- /** @description Partial JSON string */
2124
- arguments?: string;
2125
- name?: components["schemas"]["ToolName"];
2126
- };
2127
- id?: components["schemas"]["ToolCallId"];
2128
- /** Format: uint32 */
2129
- index?: number;
2130
- type?: string;
2131
- };
2132
- /** @description Unique identifier for a tool call. Treated as an opaque string and must be preserved exactly. */
2133
- ToolCallId: string;
2134
- ToolChoice: {
2135
- function?: components["schemas"]["ToolName"];
2136
- /** @enum {string} */
2137
- type: "auto" | "required" | "none";
2138
- };
2139
- ToolHookConfig: {
2140
- allow_mutation?: boolean;
2141
- /** Format: date-time */
2142
- created_at?: string;
2143
- enabled?: boolean;
2144
- /** Format: uri */
2145
- endpoint_url?: string;
2146
- /** @enum {string} */
2147
- fail_behavior?: "fail_closed" | "fail_open";
2148
- /** @enum {string} */
2149
- hook_type?: "pre_tool_use" | "post_tool_use" | "tool_execute";
2150
- /** Format: uuid */
2151
- id?: string;
2152
- /** Format: uuid */
2153
- project_id?: string;
2154
- /** Format: int32 */
2155
- timeout_ms?: number;
2156
- tools_allowlist?: string[];
2157
- /** Format: date-time */
2158
- updated_at?: string;
2159
- };
2160
- ToolHookConfigInput: {
2161
- allow_mutation?: boolean;
2162
- enabled?: boolean;
2163
- /** Format: uri */
2164
- endpoint_url: string;
2165
- /** @enum {string} */
2166
- fail_behavior?: "fail_closed" | "fail_open";
2167
- /** @enum {string} */
2168
- hook_type: "pre_tool_use" | "post_tool_use" | "tool_execute";
2169
- /** Format: int32 */
2170
- timeout_ms?: number;
2171
- tools_allowlist?: string[];
2172
- };
2173
- ToolHookConfigUpdate: {
2174
- allow_mutation?: boolean;
2175
- enabled?: boolean;
2176
- /** Format: uri */
2177
- endpoint_url?: string;
2178
- /** @enum {string} */
2179
- fail_behavior?: "fail_closed" | "fail_open";
2180
- rotate_secret?: boolean;
2181
- /** Format: int32 */
2182
- timeout_ms?: number;
2183
- tools_allowlist?: string[];
2184
- };
2185
- ToolHookEvent: {
2186
- /** Format: date-time */
2187
- created_at?: string;
2188
- error?: string;
2189
- /** Format: uuid */
2190
- hook_config_id?: string;
2191
- /** Format: uuid */
2192
- id?: string;
2193
- /** Format: int32 */
2194
- latency_ms?: number;
2195
- request_id?: string;
2196
- response_body?: string;
2197
- /** Format: int32 */
2198
- response_status?: number;
2199
- /** @enum {string} */
2200
- status?: "success" | "blocked" | "timeout" | "error";
2201
- tool_call_id?: string;
2202
- };
2203
- ToolHookTestResult: {
2204
- error?: string;
2205
- /** Format: int32 */
2206
- latency_ms?: number;
2207
- response_body?: string;
2208
- /** Format: int32 */
2209
- response_status?: number;
2210
- /** @enum {string} */
2211
- status?: "success" | "blocked" | "timeout" | "error";
2212
- };
2213
- /** @description Tool identifier. For tools.v0 client tools, use dot-separated lowercase segments (e.g. fs.search). */
2214
- ToolName: string;
2215
- /** @description Token usage statistics. All fields default to 0 if not present. */
2216
- Usage: {
2217
- /**
2218
- * Format: uint64
2219
- * @default 0
2220
- */
2221
- input_tokens: number;
2222
- /**
2223
- * Format: uint64
2224
- * @default 0
2225
- */
2226
- output_tokens: number;
2227
- /**
2228
- * Format: uint64
2229
- * @default 0
2230
- */
2231
- total_tokens: number;
2232
- };
2233
- User: {
2234
- /** Format: email */
2235
- email?: string;
2236
- /** Format: uuid */
2237
- id?: string;
2238
- /** Format: uuid */
2239
- project_id?: string;
2240
- };
2241
- WebhookConfig: {
2242
- /** Format: date-time */
2243
- created_at?: string;
2244
- enabled?: boolean;
2245
- /** Format: uri */
2246
- endpoint_url?: string;
2247
- events?: ("customer.created" | "customer.updated" | "customer.deleted" | "usage.threshold_exceeded" | "request.completed" | "billing.subscription_changed")[];
2248
- /** Format: uuid */
2249
- id?: string;
2250
- /** Format: uuid */
2251
- project_id?: string;
2252
- signing_secret?: string;
2253
- /** Format: date-time */
2254
- updated_at?: string;
2255
- };
2256
- WebhookConfigInput: {
2257
- enabled?: boolean;
2258
- /** Format: uri */
2259
- endpoint_url: string;
2260
- events: ("customer.created" | "customer.updated" | "customer.deleted" | "usage.threshold_exceeded" | "request.completed" | "billing.subscription_changed")[];
2261
- };
2262
- WebhookConfigUpdate: {
2263
- enabled?: boolean;
2264
- /** Format: uri */
2265
- endpoint_url: string;
2266
- events: ("customer.created" | "customer.updated" | "customer.deleted" | "usage.threshold_exceeded" | "request.completed" | "billing.subscription_changed")[];
2267
- rotate_secret?: boolean;
2268
- };
2269
- WebhookTestResult: {
2270
- error?: string;
2271
- /** Format: int32 */
2272
- latency_ms?: number;
2273
- response_body?: string;
2274
- /** Format: int32 */
2275
- response_status?: number;
2276
- /** @enum {string} */
2277
- status?: "delivered" | "failed";
2278
- };
2279
- /** @description A `workflow.v0` spec. The canonical JSON Schema is available at `/schemas/workflow_v0.schema.json`. */
2280
- WorkflowSpecV0: {
2281
- [key: string]: unknown;
2282
- };
2283
- /** @description A `workflow.v1` spec. The canonical JSON Schema is available at `/schemas/workflow_v1.schema.json`. */
2284
- WorkflowSpecV1: {
2285
- [key: string]: unknown;
2286
- };
2287
- };
2288
- responses: never;
2289
- parameters: {
2290
- ProjectID: string;
2291
- ToolHookID: string;
2292
- WebhookID: string;
2293
- };
2294
- requestBodies: never;
2295
- headers: never;
2296
- pathItems: never;
2297
- }
2298
- type $defs = Record<string, never>;
2299
- interface operations {
2300
- mintCustomerToken: {
2301
- parameters: {
2302
- query?: never;
2303
- header?: never;
2304
- path?: never;
2305
- cookie?: never;
2306
- };
2307
- requestBody: {
2308
- content: {
2309
- "application/json": {
2310
- /** @description External customer identifier (provide exactly one of customer_id or customer_external_id) */
2311
- customer_external_id?: string;
2312
- /**
2313
- * Format: uuid
2314
- * @description Internal customer UUID (provide exactly one of customer_id or customer_external_id)
2315
- */
2316
- customer_id?: string;
2317
- /**
2318
- * Format: uint32
2319
- * @description Requested token TTL in seconds (server may cap this)
2320
- */
2321
- ttl_seconds?: number;
2322
- };
2323
- };
2324
- };
2325
- responses: {
2326
- /** @description Customer token issued */
2327
- 200: {
2328
- headers: {
2329
- [name: string]: unknown;
2330
- };
2331
- content: {
2332
- "application/json": components["schemas"]["CustomerTokenResponse"];
2333
- };
2334
- };
2335
- /** @description Invalid request (missing or invalid customer selector) */
2336
- 400: {
2337
- headers: {
2338
- [name: string]: unknown;
2339
- };
2340
- content?: never;
2341
- };
2342
- /** @description Invalid or missing secret key */
2343
- 401: {
2344
- headers: {
2345
- [name: string]: unknown;
2346
- };
2347
- content?: never;
2348
- };
2349
- /** @description Customer not found */
2350
- 404: {
2351
- headers: {
2352
- [name: string]: unknown;
2353
- };
2354
- content?: never;
2355
- };
2356
- };
2357
- };
2358
- login: {
2359
- parameters: {
2360
- query?: never;
2361
- header?: never;
2362
- path?: never;
2363
- cookie?: never;
2364
- };
2365
- requestBody: {
2366
- content: {
2367
- "application/json": {
2368
- /** Format: email */
2369
- email?: string;
2370
- password?: string;
2371
- };
2372
- };
2373
- };
2374
- responses: {
2375
- /** @description Tokens issued */
2376
- 200: {
2377
- headers: {
2378
- [name: string]: unknown;
2379
- };
2380
- content: {
2381
- "application/json": components["schemas"]["AuthResponse"];
2382
- };
2383
- };
2384
- };
2385
- };
2386
- logout: {
2387
- parameters: {
2388
- query?: never;
2389
- header?: never;
2390
- path?: never;
2391
- cookie?: never;
2392
- };
2393
- requestBody: {
2394
- content: {
2395
- "application/json": {
2396
- refresh_token?: string;
2397
- };
2398
- };
2399
- };
2400
- responses: {
2401
- /** @description Session revoked */
2402
- 204: {
2403
- headers: {
2404
- [name: string]: unknown;
2405
- };
2406
- content?: never;
2407
- };
2408
- };
2409
- };
2410
- getAuthenticatedUser: {
2411
- parameters: {
2412
- query?: never;
2413
- header?: never;
2414
- path?: never;
2415
- cookie?: never;
2416
- };
2417
- requestBody?: never;
2418
- responses: {
2419
- /** @description Current user */
2420
- 200: {
2421
- headers: {
2422
- [name: string]: unknown;
2423
- };
2424
- content: {
2425
- "application/json": {
2426
- user?: components["schemas"]["User"];
2427
- };
2428
- };
2429
- };
2430
- };
2431
- };
2432
- refreshToken: {
2433
- parameters: {
2434
- query?: never;
2435
- header?: never;
2436
- path?: never;
2437
- cookie?: never;
2438
- };
2439
- requestBody: {
2440
- content: {
2441
- "application/json": {
2442
- refresh_token?: string;
2443
- };
2444
- };
2445
- };
2446
- responses: {
2447
- /** @description Tokens refreshed */
2448
- 200: {
2449
- headers: {
2450
- [name: string]: unknown;
2451
- };
2452
- content: {
2453
- "application/json": components["schemas"]["AuthTokens"];
2454
- };
2455
- };
2456
- };
2457
- };
2458
- registerOwner: {
2459
- parameters: {
2460
- query?: never;
2461
- header?: never;
2462
- path?: never;
2463
- cookie?: never;
2464
- };
2465
- requestBody: {
2466
- content: {
2467
- "application/json": {
2468
- billing_provider?: components["schemas"]["BillingProvider"];
2469
- /** Format: email */
2470
- email?: string;
2471
- password?: string;
2472
- };
2473
- };
2474
- };
2475
- responses: {
2476
- /** @description User created */
2477
- 201: {
2478
- headers: {
2479
- [name: string]: unknown;
2480
- };
2481
- content: {
2482
- "application/json": components["schemas"]["AuthResponse"];
2483
- };
2484
- };
2485
- };
2486
- };
2487
- listCustomers: {
2488
- parameters: {
2489
- query?: never;
2490
- header?: never;
2491
- path?: never;
2492
- cookie?: never;
2493
- };
2494
- requestBody?: never;
2495
- responses: {
2496
- /** @description Customer list */
2497
- 200: {
2498
- headers: {
2499
- [name: string]: unknown;
2500
- };
2501
- content: {
2502
- "application/json": {
2503
- customers?: components["schemas"]["CustomerWithSubscription"][];
2504
- };
2505
- };
2506
- };
2507
- };
2508
- };
2509
- upsertCustomer: {
2510
- parameters: {
2511
- query?: never;
2512
- header?: never;
2513
- path?: never;
2514
- cookie?: never;
2515
- };
2516
- requestBody: {
2517
- content: {
2518
- "application/json": components["schemas"]["CustomerCreate"];
2519
- };
2520
- };
2521
- responses: {
2522
- /** @description Customer updated */
2523
- 200: {
2524
- headers: {
2525
- [name: string]: unknown;
2526
- };
2527
- content: {
2528
- "application/json": {
2529
- customer?: components["schemas"]["CustomerWithSubscription"];
2530
- };
2531
- };
2532
- };
2533
- /** @description Customer created */
2534
- 201: {
2535
- headers: {
2536
- [name: string]: unknown;
2537
- };
2538
- content: {
2539
- "application/json": {
2540
- customer?: components["schemas"]["CustomerWithSubscription"];
2541
- };
2542
- };
2543
- };
2544
- };
2545
- };
2546
- createProjectCustomer: {
2547
- parameters: {
2548
- query?: never;
2549
- header?: never;
2550
- path?: never;
2551
- cookie?: never;
2552
- };
2553
- requestBody: {
2554
- content: {
2555
- "application/json": components["schemas"]["CustomerCreate"];
2556
- };
2557
- };
2558
- responses: {
2559
- /** @description Customer created */
2560
- 201: {
2561
- headers: {
2562
- [name: string]: unknown;
2563
- };
2564
- content: {
2565
- "application/json": {
2566
- customer?: components["schemas"]["CustomerWithSubscription"];
2567
- };
2568
- };
2569
- };
2570
- };
2571
- };
2572
- getCustomerMe: {
2573
- parameters: {
2574
- query?: never;
2575
- header?: never;
2576
- path?: never;
2577
- cookie?: never;
2578
- };
2579
- requestBody?: never;
2580
- responses: {
2581
- /** @description Customer details */
2582
- 200: {
2583
- headers: {
2584
- [name: string]: unknown;
2585
- };
2586
- content: {
2587
- "application/json": components["schemas"]["CustomerMeResponse"];
2588
- };
2589
- };
2590
- /** @description Unauthorized */
2591
- 401: {
2592
- headers: {
2593
- [name: string]: unknown;
2594
- };
2595
- content?: never;
2596
- };
2597
- };
2598
- };
2599
- getCustomerMeBalance: {
2600
- parameters: {
2601
- query?: never;
2602
- header?: never;
2603
- path?: never;
2604
- cookie?: never;
2605
- };
2606
- requestBody?: never;
2607
- responses: {
2608
- /** @description PAYGO balance */
2609
- 200: {
2610
- headers: {
2611
- [name: string]: unknown;
2612
- };
2613
- content: {
2614
- "application/json": components["schemas"]["CustomerBalanceResponse"];
2615
- };
2616
- };
2617
- /** @description Subscription is not PAYGO */
2618
- 400: {
2619
- headers: {
2620
- [name: string]: unknown;
2621
- };
2622
- content?: never;
2623
- };
2624
- /** @description Unauthorized */
2625
- 401: {
2626
- headers: {
2627
- [name: string]: unknown;
2628
- };
2629
- content?: never;
2630
- };
2631
- /** @description Customer or subscription not found */
2632
- 404: {
2633
- headers: {
2634
- [name: string]: unknown;
2635
- };
2636
- content?: never;
2637
- };
2638
- /** @description Service unavailable */
2639
- 503: {
2640
- headers: {
2641
- [name: string]: unknown;
2642
- };
2643
- content?: never;
2644
- };
2645
- };
2646
- };
2647
- getCustomerMeBalanceHistory: {
2648
- parameters: {
2649
- query?: {
2650
- limit?: number;
2651
- offset?: number;
2652
- };
2653
- header?: never;
2654
- path?: never;
2655
- cookie?: never;
2656
- };
2657
- requestBody?: never;
2658
- responses: {
2659
- /** @description Ledger entries */
2660
- 200: {
2661
- headers: {
2662
- [name: string]: unknown;
2663
- };
2664
- content: {
2665
- "application/json": components["schemas"]["CustomerLedgerResponse"];
2666
- };
2667
- };
2668
- /** @description Unauthorized */
2669
- 401: {
2670
- headers: {
2671
- [name: string]: unknown;
2672
- };
2673
- content?: never;
2674
- };
2675
- /** @description Customer not found */
2676
- 404: {
2677
- headers: {
2678
- [name: string]: unknown;
2679
- };
2680
- content?: never;
2681
- };
2682
- /** @description Service unavailable */
2683
- 503: {
2684
- headers: {
2685
- [name: string]: unknown;
2686
- };
2687
- content?: never;
2688
- };
2689
- };
2690
- };
2691
- changeCustomerMeTier: {
2692
- parameters: {
2693
- query?: never;
2694
- header?: never;
2695
- path?: never;
2696
- cookie?: never;
2697
- };
2698
- requestBody: {
2699
- content: {
2700
- "application/json": components["schemas"]["ChangeTierRequest"];
2701
- };
2702
- };
2703
- responses: {
2704
- /** @description Tier changed successfully */
2705
- 200: {
2706
- headers: {
2707
- [name: string]: unknown;
2708
- };
2709
- content: {
2710
- "application/json": components["schemas"]["CustomerMeSubscriptionResponse"];
2711
- };
2712
- };
2713
- /** @description Invalid request (missing tier_code, same tier, or PAYGO subscription) */
2714
- 400: {
2715
- headers: {
2716
- [name: string]: unknown;
2717
- };
2718
- content?: never;
2719
- };
2720
- /** @description Unauthorized */
2721
- 401: {
2722
- headers: {
2723
- [name: string]: unknown;
2724
- };
2725
- content?: never;
2726
- };
2727
- /** @description No payment method on file (required for free-to-paid upgrade) */
2728
- 402: {
2729
- headers: {
2730
- [name: string]: unknown;
2731
- };
2732
- content?: never;
2733
- };
2734
- /** @description Customer or tier not found */
2735
- 404: {
2736
- headers: {
2737
- [name: string]: unknown;
2738
- };
2739
- content?: never;
2740
- };
2741
- /** @description Billing provider mismatch */
2742
- 409: {
2743
- headers: {
2744
- [name: string]: unknown;
2745
- };
2746
- content?: never;
2747
- };
2748
- /** @description Service unavailable */
2749
- 503: {
2750
- headers: {
2751
- [name: string]: unknown;
2752
- };
2753
- content?: never;
2754
- };
2755
- };
2756
- };
2757
- createCustomerMeCheckout: {
2758
- parameters: {
2759
- query?: never;
2760
- header?: never;
2761
- path?: never;
2762
- cookie?: never;
2763
- };
2764
- requestBody: {
2765
- content: {
2766
- "application/json": components["schemas"]["CustomerMeCheckoutRequest"];
2767
- };
2768
- };
2769
- responses: {
2770
- /** @description Checkout session created successfully */
2771
- 200: {
2772
- headers: {
2773
- [name: string]: unknown;
2774
- };
2775
- content: {
2776
- "application/json": components["schemas"]["CheckoutSessionResponse"];
2777
- };
2778
- };
2779
- /** @description Invalid request (missing or invalid tier_code, success_url, or cancel_url) */
2780
- 400: {
2781
- headers: {
2782
- [name: string]: unknown;
2783
- };
2784
- content?: never;
2785
- };
2786
- /** @description Unauthorized */
2787
- 401: {
2788
- headers: {
2789
- [name: string]: unknown;
2790
- };
2791
- content?: never;
2792
- };
2793
- /** @description Customer or tier not found */
2794
- 404: {
2795
- headers: {
2796
- [name: string]: unknown;
2797
- };
2798
- content?: never;
2799
- };
2800
- /** @description Tier has no billing pricing configured */
2801
- 409: {
2802
- headers: {
2803
- [name: string]: unknown;
2804
- };
2805
- content?: never;
2806
- };
2807
- /** @description Billing not configured */
2808
- 503: {
2809
- headers: {
2810
- [name: string]: unknown;
2811
- };
2812
- content?: never;
2813
- };
2814
- };
2815
- };
2816
- getCustomerMeSubscription: {
2817
- parameters: {
2818
- query?: never;
2819
- header?: never;
2820
- path?: never;
2821
- cookie?: never;
2822
- };
2823
- requestBody?: never;
2824
- responses: {
2825
- /** @description Subscription details */
2826
- 200: {
2827
- headers: {
2828
- [name: string]: unknown;
2829
- };
2830
- content: {
2831
- "application/json": components["schemas"]["CustomerMeSubscriptionResponse"];
2832
- };
2833
- };
2834
- /** @description Unauthorized */
2835
- 401: {
2836
- headers: {
2837
- [name: string]: unknown;
2838
- };
2839
- content?: never;
2840
- };
2841
- /** @description Customer or tier not found */
2842
- 404: {
2843
- headers: {
2844
- [name: string]: unknown;
2845
- };
2846
- content?: never;
2847
- };
2848
- /** @description Internal server error */
2849
- 500: {
2850
- headers: {
2851
- [name: string]: unknown;
2852
- };
2853
- content?: never;
2854
- };
2855
- /** @description Service unavailable */
2856
- 503: {
2857
- headers: {
2858
- [name: string]: unknown;
2859
- };
2860
- content?: never;
2861
- };
2862
- };
2863
- };
2864
- createCustomerMeTopup: {
2865
- parameters: {
2866
- query?: never;
2867
- header?: never;
2868
- path?: never;
2869
- cookie?: never;
2870
- };
2871
- requestBody: {
2872
- content: {
2873
- "application/json": components["schemas"]["CustomerTopupRequest"];
2874
- };
2875
- };
2876
- responses: {
2877
- /** @description Checkout session created */
2878
- 201: {
2879
- headers: {
2880
- [name: string]: unknown;
2881
- };
2882
- content: {
2883
- "application/json": components["schemas"]["CustomerTopupResponse"];
2884
- };
2885
- };
2886
- /** @description Invalid request */
2887
- 400: {
2888
- headers: {
2889
- [name: string]: unknown;
2890
- };
2891
- content?: never;
2892
- };
2893
- /** @description Unauthorized */
2894
- 401: {
2895
- headers: {
2896
- [name: string]: unknown;
2897
- };
2898
- content?: never;
2899
- };
2900
- /** @description Customer not found */
2901
- 404: {
2902
- headers: {
2903
- [name: string]: unknown;
2904
- };
2905
- content?: never;
2906
- };
2907
- /** @description Service unavailable */
2908
- 503: {
2909
- headers: {
2910
- [name: string]: unknown;
2911
- };
2912
- content?: never;
2913
- };
2914
- };
2915
- };
2916
- getCustomerMeUsage: {
2917
- parameters: {
2918
- query?: never;
2919
- header?: never;
2920
- path?: never;
2921
- cookie?: never;
2922
- };
2923
- requestBody?: never;
2924
- responses: {
2925
- /** @description Usage summary */
2926
- 200: {
2927
- headers: {
2928
- [name: string]: unknown;
2929
- };
2930
- content: {
2931
- "application/json": components["schemas"]["CustomerMeUsageResponse"];
2932
- };
2933
- };
2934
- /** @description Unauthorized */
2935
- 401: {
2936
- headers: {
2937
- [name: string]: unknown;
2938
- };
2939
- content?: never;
2940
- };
2941
- /** @description Customer not found */
2942
- 404: {
2943
- headers: {
2944
- [name: string]: unknown;
2945
- };
2946
- content?: never;
2947
- };
2948
- /** @description Failed to calculate usage */
2949
- 500: {
2950
- headers: {
2951
- [name: string]: unknown;
2952
- };
2953
- content?: never;
2954
- };
2955
- /** @description Service unavailable */
2956
- 503: {
2957
- headers: {
2958
- [name: string]: unknown;
2959
- };
2960
- content?: never;
2961
- };
2962
- };
2963
- };
2964
- getCustomer: {
2965
- parameters: {
2966
- query?: never;
2967
- header?: never;
2968
- path: {
2969
- customer_id: string;
2970
- };
2971
- cookie?: never;
2972
- };
2973
- requestBody?: never;
2974
- responses: {
2975
- /** @description Customer */
2976
- 200: {
2977
- headers: {
2978
- [name: string]: unknown;
2979
- };
2980
- content: {
2981
- "application/json": {
2982
- customer?: components["schemas"]["CustomerWithSubscription"];
2983
- };
2984
- };
2985
- };
2986
- /** @description Customer not found */
2987
- 404: {
2988
- headers: {
2989
- [name: string]: unknown;
2990
- };
2991
- content?: never;
2992
- };
2993
- };
2994
- };
2995
- deleteProjectCustomer: {
2996
- parameters: {
2997
- query?: never;
2998
- header?: never;
2999
- path: {
3000
- customer_id: string;
3001
- };
3002
- cookie?: never;
3003
- };
3004
- requestBody?: never;
3005
- responses: {
3006
- /** @description Customer deleted */
3007
- 204: {
3008
- headers: {
3009
- [name: string]: unknown;
3010
- };
3011
- content?: never;
3012
- };
3013
- /** @description Customer not found */
3014
- 404: {
3015
- headers: {
3016
- [name: string]: unknown;
3017
- };
3018
- content?: never;
3019
- };
3020
- };
3021
- };
3022
- getCustomerBalance: {
3023
- parameters: {
3024
- query?: never;
3025
- header?: never;
3026
- path: {
3027
- customer_id: string;
3028
- };
3029
- cookie?: never;
3030
- };
3031
- requestBody?: never;
3032
- responses: {
3033
- /** @description PAYGO balance */
3034
- 200: {
3035
- headers: {
3036
- [name: string]: unknown;
3037
- };
3038
- content: {
3039
- "application/json": components["schemas"]["CustomerBalanceResponse"];
3040
- };
3041
- };
3042
- /** @description Subscription is not PAYGO */
3043
- 400: {
3044
- headers: {
3045
- [name: string]: unknown;
3046
- };
3047
- content?: never;
3048
- };
3049
- /** @description Customer or subscription not found */
3050
- 404: {
3051
- headers: {
3052
- [name: string]: unknown;
3053
- };
3054
- content?: never;
3055
- };
3056
- /** @description Service unavailable */
3057
- 503: {
3058
- headers: {
3059
- [name: string]: unknown;
3060
- };
3061
- content?: never;
3062
- };
3063
- };
3064
- };
3065
- getCustomerBalanceHistory: {
3066
- parameters: {
3067
- query?: {
3068
- limit?: number;
3069
- offset?: number;
3070
- };
3071
- header?: never;
3072
- path: {
3073
- customer_id: string;
3074
- };
3075
- cookie?: never;
3076
- };
3077
- requestBody?: never;
3078
- responses: {
3079
- /** @description Ledger entries */
3080
- 200: {
3081
- headers: {
3082
- [name: string]: unknown;
3083
- };
3084
- content: {
3085
- "application/json": components["schemas"]["CustomerLedgerResponse"];
3086
- };
3087
- };
3088
- /** @description Customer not found */
3089
- 404: {
3090
- headers: {
3091
- [name: string]: unknown;
3092
- };
3093
- content?: never;
3094
- };
3095
- /** @description Service unavailable */
3096
- 503: {
3097
- headers: {
3098
- [name: string]: unknown;
3099
- };
3100
- content?: never;
3101
- };
3102
- };
3103
- };
3104
- subscribeCustomer: {
3105
- parameters: {
3106
- query?: never;
3107
- header?: never;
3108
- path: {
3109
- customer_id: string;
3110
- };
3111
- cookie?: never;
3112
- };
3113
- requestBody: {
3114
- content: {
3115
- "application/json": {
3116
- /** Format: uri */
3117
- cancel_url: string;
3118
- /** Format: uri */
3119
- success_url: string;
3120
- /** Format: uuid */
3121
- tier_id: string;
3122
- };
3123
- };
3124
- };
3125
- responses: {
3126
- /** @description Checkout session created */
3127
- 201: {
3128
- headers: {
3129
- [name: string]: unknown;
3130
- };
3131
- content: {
3132
- "application/json": components["schemas"]["CheckoutSessionResponse"];
3133
- };
3134
- };
3135
- };
3136
- };
3137
- getCustomerSubscription: {
3138
- parameters: {
3139
- query?: never;
3140
- header?: never;
3141
- path: {
3142
- customer_id: string;
3143
- };
3144
- cookie?: never;
3145
- };
3146
- requestBody?: never;
3147
- responses: {
3148
- /** @description Subscription details */
3149
- 200: {
3150
- headers: {
3151
- [name: string]: unknown;
3152
- };
3153
- content: {
3154
- "application/json": {
3155
- subscription?: components["schemas"]["Subscription"];
3156
- };
3157
- };
3158
- };
3159
- /** @description Subscription not found */
3160
- 404: {
3161
- headers: {
3162
- [name: string]: unknown;
3163
- };
3164
- content?: never;
3165
- };
3166
- };
3167
- };
3168
- cancelCustomerSubscription: {
3169
- parameters: {
3170
- query?: never;
3171
- header?: never;
3172
- path: {
3173
- customer_id: string;
3174
- };
3175
- cookie?: never;
3176
- };
3177
- requestBody?: never;
3178
- responses: {
3179
- /** @description Subscription canceled */
3180
- 204: {
3181
- headers: {
3182
- [name: string]: unknown;
3183
- };
3184
- content?: never;
3185
- };
3186
- };
3187
- };
3188
- createCustomerTopup: {
3189
- parameters: {
3190
- query?: never;
3191
- header?: never;
3192
- path: {
3193
- customer_id: string;
3194
- };
3195
- cookie?: never;
3196
- };
3197
- requestBody: {
3198
- content: {
3199
- "application/json": components["schemas"]["CustomerTopupRequest"];
3200
- };
3201
- };
3202
- responses: {
3203
- /** @description Checkout session created */
3204
- 201: {
3205
- headers: {
3206
- [name: string]: unknown;
3207
- };
3208
- content: {
3209
- "application/json": components["schemas"]["CustomerTopupResponse"];
3210
- };
3211
- };
3212
- /** @description Invalid request */
3213
- 400: {
3214
- headers: {
3215
- [name: string]: unknown;
3216
- };
3217
- content?: never;
3218
- };
3219
- /** @description Customer not found */
3220
- 404: {
3221
- headers: {
3222
- [name: string]: unknown;
3223
- };
3224
- content?: never;
3225
- };
3226
- /** @description Service unavailable */
3227
- 503: {
3228
- headers: {
3229
- [name: string]: unknown;
3230
- };
3231
- content?: never;
3232
- };
3233
- };
3234
- };
3235
- generateImage: {
3236
- parameters: {
3237
- query?: never;
3238
- header?: never;
3239
- path?: never;
3240
- cookie?: never;
3241
- };
3242
- requestBody: {
3243
- content: {
3244
- "application/json": components["schemas"]["ImageRequest"];
3245
- };
3246
- };
3247
- responses: {
3248
- /** @description Generated images */
3249
- 200: {
3250
- headers: {
3251
- [name: string]: unknown;
3252
- };
3253
- content: {
3254
- "application/json": components["schemas"]["ImageResponse"];
3255
- };
3256
- };
3257
- };
3258
- };
3259
- getImage: {
3260
- parameters: {
3261
- query?: never;
3262
- header?: never;
3263
- path: {
3264
- /** @description Image ID */
3265
- image_id: string;
3266
- };
3267
- cookie?: never;
3268
- };
3269
- requestBody?: never;
3270
- responses: {
3271
- /** @description Image details */
3272
- 200: {
3273
- headers: {
3274
- [name: string]: unknown;
3275
- };
3276
- content: {
3277
- "application/json": components["schemas"]["ImagePinResponse"];
3278
- };
3279
- };
3280
- /** @description Image not found */
3281
- 404: {
3282
- headers: {
3283
- [name: string]: unknown;
3284
- };
3285
- content?: never;
3286
- };
3287
- };
3288
- };
3289
- pinImage: {
3290
- parameters: {
3291
- query?: never;
3292
- header?: never;
3293
- path: {
3294
- /** @description Image ID */
3295
- image_id: string;
3296
- };
3297
- cookie?: never;
3298
- };
3299
- requestBody?: never;
3300
- responses: {
3301
- /** @description Image pinned successfully */
3302
- 200: {
3303
- headers: {
3304
- [name: string]: unknown;
3305
- };
3306
- content: {
3307
- "application/json": components["schemas"]["ImagePinResponse"];
3308
- };
3309
- };
3310
- /** @description Quota exceeded */
3311
- 403: {
3312
- headers: {
3313
- [name: string]: unknown;
3314
- };
3315
- content?: never;
3316
- };
3317
- /** @description Image not found */
3318
- 404: {
3319
- headers: {
3320
- [name: string]: unknown;
3321
- };
3322
- content?: never;
3323
- };
3324
- /** @description Image has expired */
3325
- 410: {
3326
- headers: {
3327
- [name: string]: unknown;
3328
- };
3329
- content?: never;
3330
- };
3331
- };
3332
- };
3333
- unpinImage: {
3334
- parameters: {
3335
- query?: never;
3336
- header?: never;
3337
- path: {
3338
- /** @description Image ID */
3339
- image_id: string;
3340
- };
3341
- cookie?: never;
3342
- };
3343
- requestBody?: never;
3344
- responses: {
3345
- /** @description Image unpinned successfully */
3346
- 200: {
3347
- headers: {
3348
- [name: string]: unknown;
3349
- };
3350
- content: {
3351
- "application/json": components["schemas"]["ImagePinResponse"];
3352
- };
3353
- };
3354
- /** @description Image not found */
3355
- 404: {
3356
- headers: {
3357
- [name: string]: unknown;
3358
- };
3359
- content?: never;
3360
- };
3361
- };
3362
- };
3363
- listModels: {
3364
- parameters: {
3365
- query?: {
3366
- /** @description Filter results to a specific provider */
3367
- provider?: components["schemas"]["ProviderId"];
3368
- /** @description Filter results to models that support a capability */
3369
- capability?: components["schemas"]["ModelCapability"];
3370
- };
3371
- header?: never;
3372
- path?: never;
3373
- cookie?: never;
3374
- };
3375
- requestBody?: never;
3376
- responses: {
3377
- /** @description Models list */
3378
- 200: {
3379
- headers: {
3380
- [name: string]: unknown;
3381
- };
3382
- content: {
3383
- "application/json": components["schemas"]["ModelsResponse"];
3384
- };
3385
- };
3386
- };
3387
- };
3388
- listProjects: {
3389
- parameters: {
3390
- query?: never;
3391
- header?: never;
3392
- path?: never;
3393
- cookie?: never;
3394
- };
3395
- requestBody?: never;
3396
- responses: {
3397
- /** @description Project list */
3398
- 200: {
3399
- headers: {
3400
- [name: string]: unknown;
3401
- };
3402
- content: {
3403
- "application/json": {
3404
- projects?: components["schemas"]["Project"][];
3405
- };
3406
- };
3407
- };
3408
- };
3409
- };
3410
- createProject: {
3411
- parameters: {
3412
- query?: never;
3413
- header?: never;
3414
- path?: never;
3415
- cookie?: never;
3416
- };
3417
- requestBody: {
3418
- content: {
3419
- "application/json": {
3420
- description?: string;
3421
- markup_percentage?: number;
3422
- name?: string;
3423
- };
3424
- };
3425
- };
3426
- responses: {
3427
- /** @description Project created */
3428
- 201: {
3429
- headers: {
3430
- [name: string]: unknown;
3431
- };
3432
- content: {
3433
- "application/json": {
3434
- project?: components["schemas"]["Project"];
3435
- };
3436
- };
3437
- };
3438
- };
3439
- };
3440
- getProject: {
3441
- parameters: {
3442
- query?: never;
3443
- header?: never;
3444
- path: {
3445
- id: components["parameters"]["ProjectID"];
3446
- };
3447
- cookie?: never;
3448
- };
3449
- requestBody?: never;
3450
- responses: {
3451
- /** @description Project found */
3452
- 200: {
3453
- headers: {
3454
- [name: string]: unknown;
3455
- };
3456
- content: {
3457
- "application/json": {
3458
- project?: components["schemas"]["Project"];
3459
- };
3460
- };
3461
- };
3462
- };
3463
- };
3464
- updateProject: {
3465
- parameters: {
3466
- query?: never;
3467
- header?: never;
3468
- path: {
3469
- id: components["parameters"]["ProjectID"];
3470
- };
3471
- cookie?: never;
3472
- };
3473
- requestBody: {
3474
- content: {
3475
- "application/json": {
3476
- billing_mode?: components["schemas"]["BillingMode"];
3477
- description?: string;
3478
- markup_percentage?: number;
3479
- name?: string;
3480
- };
3481
- };
3482
- };
3483
- responses: {
3484
- /** @description Project updated */
3485
- 200: {
3486
- headers: {
3487
- [name: string]: unknown;
3488
- };
3489
- content: {
3490
- "application/json": {
3491
- project?: components["schemas"]["Project"];
3492
- };
3493
- };
3494
- };
3495
- };
3496
- };
3497
- deleteProject: {
3498
- parameters: {
3499
- query?: never;
3500
- header?: never;
3501
- path: {
3502
- id: components["parameters"]["ProjectID"];
3503
- };
3504
- cookie?: never;
3505
- };
3506
- requestBody?: never;
3507
- responses: {
3508
- /** @description Project deleted */
3509
- 204: {
3510
- headers: {
3511
- [name: string]: unknown;
3512
- };
3513
- content?: never;
3514
- };
3515
- };
3516
- };
3517
- listProjectCustomers: {
3518
- parameters: {
3519
- query?: never;
3520
- header?: never;
3521
- path: {
3522
- id: components["parameters"]["ProjectID"];
3523
- };
3524
- cookie?: never;
3525
- };
3526
- requestBody?: never;
3527
- responses: {
3528
- /** @description Customer list */
3529
- 200: {
3530
- headers: {
3531
- [name: string]: unknown;
3532
- };
3533
- content: {
3534
- "application/json": {
3535
- customers?: components["schemas"]["CustomerWithSubscription"][];
3536
- };
3537
- };
3538
- };
3539
- };
3540
- };
3541
- createCustomer: {
3542
- parameters: {
3543
- query?: never;
3544
- header?: never;
3545
- path: {
3546
- id: components["parameters"]["ProjectID"];
3547
- };
3548
- cookie?: never;
3549
- };
3550
- requestBody: {
3551
- content: {
3552
- "application/json": components["schemas"]["CustomerCreate"];
3553
- };
3554
- };
3555
- responses: {
3556
- /** @description Customer created */
3557
- 201: {
3558
- headers: {
3559
- [name: string]: unknown;
3560
- };
3561
- content: {
3562
- "application/json": {
3563
- customer?: components["schemas"]["CustomerWithSubscription"];
3564
- };
3565
- };
3566
- };
3567
- };
3568
- };
3569
- deleteCustomer: {
3570
- parameters: {
3571
- query?: never;
3572
- header?: never;
3573
- path: {
3574
- id: components["parameters"]["ProjectID"];
3575
- customer_id: string;
3576
- };
3577
- cookie?: never;
3578
- };
3579
- requestBody?: never;
3580
- responses: {
3581
- /** @description Customer deleted */
3582
- 204: {
3583
- headers: {
3584
- [name: string]: unknown;
3585
- };
3586
- content?: never;
3587
- };
3588
- };
3589
- };
3590
- listProjectTiers: {
3591
- parameters: {
3592
- query?: never;
3593
- header?: never;
3594
- path: {
3595
- id: components["parameters"]["ProjectID"];
3596
- };
3597
- cookie?: never;
3598
- };
3599
- requestBody?: never;
3600
- responses: {
3601
- /** @description Tier list */
3602
- 200: {
3603
- headers: {
3604
- [name: string]: unknown;
3605
- };
3606
- content: {
3607
- "application/json": {
3608
- tiers?: components["schemas"]["Tier"][];
3609
- };
3610
- };
3611
- };
3612
- };
3613
- };
3614
- createTier: {
3615
- parameters: {
3616
- query?: never;
3617
- header?: never;
3618
- path: {
3619
- id: components["parameters"]["ProjectID"];
3620
- };
3621
- cookie?: never;
3622
- };
3623
- requestBody: {
3624
- content: {
3625
- "application/json": components["schemas"]["TierCreate"];
3626
- };
3627
- };
3628
- responses: {
3629
- /** @description Tier created */
3630
- 201: {
3631
- headers: {
3632
- [name: string]: unknown;
3633
- };
3634
- content: {
3635
- "application/json": {
3636
- tier?: components["schemas"]["Tier"];
3637
- };
3638
- };
3639
- };
3640
- };
3641
- };
3642
- updateTier: {
3643
- parameters: {
3644
- query?: never;
3645
- header?: never;
3646
- path: {
3647
- id: components["parameters"]["ProjectID"];
3648
- tier_id: string;
3649
- };
3650
- cookie?: never;
3651
- };
3652
- requestBody: {
3653
- content: {
3654
- "application/json": components["schemas"]["TierUpdate"];
3655
- };
3656
- };
3657
- responses: {
3658
- /** @description Tier updated */
3659
- 200: {
3660
- headers: {
3661
- [name: string]: unknown;
3662
- };
3663
- content?: never;
3664
- };
3665
- };
3666
- };
3667
- deleteTier: {
3668
- parameters: {
3669
- query?: never;
3670
- header?: never;
3671
- path: {
3672
- id: components["parameters"]["ProjectID"];
3673
- tier_id: string;
3674
- };
3675
- cookie?: never;
3676
- };
3677
- requestBody?: never;
3678
- responses: {
3679
- /** @description Tier deleted */
3680
- 204: {
3681
- headers: {
3682
- [name: string]: unknown;
3683
- };
3684
- content?: never;
3685
- };
3686
- };
3687
- };
3688
- listProjectToolHooks: {
3689
- parameters: {
3690
- query?: never;
3691
- header?: never;
3692
- path: {
3693
- id: components["parameters"]["ProjectID"];
3694
- };
3695
- cookie?: never;
3696
- };
3697
- requestBody?: never;
3698
- responses: {
3699
- /** @description Tool hook list */
3700
- 200: {
3701
- headers: {
3702
- [name: string]: unknown;
3703
- };
3704
- content: {
3705
- "application/json": {
3706
- hooks?: components["schemas"]["ToolHookConfig"][];
3707
- };
3708
- };
3709
- };
3710
- };
3711
- };
3712
- createProjectToolHook: {
3713
- parameters: {
3714
- query?: never;
3715
- header?: never;
3716
- path: {
3717
- id: components["parameters"]["ProjectID"];
3718
- };
3719
- cookie?: never;
3720
- };
3721
- requestBody: {
3722
- content: {
3723
- "application/json": components["schemas"]["ToolHookConfigInput"];
3724
- };
3725
- };
3726
- responses: {
3727
- /** @description Tool hook created */
3728
- 201: {
3729
- headers: {
3730
- [name: string]: unknown;
3731
- };
3732
- content: {
3733
- "application/json": {
3734
- hook?: components["schemas"]["ToolHookConfig"];
3735
- signing_secret?: string;
3736
- };
3737
- };
3738
- };
3739
- };
3740
- };
3741
- getProjectToolHook: {
3742
- parameters: {
3743
- query?: never;
3744
- header?: never;
3745
- path: {
3746
- id: components["parameters"]["ProjectID"];
3747
- hook_id: components["parameters"]["ToolHookID"];
3748
- };
3749
- cookie?: never;
3750
- };
3751
- requestBody?: never;
3752
- responses: {
3753
- /** @description Tool hook details */
3754
- 200: {
3755
- headers: {
3756
- [name: string]: unknown;
3757
- };
3758
- content: {
3759
- "application/json": {
3760
- hook?: components["schemas"]["ToolHookConfig"];
3761
- };
3762
- };
3763
- };
3764
- };
3765
- };
3766
- updateProjectToolHook: {
3767
- parameters: {
3768
- query?: never;
3769
- header?: never;
3770
- path: {
3771
- id: components["parameters"]["ProjectID"];
3772
- hook_id: components["parameters"]["ToolHookID"];
3773
- };
3774
- cookie?: never;
3775
- };
3776
- requestBody: {
3777
- content: {
3778
- "application/json": components["schemas"]["ToolHookConfigUpdate"];
3779
- };
3780
- };
3781
- responses: {
3782
- /** @description Tool hook updated */
3783
- 200: {
3784
- headers: {
3785
- [name: string]: unknown;
3786
- };
3787
- content: {
3788
- "application/json": {
3789
- hook?: components["schemas"]["ToolHookConfig"];
3790
- signing_secret?: string;
3791
- };
3792
- };
3793
- };
3794
- };
3795
- };
3796
- deleteProjectToolHook: {
3797
- parameters: {
3798
- query?: never;
3799
- header?: never;
3800
- path: {
3801
- id: components["parameters"]["ProjectID"];
3802
- hook_id: components["parameters"]["ToolHookID"];
3803
- };
3804
- cookie?: never;
3805
- };
3806
- requestBody?: never;
3807
- responses: {
3808
- /** @description Tool hook deleted */
3809
- 204: {
3810
- headers: {
3811
- [name: string]: unknown;
3812
- };
3813
- content?: never;
3814
- };
3815
- };
3816
- };
3817
- listProjectToolHookEvents: {
3818
- parameters: {
3819
- query?: {
3820
- limit?: number;
3821
- };
3822
- header?: never;
3823
- path: {
3824
- id: components["parameters"]["ProjectID"];
3825
- hook_id: components["parameters"]["ToolHookID"];
3826
- };
3827
- cookie?: never;
3828
- };
3829
- requestBody?: never;
3830
- responses: {
3831
- /** @description Tool hook events */
3832
- 200: {
3833
- headers: {
3834
- [name: string]: unknown;
3835
- };
3836
- content: {
3837
- "application/json": {
3838
- events?: components["schemas"]["ToolHookEvent"][];
3839
- };
3840
- };
3841
- };
3842
- };
3843
- };
3844
- testProjectToolHook: {
3845
- parameters: {
3846
- query?: never;
3847
- header?: never;
3848
- path: {
3849
- id: components["parameters"]["ProjectID"];
3850
- hook_id: components["parameters"]["ToolHookID"];
3851
- };
3852
- cookie?: never;
3853
- };
3854
- requestBody?: never;
3855
- responses: {
3856
- /** @description Tool hook test result */
3857
- 200: {
3858
- headers: {
3859
- [name: string]: unknown;
3860
- };
3861
- content: {
3862
- "application/json": components["schemas"]["ToolHookTestResult"];
3863
- };
3864
- };
3865
- /** @description Tool hook test failed */
3866
- 502: {
3867
- headers: {
3868
- [name: string]: unknown;
3869
- };
3870
- content?: never;
3871
- };
3872
- };
3873
- };
3874
- listProjectWebhooks: {
3875
- parameters: {
3876
- query?: never;
3877
- header?: never;
3878
- path: {
3879
- id: components["parameters"]["ProjectID"];
3880
- };
3881
- cookie?: never;
3882
- };
3883
- requestBody?: never;
3884
- responses: {
3885
- /** @description Webhook list */
3886
- 200: {
3887
- headers: {
3888
- [name: string]: unknown;
3889
- };
3890
- content: {
3891
- "application/json": {
3892
- webhooks?: components["schemas"]["WebhookConfig"][];
3893
- };
3894
- };
3895
- };
3896
- };
3897
- };
3898
- createProjectWebhook: {
3899
- parameters: {
3900
- query?: never;
3901
- header?: never;
3902
- path: {
3903
- id: components["parameters"]["ProjectID"];
3904
- };
3905
- cookie?: never;
3906
- };
3907
- requestBody: {
3908
- content: {
3909
- "application/json": components["schemas"]["WebhookConfigInput"];
3910
- };
3911
- };
3912
- responses: {
3913
- /** @description Webhook created */
3914
- 201: {
3915
- headers: {
3916
- [name: string]: unknown;
3917
- };
3918
- content: {
3919
- "application/json": {
3920
- webhook?: components["schemas"]["WebhookConfig"];
3921
- };
3922
- };
3923
- };
3924
- };
3925
- };
3926
- getProjectWebhook: {
3927
- parameters: {
3928
- query?: never;
3929
- header?: never;
3930
- path: {
3931
- id: components["parameters"]["ProjectID"];
3932
- webhook_id: components["parameters"]["WebhookID"];
3933
- };
3934
- cookie?: never;
3935
- };
3936
- requestBody?: never;
3937
- responses: {
3938
- /** @description Webhook details */
3939
- 200: {
3940
- headers: {
3941
- [name: string]: unknown;
3942
- };
3943
- content: {
3944
- "application/json": {
3945
- webhook?: components["schemas"]["WebhookConfig"];
3946
- };
3947
- };
3948
- };
3949
- };
3950
- };
3951
- updateProjectWebhook: {
3952
- parameters: {
3953
- query?: never;
3954
- header?: never;
3955
- path: {
3956
- id: components["parameters"]["ProjectID"];
3957
- webhook_id: components["parameters"]["WebhookID"];
3958
- };
3959
- cookie?: never;
3960
- };
3961
- requestBody: {
3962
- content: {
3963
- "application/json": components["schemas"]["WebhookConfigUpdate"];
3964
- };
3965
- };
3966
- responses: {
3967
- /** @description Webhook updated */
3968
- 200: {
3969
- headers: {
3970
- [name: string]: unknown;
3971
- };
3972
- content: {
3973
- "application/json": {
3974
- webhook?: components["schemas"]["WebhookConfig"];
3975
- };
3976
- };
3977
- };
3978
- };
3979
- };
3980
- deleteProjectWebhook: {
3981
- parameters: {
3982
- query?: never;
3983
- header?: never;
3984
- path: {
3985
- id: components["parameters"]["ProjectID"];
3986
- webhook_id: components["parameters"]["WebhookID"];
3987
- };
3988
- cookie?: never;
3989
- };
3990
- requestBody?: never;
3991
- responses: {
3992
- /** @description Webhook deleted */
3993
- 204: {
3994
- headers: {
3995
- [name: string]: unknown;
3996
- };
3997
- content?: never;
3998
- };
3999
- };
4000
- };
4001
- listProjectWebhookEvents: {
4002
- parameters: {
4003
- query?: {
4004
- limit?: number;
4005
- offset?: number;
4006
- event_type?: string;
4007
- status?: string;
4008
- };
4009
- header?: never;
4010
- path: {
4011
- id: components["parameters"]["ProjectID"];
4012
- webhook_id: components["parameters"]["WebhookID"];
4013
- };
4014
- cookie?: never;
4015
- };
4016
- requestBody?: never;
4017
- responses: {
4018
- /** @description Webhook events */
4019
- 200: {
4020
- headers: {
4021
- [name: string]: unknown;
4022
- };
4023
- content: {
4024
- "application/json": {
4025
- events?: components["schemas"]["OutboundWebhookEvent"][];
4026
- next_cursor?: string;
4027
- };
4028
- };
4029
- };
4030
- };
4031
- };
4032
- testProjectWebhook: {
4033
- parameters: {
4034
- query?: never;
4035
- header?: never;
4036
- path: {
4037
- id: components["parameters"]["ProjectID"];
4038
- webhook_id: components["parameters"]["WebhookID"];
4039
- };
4040
- cookie?: never;
4041
- };
4042
- requestBody?: {
4043
- content: {
4044
- "application/json": {
4045
- event_type?: string;
4046
- };
4047
- };
4048
- };
4049
- responses: {
4050
- /** @description Webhook test result */
4051
- 200: {
4052
- headers: {
4053
- [name: string]: unknown;
4054
- };
4055
- content: {
4056
- "application/json": components["schemas"]["WebhookTestResult"];
4057
- };
4058
- };
4059
- /** @description Webhook test failed */
4060
- 502: {
4061
- headers: {
4062
- [name: string]: unknown;
4063
- };
4064
- content?: never;
4065
- };
4066
- };
4067
- };
4068
- createResponse: {
4069
- parameters: {
4070
- query?: never;
4071
- header?: never;
4072
- path?: never;
4073
- cookie?: never;
4074
- };
4075
- requestBody: {
4076
- content: {
4077
- "application/json": components["schemas"]["ResponsesRequest"];
4078
- };
4079
- };
4080
- responses: {
4081
- /** @description Response */
4082
- 200: {
4083
- headers: {
4084
- [name: string]: unknown;
4085
- };
4086
- content: {
4087
- "application/json": components["schemas"]["ResponsesResponse"];
4088
- };
4089
- };
4090
- };
4091
- };
4092
- createResponsesBatch: {
4093
- parameters: {
4094
- query?: never;
4095
- header?: never;
4096
- path?: never;
4097
- cookie?: never;
4098
- };
4099
- requestBody: {
4100
- content: {
4101
- "application/json": components["schemas"]["ResponsesBatchRequest"];
4102
- };
4103
- };
4104
- responses: {
4105
- /** @description Batch response results */
4106
- 200: {
4107
- headers: {
4108
- [name: string]: unknown;
4109
- };
4110
- content: {
4111
- "application/json": components["schemas"]["ResponsesBatchResponse"];
4112
- };
4113
- };
4114
- };
4115
- };
4116
- createRun: {
4117
- parameters: {
4118
- query?: never;
4119
- header?: never;
4120
- path?: never;
4121
- cookie?: never;
4122
- };
4123
- requestBody: {
4124
- content: {
4125
- "application/json": components["schemas"]["RunsCreateRequest"];
4126
- };
4127
- };
4128
- responses: {
4129
- /** @description Run created (or idempotent replay) */
4130
- 200: {
4131
- headers: {
4132
- [name: string]: unknown;
4133
- };
4134
- content: {
4135
- "application/json": components["schemas"]["RunsCreateResponse"];
4136
- };
4137
- };
4138
- };
4139
- };
4140
- getRun: {
4141
- parameters: {
4142
- query?: never;
4143
- header?: never;
4144
- path: {
4145
- run_id: string;
4146
- };
4147
- cookie?: never;
4148
- };
4149
- requestBody?: never;
4150
- responses: {
4151
- /** @description Run snapshot */
4152
- 200: {
4153
- headers: {
4154
- [name: string]: unknown;
4155
- };
4156
- content: {
4157
- "application/json": components["schemas"]["RunsGetResponse"];
4158
- };
4159
- };
4160
- /** @description Run not found */
4161
- 404: {
4162
- headers: {
4163
- [name: string]: unknown;
4164
- };
4165
- content?: never;
4166
- };
4167
- };
4168
- };
4169
- streamRunEvents: {
4170
- parameters: {
4171
- query?: {
4172
- /** @description Returns events where `seq > after_seq`. */
4173
- after_seq?: number;
4174
- /** @description When false, returns currently available events then closes. */
4175
- wait?: boolean;
4176
- /** @description Maximum number of events to send before closing. */
4177
- limit?: number;
4178
- };
4179
- header?: never;
4180
- path: {
4181
- run_id: string;
4182
- };
4183
- cookie?: never;
4184
- };
4185
- requestBody?: never;
4186
- responses: {
4187
- /** @description Event stream (NDJSON or SSE) */
4188
- 200: {
4189
- headers: {
4190
- [name: string]: unknown;
4191
- };
4192
- content: {
4193
- /**
4194
- * @example {"envelope_version":"v0","seq":1,"type":"run_compiled",...}
4195
- * {"envelope_version":"v0","seq":2,"type":"run_started",...}
4196
- */
4197
- "application/x-ndjson": string;
4198
- /**
4199
- * @example event: run_started
4200
- * id: 2
4201
- * data: {"envelope_version":"v0","seq":2,"type":"run_started",...}
4202
- */
4203
- "text/event-stream": string;
4204
- };
4205
- };
4206
- };
4207
- };
4208
- getRunEventV0Schema: {
4209
- parameters: {
4210
- query?: never;
4211
- header?: never;
4212
- path?: never;
4213
- cookie?: never;
4214
- };
4215
- requestBody?: never;
4216
- responses: {
4217
- /** @description Schema document */
4218
- 200: {
4219
- headers: {
4220
- [name: string]: unknown;
4221
- };
4222
- content: {
4223
- "application/schema+json": Record<string, never>;
4224
- };
4225
- };
4226
- };
4227
- };
4228
- getWorkflowV0Schema: {
4229
- parameters: {
4230
- query?: never;
4231
- header?: never;
4232
- path?: never;
4233
- cookie?: never;
4234
- };
4235
- requestBody?: never;
4236
- responses: {
4237
- /** @description Schema document */
4238
- 200: {
4239
- headers: {
4240
- [name: string]: unknown;
4241
- };
4242
- content: {
4243
- "application/schema+json": Record<string, never>;
4244
- };
4245
- };
4246
- };
4247
- };
4248
- getWorkflowV1Schema: {
4249
- parameters: {
4250
- query?: never;
4251
- header?: never;
4252
- path?: never;
4253
- cookie?: never;
4254
- };
4255
- requestBody?: never;
4256
- responses: {
4257
- /** @description Schema document */
4258
- 200: {
4259
- headers: {
4260
- [name: string]: unknown;
4261
- };
4262
- content: {
4263
- "application/schema+json": Record<string, never>;
4264
- };
4265
- };
4266
- };
4267
- };
4268
- listSessions: {
4269
- parameters: {
4270
- query?: {
4271
- /** @description Maximum number of sessions to return */
4272
- limit?: number;
4273
- /** @description Number of sessions to skip */
4274
- offset?: number;
4275
- /** @description Filter sessions by customer ID */
4276
- customer_id?: string;
4277
- };
4278
- header?: never;
4279
- path?: never;
4280
- cookie?: never;
4281
- };
4282
- requestBody?: never;
4283
- responses: {
4284
- /** @description Session list */
4285
- 200: {
4286
- headers: {
4287
- [name: string]: unknown;
4288
- };
4289
- content: {
4290
- "application/json": components["schemas"]["SessionListResponse"];
4291
- };
4292
- };
4293
- /** @description API key required */
4294
- 401: {
4295
- headers: {
4296
- [name: string]: unknown;
4297
- };
4298
- content?: never;
4299
- };
4300
- };
4301
- };
4302
- createSession: {
4303
- parameters: {
4304
- query?: never;
4305
- header?: never;
4306
- path?: never;
4307
- cookie?: never;
4308
- };
4309
- requestBody: {
4310
- content: {
4311
- "application/json": components["schemas"]["SessionCreateRequest"];
4312
- };
4313
- };
4314
- responses: {
4315
- /** @description Session created */
4316
- 201: {
4317
- headers: {
4318
- [name: string]: unknown;
4319
- };
4320
- content: {
4321
- "application/json": components["schemas"]["SessionResponse"];
4322
- };
4323
- };
4324
- /** @description Invalid request */
4325
- 400: {
4326
- headers: {
4327
- [name: string]: unknown;
4328
- };
4329
- content?: never;
4330
- };
4331
- /** @description API key required */
4332
- 401: {
4333
- headers: {
4334
- [name: string]: unknown;
4335
- };
4336
- content?: never;
4337
- };
4338
- };
4339
- };
4340
- getSession: {
4341
- parameters: {
4342
- query?: never;
4343
- header?: never;
4344
- path: {
4345
- session_id: string;
4346
- };
4347
- cookie?: never;
4348
- };
4349
- requestBody?: never;
4350
- responses: {
4351
- /** @description Session with messages */
4352
- 200: {
4353
- headers: {
4354
- [name: string]: unknown;
4355
- };
4356
- content: {
4357
- "application/json": components["schemas"]["SessionWithMessagesResponse"];
4358
- };
4359
- };
4360
- /** @description Session not found */
4361
- 404: {
4362
- headers: {
4363
- [name: string]: unknown;
4364
- };
4365
- content?: never;
4366
- };
4367
- };
4368
- };
4369
- deleteSession: {
4370
- parameters: {
4371
- query?: never;
4372
- header?: never;
4373
- path: {
4374
- session_id: string;
4375
- };
4376
- cookie?: never;
4377
- };
4378
- requestBody?: never;
4379
- responses: {
4380
- /** @description Session deleted */
4381
- 204: {
4382
- headers: {
4383
- [name: string]: unknown;
4384
- };
4385
- content?: never;
4386
- };
4387
- /** @description Secret key required for deletion */
4388
- 403: {
4389
- headers: {
4390
- [name: string]: unknown;
4391
- };
4392
- content?: never;
4393
- };
4394
- /** @description Session not found */
4395
- 404: {
4396
- headers: {
4397
- [name: string]: unknown;
4398
- };
4399
- content?: never;
4400
- };
4401
- };
4402
- };
4403
- updateSession: {
4404
- parameters: {
4405
- query?: never;
4406
- header?: never;
4407
- path: {
4408
- session_id: string;
4409
- };
4410
- cookie?: never;
4411
- };
4412
- requestBody: {
4413
- content: {
4414
- "application/json": components["schemas"]["SessionUpdateRequest"];
4415
- };
4416
- };
4417
- responses: {
4418
- /** @description Session updated */
4419
- 200: {
4420
- headers: {
4421
- [name: string]: unknown;
4422
- };
4423
- content: {
4424
- "application/json": components["schemas"]["SessionResponse"];
4425
- };
4426
- };
4427
- /** @description Invalid request */
4428
- 400: {
4429
- headers: {
4430
- [name: string]: unknown;
4431
- };
4432
- content?: never;
4433
- };
4434
- /** @description API key required */
4435
- 401: {
4436
- headers: {
4437
- [name: string]: unknown;
4438
- };
4439
- content?: never;
4440
- };
4441
- /** @description Session not found */
4442
- 404: {
4443
- headers: {
4444
- [name: string]: unknown;
4445
- };
4446
- content?: never;
4447
- };
4448
- };
4449
- };
4450
- clearSession: {
4451
- parameters: {
4452
- query?: never;
4453
- header?: never;
4454
- path: {
4455
- session_id: string;
4456
- };
4457
- cookie?: never;
4458
- };
4459
- requestBody?: never;
4460
- responses: {
4461
- /** @description Session cleared */
4462
- 200: {
4463
- headers: {
4464
- [name: string]: unknown;
4465
- };
4466
- content: {
4467
- "application/json": components["schemas"]["SessionResponse"];
4468
- };
4469
- };
4470
- /** @description API key required */
4471
- 401: {
4472
- headers: {
4473
- [name: string]: unknown;
4474
- };
4475
- content?: never;
4476
- };
4477
- /** @description Session not found */
4478
- 404: {
4479
- headers: {
4480
- [name: string]: unknown;
4481
- };
4482
- content?: never;
4483
- };
4484
- };
4485
- };
4486
- addSessionMessage: {
4487
- parameters: {
4488
- query?: never;
4489
- header?: never;
4490
- path: {
4491
- session_id: string;
4492
- };
4493
- cookie?: never;
4494
- };
4495
- requestBody: {
4496
- content: {
4497
- "application/json": components["schemas"]["SessionMessageCreateRequest"];
4498
- };
4499
- };
4500
- responses: {
4501
- /** @description Message appended */
4502
- 201: {
4503
- headers: {
4504
- [name: string]: unknown;
4505
- };
4506
- content: {
4507
- "application/json": components["schemas"]["SessionMessageResponse"];
4508
- };
4509
- };
4510
- /** @description Invalid request */
4511
- 400: {
4512
- headers: {
4513
- [name: string]: unknown;
4514
- };
4515
- content?: never;
4516
- };
4517
- /** @description API key required */
4518
- 401: {
4519
- headers: {
4520
- [name: string]: unknown;
4521
- };
4522
- content?: never;
4523
- };
4524
- /** @description Session not found */
4525
- 404: {
4526
- headers: {
4527
- [name: string]: unknown;
4528
- };
4529
- content?: never;
4530
- };
4531
- };
4532
- };
4533
- }
4534
-
4535
- export type { $defs as $, components as c, operations as o, paths as p, webhooks as w };