@upon-ai/sdk 0.1.1 → 0.1.3

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 (10) hide show
  1. package/README.md +22 -2
  2. package/dist/client.js +5 -4
  3. package/dist/index.d.ts +35 -0
  4. package/dist/index.js +35 -0
  5. package/dist/metadata.d.ts +1101 -0
  6. package/dist/metadata.js +1243 -0
  7. package/dist/schema.d.ts +7199 -2680
  8. package/dist/version.d.ts +1 -1
  9. package/dist/version.js +1 -1
  10. package/package.json +1 -1
package/dist/metadata.js CHANGED
@@ -2138,5 +2138,1248 @@ export const metadata = {
2138
2138
  "bodySchema": {
2139
2139
  "$ref": "#/components/schemas/CallActionWorkspaceRequest"
2140
2140
  }
2141
+ },
2142
+ "listVoiceSimulationTemplates": {
2143
+ "path": "/api/v1/voice-simulations/templates",
2144
+ "method": "get",
2145
+ "summary": "List voice simulation templates",
2146
+ "parameters": [
2147
+ {
2148
+ "name": "workspaceId",
2149
+ "in": "query",
2150
+ "required": true,
2151
+ "schema": {
2152
+ "type": "integer"
2153
+ },
2154
+ "description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
2155
+ }
2156
+ ],
2157
+ "bodyRequired": false,
2158
+ "bodyType": null,
2159
+ "bodySchema": null
2160
+ },
2161
+ "getVoiceSimulationSettings": {
2162
+ "path": "/api/v1/voice-simulations/settings",
2163
+ "method": "get",
2164
+ "summary": "Get voice simulation access and prices",
2165
+ "parameters": [
2166
+ {
2167
+ "name": "workspaceId",
2168
+ "in": "query",
2169
+ "required": true,
2170
+ "schema": {
2171
+ "type": "integer"
2172
+ },
2173
+ "description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
2174
+ }
2175
+ ],
2176
+ "bodyRequired": false,
2177
+ "bodyType": null,
2178
+ "bodySchema": null
2179
+ },
2180
+ "listVoiceSimulationSourceAgents": {
2181
+ "path": "/api/v1/voice-simulations/agents",
2182
+ "method": "get",
2183
+ "summary": "List editable simulation source agents",
2184
+ "parameters": [
2185
+ {
2186
+ "name": "workspaceId",
2187
+ "in": "query",
2188
+ "required": true,
2189
+ "schema": {
2190
+ "type": "integer"
2191
+ },
2192
+ "description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
2193
+ }
2194
+ ],
2195
+ "bodyRequired": false,
2196
+ "bodyType": null,
2197
+ "bodySchema": null
2198
+ },
2199
+ "listVoiceSimulationProjects": {
2200
+ "path": "/api/v1/voice-simulations/projects",
2201
+ "method": "get",
2202
+ "summary": "List voice simulation projects",
2203
+ "parameters": [
2204
+ {
2205
+ "name": "workspaceId",
2206
+ "in": "query",
2207
+ "required": true,
2208
+ "schema": {
2209
+ "type": "integer"
2210
+ },
2211
+ "description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
2212
+ }
2213
+ ],
2214
+ "bodyRequired": false,
2215
+ "bodyType": null,
2216
+ "bodySchema": null
2217
+ },
2218
+ "createVoiceSimulationProject": {
2219
+ "path": "/api/v1/voice-simulations/projects",
2220
+ "method": "post",
2221
+ "summary": "Create a voice simulation project",
2222
+ "parameters": [
2223
+ {
2224
+ "name": "workspaceId",
2225
+ "in": "query",
2226
+ "required": true,
2227
+ "schema": {
2228
+ "type": "integer"
2229
+ },
2230
+ "description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
2231
+ }
2232
+ ],
2233
+ "bodyRequired": true,
2234
+ "bodyType": "application/json",
2235
+ "bodySchema": {
2236
+ "type": "object",
2237
+ "properties": {
2238
+ "name": {
2239
+ "type": "string",
2240
+ "maxLength": 160
2241
+ },
2242
+ "description": {
2243
+ "type": "string",
2244
+ "maxLength": 5000
2245
+ },
2246
+ "source_agent_id": {
2247
+ "type": "string"
2248
+ },
2249
+ "copy_project_id": {
2250
+ "type": "string",
2251
+ "format": "uuid",
2252
+ "description": "Optional existing project to duplicate within the same workspace."
2253
+ },
2254
+ "automation_mode": {
2255
+ "type": "string",
2256
+ "enum": [
2257
+ "automated",
2258
+ "manual"
2259
+ ],
2260
+ "default": "automated",
2261
+ "description": "How the project runs. A copy keeps the original's mode unless this is set."
2262
+ }
2263
+ },
2264
+ "required": [
2265
+ "name",
2266
+ "source_agent_id"
2267
+ ]
2268
+ }
2269
+ },
2270
+ "getVoiceSimulationProject": {
2271
+ "path": "/api/v1/voice-simulations/projects/{projectId}",
2272
+ "method": "get",
2273
+ "summary": "Get a voice simulation project",
2274
+ "parameters": [
2275
+ {
2276
+ "name": "workspaceId",
2277
+ "in": "query",
2278
+ "required": true,
2279
+ "schema": {
2280
+ "type": "integer"
2281
+ },
2282
+ "description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
2283
+ },
2284
+ {
2285
+ "in": "path",
2286
+ "name": "projectId",
2287
+ "required": true,
2288
+ "schema": {
2289
+ "type": "string",
2290
+ "format": "uuid"
2291
+ }
2292
+ }
2293
+ ],
2294
+ "bodyRequired": false,
2295
+ "bodyType": null,
2296
+ "bodySchema": null
2297
+ },
2298
+ "updateVoiceSimulationProject": {
2299
+ "path": "/api/v1/voice-simulations/projects/{projectId}",
2300
+ "method": "patch",
2301
+ "summary": "Update a voice simulation project",
2302
+ "parameters": [
2303
+ {
2304
+ "name": "workspaceId",
2305
+ "in": "query",
2306
+ "required": true,
2307
+ "schema": {
2308
+ "type": "integer"
2309
+ },
2310
+ "description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
2311
+ },
2312
+ {
2313
+ "in": "path",
2314
+ "name": "projectId",
2315
+ "required": true,
2316
+ "schema": {
2317
+ "type": "string",
2318
+ "format": "uuid"
2319
+ }
2320
+ }
2321
+ ],
2322
+ "bodyRequired": true,
2323
+ "bodyType": "application/json",
2324
+ "bodySchema": {
2325
+ "type": "object",
2326
+ "properties": {
2327
+ "automation_mode": {
2328
+ "type": "string",
2329
+ "enum": [
2330
+ "automated",
2331
+ "manual"
2332
+ ]
2333
+ }
2334
+ },
2335
+ "required": [
2336
+ "automation_mode"
2337
+ ]
2338
+ }
2339
+ },
2340
+ "listVoiceSimulationScenarios": {
2341
+ "path": "/api/v1/voice-simulations/projects/{projectId}/scenarios",
2342
+ "method": "get",
2343
+ "summary": "List project scenarios",
2344
+ "parameters": [
2345
+ {
2346
+ "name": "workspaceId",
2347
+ "in": "query",
2348
+ "required": true,
2349
+ "schema": {
2350
+ "type": "integer"
2351
+ },
2352
+ "description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
2353
+ },
2354
+ {
2355
+ "in": "path",
2356
+ "name": "projectId",
2357
+ "required": true,
2358
+ "schema": {
2359
+ "type": "string",
2360
+ "format": "uuid"
2361
+ }
2362
+ }
2363
+ ],
2364
+ "bodyRequired": false,
2365
+ "bodyType": null,
2366
+ "bodySchema": null
2367
+ },
2368
+ "createVoiceSimulationScenario": {
2369
+ "path": "/api/v1/voice-simulations/projects/{projectId}/scenarios",
2370
+ "method": "post",
2371
+ "summary": "Create a voice simulation scenario",
2372
+ "parameters": [
2373
+ {
2374
+ "name": "workspaceId",
2375
+ "in": "query",
2376
+ "required": true,
2377
+ "schema": {
2378
+ "type": "integer"
2379
+ },
2380
+ "description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
2381
+ },
2382
+ {
2383
+ "in": "path",
2384
+ "name": "projectId",
2385
+ "required": true,
2386
+ "schema": {
2387
+ "type": "string",
2388
+ "format": "uuid"
2389
+ }
2390
+ }
2391
+ ],
2392
+ "bodyRequired": true,
2393
+ "bodyType": "application/json",
2394
+ "bodySchema": {
2395
+ "type": "object",
2396
+ "properties": {
2397
+ "definition": {
2398
+ "$ref": "#/components/schemas/VoiceSimulationScenarioDefinition"
2399
+ }
2400
+ },
2401
+ "required": [
2402
+ "definition"
2403
+ ]
2404
+ }
2405
+ },
2406
+ "updateVoiceSimulationScenario": {
2407
+ "path": "/api/v1/voice-simulations/projects/{projectId}/scenarios/{scenarioId}",
2408
+ "method": "put",
2409
+ "summary": "Update a voice simulation scenario",
2410
+ "parameters": [
2411
+ {
2412
+ "name": "workspaceId",
2413
+ "in": "query",
2414
+ "required": true,
2415
+ "schema": {
2416
+ "type": "integer"
2417
+ },
2418
+ "description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
2419
+ },
2420
+ {
2421
+ "in": "path",
2422
+ "name": "projectId",
2423
+ "required": true,
2424
+ "schema": {
2425
+ "type": "string",
2426
+ "format": "uuid"
2427
+ }
2428
+ },
2429
+ {
2430
+ "in": "path",
2431
+ "name": "scenarioId",
2432
+ "required": true,
2433
+ "schema": {
2434
+ "type": "string",
2435
+ "format": "uuid"
2436
+ }
2437
+ }
2438
+ ],
2439
+ "bodyRequired": true,
2440
+ "bodyType": "application/json",
2441
+ "bodySchema": {
2442
+ "type": "object",
2443
+ "properties": {
2444
+ "definition": {
2445
+ "$ref": "#/components/schemas/VoiceSimulationScenarioDefinition"
2446
+ },
2447
+ "revision": {
2448
+ "type": "integer",
2449
+ "minimum": 1
2450
+ }
2451
+ },
2452
+ "required": [
2453
+ "definition",
2454
+ "revision"
2455
+ ]
2456
+ }
2457
+ },
2458
+ "generateVoiceSimulationScenarios": {
2459
+ "path": "/api/v1/voice-simulations/projects/{projectId}/generate-scenarios",
2460
+ "method": "post",
2461
+ "summary": "Generate scenarios with Agent IQ",
2462
+ "parameters": [
2463
+ {
2464
+ "name": "workspaceId",
2465
+ "in": "query",
2466
+ "required": true,
2467
+ "schema": {
2468
+ "type": "integer"
2469
+ },
2470
+ "description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
2471
+ },
2472
+ {
2473
+ "in": "path",
2474
+ "name": "projectId",
2475
+ "required": true,
2476
+ "schema": {
2477
+ "type": "string",
2478
+ "format": "uuid"
2479
+ }
2480
+ }
2481
+ ],
2482
+ "bodyRequired": true,
2483
+ "bodyType": "application/json",
2484
+ "bodySchema": {
2485
+ "type": "object",
2486
+ "properties": {
2487
+ "ai_model": {
2488
+ "type": "string",
2489
+ "description": "Allowed Agent IQ model key from workspace model_options."
2490
+ },
2491
+ "instruction": {
2492
+ "type": "string",
2493
+ "maxLength": 12000,
2494
+ "description": "What to test. Omit or leave empty to let Agent IQ recommend scenarios."
2495
+ },
2496
+ "count": {
2497
+ "type": "integer",
2498
+ "minimum": 1,
2499
+ "maximum": 10
2500
+ },
2501
+ "use_call_history": {
2502
+ "type": "boolean",
2503
+ "default": true,
2504
+ "description": "Include recent real calls as evidence."
2505
+ }
2506
+ }
2507
+ }
2508
+ },
2509
+ "estimateVoiceSimulationSession": {
2510
+ "path": "/api/v1/voice-simulations/projects/{projectId}/estimate",
2511
+ "method": "post",
2512
+ "summary": "Estimate a simulation session",
2513
+ "parameters": [
2514
+ {
2515
+ "name": "workspaceId",
2516
+ "in": "query",
2517
+ "required": true,
2518
+ "schema": {
2519
+ "type": "integer"
2520
+ },
2521
+ "description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
2522
+ },
2523
+ {
2524
+ "in": "path",
2525
+ "name": "projectId",
2526
+ "required": true,
2527
+ "schema": {
2528
+ "type": "string",
2529
+ "format": "uuid"
2530
+ }
2531
+ }
2532
+ ],
2533
+ "bodyRequired": true,
2534
+ "bodyType": "application/json",
2535
+ "bodySchema": {
2536
+ "type": "object",
2537
+ "properties": {
2538
+ "scenario_ids": {
2539
+ "type": "array",
2540
+ "items": {
2541
+ "type": "string",
2542
+ "format": "uuid"
2543
+ },
2544
+ "minItems": 1,
2545
+ "maxItems": 100
2546
+ },
2547
+ "ai_model": {
2548
+ "type": "string",
2549
+ "description": "Optional allowed AI model ID from settings. Overrides scenario scoring models and selects their per-run tier price. Aliases are display labels, not IDs."
2550
+ },
2551
+ "repetitions": {
2552
+ "type": "integer",
2553
+ "minimum": 1,
2554
+ "maximum": 10
2555
+ }
2556
+ },
2557
+ "required": [
2558
+ "scenario_ids"
2559
+ ]
2560
+ }
2561
+ },
2562
+ "listVoiceSimulationSessions": {
2563
+ "path": "/api/v1/voice-simulations/projects/{projectId}/sessions",
2564
+ "method": "get",
2565
+ "summary": "List simulation sessions",
2566
+ "parameters": [
2567
+ {
2568
+ "name": "workspaceId",
2569
+ "in": "query",
2570
+ "required": true,
2571
+ "schema": {
2572
+ "type": "integer"
2573
+ },
2574
+ "description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
2575
+ },
2576
+ {
2577
+ "in": "path",
2578
+ "name": "projectId",
2579
+ "required": true,
2580
+ "schema": {
2581
+ "type": "string",
2582
+ "format": "uuid"
2583
+ }
2584
+ }
2585
+ ],
2586
+ "bodyRequired": false,
2587
+ "bodyType": null,
2588
+ "bodySchema": null
2589
+ },
2590
+ "launchVoiceSimulationSession": {
2591
+ "path": "/api/v1/voice-simulations/projects/{projectId}/sessions",
2592
+ "method": "post",
2593
+ "summary": "Launch a voice simulation session",
2594
+ "parameters": [
2595
+ {
2596
+ "name": "workspaceId",
2597
+ "in": "query",
2598
+ "required": true,
2599
+ "schema": {
2600
+ "type": "integer"
2601
+ },
2602
+ "description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
2603
+ },
2604
+ {
2605
+ "in": "path",
2606
+ "name": "projectId",
2607
+ "required": true,
2608
+ "schema": {
2609
+ "type": "string",
2610
+ "format": "uuid"
2611
+ }
2612
+ }
2613
+ ],
2614
+ "bodyRequired": true,
2615
+ "bodyType": "application/json",
2616
+ "bodySchema": {
2617
+ "$ref": "#/components/schemas/VoiceSimulationLaunchInput"
2618
+ }
2619
+ },
2620
+ "getVoiceSimulationSession": {
2621
+ "path": "/api/v1/voice-simulations/sessions/{sessionId}",
2622
+ "method": "get",
2623
+ "summary": "Get a simulation session and report",
2624
+ "parameters": [
2625
+ {
2626
+ "name": "workspaceId",
2627
+ "in": "query",
2628
+ "required": true,
2629
+ "schema": {
2630
+ "type": "integer"
2631
+ },
2632
+ "description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
2633
+ },
2634
+ {
2635
+ "in": "path",
2636
+ "name": "sessionId",
2637
+ "required": true,
2638
+ "schema": {
2639
+ "type": "string",
2640
+ "format": "uuid"
2641
+ }
2642
+ }
2643
+ ],
2644
+ "bodyRequired": false,
2645
+ "bodyType": null,
2646
+ "bodySchema": null
2647
+ },
2648
+ "cancelVoiceSimulationSession": {
2649
+ "path": "/api/v1/voice-simulations/sessions/{sessionId}/cancel",
2650
+ "method": "post",
2651
+ "summary": "Cancel a voice simulation session",
2652
+ "parameters": [
2653
+ {
2654
+ "name": "workspaceId",
2655
+ "in": "query",
2656
+ "required": true,
2657
+ "schema": {
2658
+ "type": "integer"
2659
+ },
2660
+ "description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
2661
+ },
2662
+ {
2663
+ "in": "path",
2664
+ "name": "sessionId",
2665
+ "required": true,
2666
+ "schema": {
2667
+ "type": "string",
2668
+ "format": "uuid"
2669
+ }
2670
+ }
2671
+ ],
2672
+ "bodyRequired": true,
2673
+ "bodyType": "application/json",
2674
+ "bodySchema": {
2675
+ "type": "object",
2676
+ "properties": {}
2677
+ }
2678
+ },
2679
+ "proposeVoiceSimulationImprovement": {
2680
+ "path": "/api/v1/voice-simulations/sessions/{sessionId}/improvements",
2681
+ "method": "post",
2682
+ "summary": "Propose a simulation improvement",
2683
+ "parameters": [
2684
+ {
2685
+ "name": "workspaceId",
2686
+ "in": "query",
2687
+ "required": true,
2688
+ "schema": {
2689
+ "type": "integer"
2690
+ },
2691
+ "description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
2692
+ },
2693
+ {
2694
+ "in": "path",
2695
+ "name": "sessionId",
2696
+ "required": true,
2697
+ "schema": {
2698
+ "type": "string",
2699
+ "format": "uuid"
2700
+ }
2701
+ }
2702
+ ],
2703
+ "bodyRequired": true,
2704
+ "bodyType": "application/json",
2705
+ "bodySchema": {
2706
+ "type": "object",
2707
+ "properties": {
2708
+ "change_scope": {
2709
+ "$ref": "#/components/schemas/VoiceSimulationChangeScope"
2710
+ },
2711
+ "ai_model": {
2712
+ "type": "string",
2713
+ "description": "Allowed Agent IQ model key from workspace model_options."
2714
+ }
2715
+ }
2716
+ }
2717
+ },
2718
+ "applyVoiceSimulationImprovement": {
2719
+ "path": "/api/v1/voice-simulations/projects/{projectId}/improvements/{improvementId}/apply",
2720
+ "method": "post",
2721
+ "summary": "Apply an improvement to a simulation draft",
2722
+ "parameters": [
2723
+ {
2724
+ "name": "workspaceId",
2725
+ "in": "query",
2726
+ "required": true,
2727
+ "schema": {
2728
+ "type": "integer"
2729
+ },
2730
+ "description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
2731
+ },
2732
+ {
2733
+ "in": "path",
2734
+ "name": "projectId",
2735
+ "required": true,
2736
+ "schema": {
2737
+ "type": "string",
2738
+ "format": "uuid"
2739
+ }
2740
+ },
2741
+ {
2742
+ "in": "path",
2743
+ "name": "improvementId",
2744
+ "required": true,
2745
+ "schema": {
2746
+ "type": "string",
2747
+ "format": "uuid"
2748
+ }
2749
+ }
2750
+ ],
2751
+ "bodyRequired": true,
2752
+ "bodyType": "application/json",
2753
+ "bodySchema": {
2754
+ "type": "object",
2755
+ "properties": {
2756
+ "confirm": {
2757
+ "type": "boolean",
2758
+ "const": true
2759
+ }
2760
+ },
2761
+ "required": [
2762
+ "confirm"
2763
+ ]
2764
+ }
2765
+ },
2766
+ "getVoiceSimulationRecording": {
2767
+ "path": "/api/v1/voice-simulations/sessions/{sessionId}/runs/{runId}/recording",
2768
+ "method": "get",
2769
+ "summary": "Get a voice simulation recording",
2770
+ "parameters": [
2771
+ {
2772
+ "name": "workspaceId",
2773
+ "in": "query",
2774
+ "required": true,
2775
+ "schema": {
2776
+ "type": "integer"
2777
+ },
2778
+ "description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
2779
+ },
2780
+ {
2781
+ "in": "path",
2782
+ "name": "sessionId",
2783
+ "required": true,
2784
+ "schema": {
2785
+ "type": "string",
2786
+ "format": "uuid"
2787
+ }
2788
+ },
2789
+ {
2790
+ "name": "runId",
2791
+ "in": "path",
2792
+ "required": true,
2793
+ "schema": {
2794
+ "type": "string",
2795
+ "format": "uuid"
2796
+ }
2797
+ }
2798
+ ],
2799
+ "bodyRequired": false,
2800
+ "bodyType": null,
2801
+ "bodySchema": null
2802
+ },
2803
+ "archiveVoiceSimulationProject": {
2804
+ "path": "/api/v1/voice-simulations/projects/{projectId}/archive",
2805
+ "method": "post",
2806
+ "summary": "Archive a voice simulation project",
2807
+ "parameters": [
2808
+ {
2809
+ "name": "workspaceId",
2810
+ "in": "query",
2811
+ "required": true,
2812
+ "schema": {
2813
+ "type": "integer"
2814
+ },
2815
+ "description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
2816
+ },
2817
+ {
2818
+ "in": "path",
2819
+ "name": "projectId",
2820
+ "required": true,
2821
+ "schema": {
2822
+ "type": "string",
2823
+ "format": "uuid"
2824
+ }
2825
+ }
2826
+ ],
2827
+ "bodyRequired": false,
2828
+ "bodyType": null,
2829
+ "bodySchema": null
2830
+ },
2831
+ "archiveVoiceSimulationScenario": {
2832
+ "path": "/api/v1/voice-simulations/projects/{projectId}/scenarios/{scenarioId}/archive",
2833
+ "method": "post",
2834
+ "summary": "Archive a voice simulation scenario",
2835
+ "parameters": [
2836
+ {
2837
+ "name": "workspaceId",
2838
+ "in": "query",
2839
+ "required": true,
2840
+ "schema": {
2841
+ "type": "integer"
2842
+ },
2843
+ "description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
2844
+ },
2845
+ {
2846
+ "in": "path",
2847
+ "name": "projectId",
2848
+ "required": true,
2849
+ "schema": {
2850
+ "type": "string",
2851
+ "format": "uuid"
2852
+ }
2853
+ },
2854
+ {
2855
+ "name": "scenarioId",
2856
+ "in": "path",
2857
+ "required": true,
2858
+ "schema": {
2859
+ "type": "string",
2860
+ "format": "uuid"
2861
+ }
2862
+ }
2863
+ ],
2864
+ "bodyRequired": false,
2865
+ "bodyType": null,
2866
+ "bodySchema": null
2867
+ },
2868
+ "listVoiceSimulationImprovements": {
2869
+ "path": "/api/v1/voice-simulations/projects/{projectId}/improvements",
2870
+ "method": "get",
2871
+ "summary": "List voice simulation improvement history",
2872
+ "parameters": [
2873
+ {
2874
+ "name": "workspaceId",
2875
+ "in": "query",
2876
+ "required": true,
2877
+ "schema": {
2878
+ "type": "integer"
2879
+ },
2880
+ "description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
2881
+ },
2882
+ {
2883
+ "in": "path",
2884
+ "name": "projectId",
2885
+ "required": true,
2886
+ "schema": {
2887
+ "type": "string",
2888
+ "format": "uuid"
2889
+ }
2890
+ }
2891
+ ],
2892
+ "bodyRequired": false,
2893
+ "bodyType": null,
2894
+ "bodySchema": null
2895
+ },
2896
+ "listVoiceSimulationSpeechVoices": {
2897
+ "path": "/api/v1/voice-simulations/speech/voices",
2898
+ "method": "get",
2899
+ "summary": "List voices for IVR recordings",
2900
+ "parameters": [
2901
+ {
2902
+ "name": "workspaceId",
2903
+ "in": "query",
2904
+ "required": true,
2905
+ "schema": {
2906
+ "type": "integer"
2907
+ },
2908
+ "description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
2909
+ },
2910
+ {
2911
+ "name": "provider",
2912
+ "in": "query",
2913
+ "required": true,
2914
+ "schema": {
2915
+ "type": "string",
2916
+ "enum": [
2917
+ "cartesia",
2918
+ "elevenlabs"
2919
+ ]
2920
+ }
2921
+ }
2922
+ ],
2923
+ "bodyRequired": false,
2924
+ "bodyType": null,
2925
+ "bodySchema": null
2926
+ },
2927
+ "generateVoiceSimulationIvrAudio": {
2928
+ "path": "/api/v1/voice-simulations/ivr/audio",
2929
+ "method": "post",
2930
+ "summary": "Generate recordings for IVR prompts",
2931
+ "parameters": [
2932
+ {
2933
+ "name": "workspaceId",
2934
+ "in": "query",
2935
+ "required": true,
2936
+ "schema": {
2937
+ "type": "integer"
2938
+ },
2939
+ "description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
2940
+ }
2941
+ ],
2942
+ "bodyRequired": true,
2943
+ "bodyType": "application/json",
2944
+ "bodySchema": {
2945
+ "type": "object",
2946
+ "properties": {
2947
+ "ivr": {
2948
+ "$ref": "#/components/schemas/VoiceSimulationIvr"
2949
+ },
2950
+ "provider": {
2951
+ "type": "string",
2952
+ "enum": [
2953
+ "cartesia",
2954
+ "elevenlabs"
2955
+ ]
2956
+ },
2957
+ "voice_id": {
2958
+ "type": "string"
2959
+ }
2960
+ },
2961
+ "required": [
2962
+ "ivr",
2963
+ "provider"
2964
+ ]
2965
+ }
2966
+ },
2967
+ "getVoiceSimulationIvrAudio": {
2968
+ "path": "/api/v1/voice-simulations/audio/{audioId}",
2969
+ "method": "get",
2970
+ "summary": "Download an IVR recording",
2971
+ "parameters": [
2972
+ {
2973
+ "name": "workspaceId",
2974
+ "in": "query",
2975
+ "required": true,
2976
+ "schema": {
2977
+ "type": "integer"
2978
+ },
2979
+ "description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
2980
+ },
2981
+ {
2982
+ "name": "audioId",
2983
+ "in": "path",
2984
+ "required": true,
2985
+ "schema": {
2986
+ "type": "string",
2987
+ "format": "uuid"
2988
+ }
2989
+ }
2990
+ ],
2991
+ "bodyRequired": false,
2992
+ "bodyType": null,
2993
+ "bodySchema": null
2994
+ },
2995
+ "listVoiceSimulationImprovementRuns": {
2996
+ "path": "/api/v1/voice-simulations/projects/{projectId}/improvement-runs",
2997
+ "method": "get",
2998
+ "summary": "List self-improving runs",
2999
+ "parameters": [
3000
+ {
3001
+ "name": "workspaceId",
3002
+ "in": "query",
3003
+ "required": true,
3004
+ "schema": {
3005
+ "type": "integer"
3006
+ },
3007
+ "description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
3008
+ },
3009
+ {
3010
+ "name": "projectId",
3011
+ "in": "path",
3012
+ "required": true,
3013
+ "schema": {
3014
+ "type": "string",
3015
+ "format": "uuid"
3016
+ }
3017
+ }
3018
+ ],
3019
+ "bodyRequired": false,
3020
+ "bodyType": null,
3021
+ "bodySchema": null
3022
+ },
3023
+ "createVoiceSimulationImprovementRun": {
3024
+ "path": "/api/v1/voice-simulations/projects/{projectId}/improvement-runs",
3025
+ "method": "post",
3026
+ "summary": "Create a self-improving run",
3027
+ "parameters": [
3028
+ {
3029
+ "name": "workspaceId",
3030
+ "in": "query",
3031
+ "required": true,
3032
+ "schema": {
3033
+ "type": "integer"
3034
+ },
3035
+ "description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
3036
+ },
3037
+ {
3038
+ "name": "projectId",
3039
+ "in": "path",
3040
+ "required": true,
3041
+ "schema": {
3042
+ "type": "string",
3043
+ "format": "uuid"
3044
+ }
3045
+ }
3046
+ ],
3047
+ "bodyRequired": true,
3048
+ "bodyType": "application/json",
3049
+ "bodySchema": {
3050
+ "type": "object",
3051
+ "properties": {
3052
+ "max_calls": {
3053
+ "type": "integer",
3054
+ "minimum": 1,
3055
+ "maximum": 100,
3056
+ "description": "Total simulation runs allowed, including prior reserved calls; workspace cap may be lower."
3057
+ },
3058
+ "max_ai": {
3059
+ "type": "integer",
3060
+ "minimum": 1,
3061
+ "maximum": 200,
3062
+ "description": "Total logical Agent IQ interactions, including execution planning, scenario generation, scoring and draft improvements. Multi-scenario execution plans consume one interaction each; single-scenario runs skip planning. Model fallback belongs to the same interaction. Workspace cap may be lower."
3063
+ },
3064
+ "max_surcharge": {
3065
+ "type": "number",
3066
+ "minimum": 0,
3067
+ "description": "Maximum cumulative per-run surcharges. Voice usage, Agent IQ pricing and monthly access remain separate."
3068
+ },
3069
+ "scenario_ids": {
3070
+ "type": "array",
3071
+ "items": {
3072
+ "type": "string",
3073
+ "format": "uuid"
3074
+ },
3075
+ "maxItems": 100
3076
+ },
3077
+ "ai_model": {
3078
+ "type": "string"
3079
+ }
3080
+ }
3081
+ }
3082
+ },
3083
+ "getVoiceSimulationImprovementRun": {
3084
+ "path": "/api/v1/voice-simulations/improvement-runs/{id}",
3085
+ "method": "get",
3086
+ "summary": "Review a self-improving run",
3087
+ "parameters": [
3088
+ {
3089
+ "name": "workspaceId",
3090
+ "in": "query",
3091
+ "required": true,
3092
+ "schema": {
3093
+ "type": "integer"
3094
+ },
3095
+ "description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
3096
+ },
3097
+ {
3098
+ "name": "id",
3099
+ "in": "path",
3100
+ "required": true,
3101
+ "schema": {
3102
+ "type": "string",
3103
+ "format": "uuid"
3104
+ }
3105
+ }
3106
+ ],
3107
+ "bodyRequired": false,
3108
+ "bodyType": null,
3109
+ "bodySchema": null
3110
+ },
3111
+ "updateVoiceSimulationImprovementRun": {
3112
+ "path": "/api/v1/voice-simulations/improvement-runs/{id}",
3113
+ "method": "patch",
3114
+ "summary": "Choose scenarios before improvement approval",
3115
+ "parameters": [
3116
+ {
3117
+ "name": "workspaceId",
3118
+ "in": "query",
3119
+ "required": true,
3120
+ "schema": {
3121
+ "type": "integer"
3122
+ },
3123
+ "description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
3124
+ },
3125
+ {
3126
+ "name": "id",
3127
+ "in": "path",
3128
+ "required": true,
3129
+ "schema": {
3130
+ "type": "string",
3131
+ "format": "uuid"
3132
+ }
3133
+ }
3134
+ ],
3135
+ "bodyRequired": true,
3136
+ "bodyType": "application/json",
3137
+ "bodySchema": {
3138
+ "type": "object",
3139
+ "required": [
3140
+ "scenario_ids"
3141
+ ],
3142
+ "properties": {
3143
+ "scenario_ids": {
3144
+ "type": "array",
3145
+ "maxItems": 100,
3146
+ "items": {
3147
+ "type": "string",
3148
+ "format": "uuid"
3149
+ }
3150
+ }
3151
+ }
3152
+ }
3153
+ },
3154
+ "generateVoiceSimulationImprovementScenarios": {
3155
+ "path": "/api/v1/voice-simulations/improvement-runs/{id}/generate",
3156
+ "method": "post",
3157
+ "summary": "Generate and save an improvement test suite",
3158
+ "parameters": [
3159
+ {
3160
+ "name": "workspaceId",
3161
+ "in": "query",
3162
+ "required": true,
3163
+ "schema": {
3164
+ "type": "integer"
3165
+ },
3166
+ "description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
3167
+ },
3168
+ {
3169
+ "name": "id",
3170
+ "in": "path",
3171
+ "required": true,
3172
+ "schema": {
3173
+ "type": "string",
3174
+ "format": "uuid"
3175
+ }
3176
+ }
3177
+ ],
3178
+ "bodyRequired": true,
3179
+ "bodyType": "application/json",
3180
+ "bodySchema": {
3181
+ "type": "object",
3182
+ "properties": {
3183
+ "instruction": {
3184
+ "type": "string",
3185
+ "maxLength": 12000
3186
+ },
3187
+ "count": {
3188
+ "type": "integer",
3189
+ "minimum": 1,
3190
+ "maximum": 10
3191
+ }
3192
+ },
3193
+ "required": [
3194
+ "instruction"
3195
+ ]
3196
+ }
3197
+ },
3198
+ "approveVoiceSimulationImprovementRun": {
3199
+ "path": "/api/v1/voice-simulations/improvement-runs/{id}/approve",
3200
+ "method": "post",
3201
+ "summary": "Approve or renew an improvement budget",
3202
+ "parameters": [
3203
+ {
3204
+ "name": "workspaceId",
3205
+ "in": "query",
3206
+ "required": true,
3207
+ "schema": {
3208
+ "type": "integer"
3209
+ },
3210
+ "description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
3211
+ },
3212
+ {
3213
+ "name": "id",
3214
+ "in": "path",
3215
+ "required": true,
3216
+ "schema": {
3217
+ "type": "string",
3218
+ "format": "uuid"
3219
+ }
3220
+ }
3221
+ ],
3222
+ "bodyRequired": true,
3223
+ "bodyType": "application/json",
3224
+ "bodySchema": {
3225
+ "type": "object",
3226
+ "properties": {
3227
+ "change_scope": {
3228
+ "$ref": "#/components/schemas/VoiceSimulationChangeScope"
3229
+ },
3230
+ "ai_model": {
3231
+ "type": "string",
3232
+ "description": "Allowed Agent IQ model key for future improvement steps (provider/model). Saved atomically with approval. Omit to retain the run model, or resolve the workspace default for an older run without a model. May be changed when approving a draft or renewing a paused run; scenario scoring and counterpart models are unchanged."
3233
+ },
3234
+ "max_calls": {
3235
+ "type": "integer",
3236
+ "minimum": 1,
3237
+ "maximum": 100,
3238
+ "description": "Total simulation runs allowed, including prior reserved calls; workspace cap may be lower."
3239
+ },
3240
+ "max_ai": {
3241
+ "type": "integer",
3242
+ "minimum": 1,
3243
+ "maximum": 200,
3244
+ "description": "Total logical Agent IQ interactions, including execution planning, scenario generation, scoring and draft improvements. Multi-scenario execution plans consume one interaction each; single-scenario runs skip planning. Model fallback belongs to the same interaction. Workspace cap may be lower."
3245
+ },
3246
+ "max_surcharge": {
3247
+ "type": "number",
3248
+ "minimum": 0,
3249
+ "description": "Maximum cumulative per-run surcharges. Voice usage, Agent IQ pricing and monthly access remain separate."
3250
+ },
3251
+ "confirm": {
3252
+ "type": "boolean",
3253
+ "const": true
3254
+ },
3255
+ "review_fingerprint": {
3256
+ "type": "string"
3257
+ }
3258
+ },
3259
+ "required": [
3260
+ "confirm",
3261
+ "review_fingerprint",
3262
+ "max_calls",
3263
+ "max_ai",
3264
+ "max_surcharge"
3265
+ ]
3266
+ }
3267
+ },
3268
+ "stopVoiceSimulationImprovementRun": {
3269
+ "path": "/api/v1/voice-simulations/improvement-runs/{id}/stop",
3270
+ "method": "post",
3271
+ "summary": "Stop a self-improving run",
3272
+ "parameters": [
3273
+ {
3274
+ "name": "workspaceId",
3275
+ "in": "query",
3276
+ "required": true,
3277
+ "schema": {
3278
+ "type": "integer"
3279
+ },
3280
+ "description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
3281
+ },
3282
+ {
3283
+ "name": "id",
3284
+ "in": "path",
3285
+ "required": true,
3286
+ "schema": {
3287
+ "type": "string",
3288
+ "format": "uuid"
3289
+ }
3290
+ }
3291
+ ],
3292
+ "bodyRequired": true,
3293
+ "bodyType": "application/json",
3294
+ "bodySchema": {
3295
+ "type": "object",
3296
+ "properties": {}
3297
+ }
3298
+ },
3299
+ "getVoiceSimulationSchedule": {
3300
+ "path": "/api/v1/voice-simulations/projects/{projectId}/improvement-schedule",
3301
+ "method": "get",
3302
+ "summary": "Get recurring improvement policy",
3303
+ "parameters": [
3304
+ {
3305
+ "name": "workspaceId",
3306
+ "in": "query",
3307
+ "required": true,
3308
+ "schema": {
3309
+ "type": "integer"
3310
+ },
3311
+ "description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
3312
+ },
3313
+ {
3314
+ "name": "projectId",
3315
+ "in": "path",
3316
+ "required": true,
3317
+ "schema": {
3318
+ "type": "string",
3319
+ "format": "uuid"
3320
+ }
3321
+ }
3322
+ ],
3323
+ "bodyRequired": false,
3324
+ "bodyType": null,
3325
+ "bodySchema": null
3326
+ },
3327
+ "saveVoiceSimulationSchedule": {
3328
+ "path": "/api/v1/voice-simulations/projects/{projectId}/improvement-schedule",
3329
+ "method": "put",
3330
+ "summary": "Approve or renew recurring improvement cycles",
3331
+ "parameters": [
3332
+ {
3333
+ "name": "workspaceId",
3334
+ "in": "query",
3335
+ "required": true,
3336
+ "schema": {
3337
+ "type": "integer"
3338
+ },
3339
+ "description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
3340
+ },
3341
+ {
3342
+ "name": "projectId",
3343
+ "in": "path",
3344
+ "required": true,
3345
+ "schema": {
3346
+ "type": "string",
3347
+ "format": "uuid"
3348
+ }
3349
+ }
3350
+ ],
3351
+ "bodyRequired": true,
3352
+ "bodyType": "application/json",
3353
+ "bodySchema": {
3354
+ "$ref": "#/components/schemas/VoiceSimulationScheduleApproval"
3355
+ }
3356
+ },
3357
+ "pauseVoiceSimulationSchedule": {
3358
+ "path": "/api/v1/voice-simulations/projects/{projectId}/improvement-schedule/pause",
3359
+ "method": "post",
3360
+ "summary": "Pause future improvement cycles",
3361
+ "parameters": [
3362
+ {
3363
+ "name": "workspaceId",
3364
+ "in": "query",
3365
+ "required": true,
3366
+ "schema": {
3367
+ "type": "integer"
3368
+ },
3369
+ "description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
3370
+ },
3371
+ {
3372
+ "name": "projectId",
3373
+ "in": "path",
3374
+ "required": true,
3375
+ "schema": {
3376
+ "type": "string",
3377
+ "format": "uuid"
3378
+ }
3379
+ }
3380
+ ],
3381
+ "bodyRequired": false,
3382
+ "bodyType": null,
3383
+ "bodySchema": null
2141
3384
  }
2142
3385
  };