@naturali/sdk 0.38.1 → 0.40.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.
package/dist/index.d.cts CHANGED
@@ -336,7 +336,7 @@ type ClientOptions = {
336
336
  };
337
337
  type Agent = {
338
338
  /**
339
- * Public agent ID (agent_ prefix) — the SOAT agent id.
339
+ * Public agent ID (agent_ prefix) — the runtime agent id.
340
340
  */
341
341
  id: string;
342
342
  project_id: string;
@@ -367,6 +367,13 @@ type Agent = {
367
367
  */
368
368
  tool_ids: Array<string>;
369
369
  tool_choice: ToolChoice;
370
+ /**
371
+ * JSON Schema describing the structured object the model must return. When set, a non-streaming generation is constrained to it and the parsed value comes back as `object` on the generation result. Null (the default) leaves the output unconstrained. Streaming generations are unaffected.
372
+ *
373
+ */
374
+ output_schema: {
375
+ [key: string]: unknown;
376
+ } | null;
370
377
  status: 'active' | 'disabled';
371
378
  created_at: Date;
372
379
  updated_at: Date;
@@ -385,7 +392,7 @@ type AgentCreate = {
385
392
  */
386
393
  name?: string;
387
394
  /**
388
- * Model string SOAT sends (see /v1/models soat_model). Defaults to the provider's default model.
395
+ * Model string the runtime sends (see /v1/models provider_model). Defaults to the provider's default model.
389
396
  */
390
397
  model?: string;
391
398
  /**
@@ -401,6 +408,13 @@ type AgentCreate = {
401
408
  */
402
409
  tool_ids?: Array<string>;
403
410
  tool_choice?: ToolChoice;
411
+ /**
412
+ * JSON Schema describing the structured object the model must return. When set, a non-streaming generation is constrained to it and the parsed value comes back as `object` on the generation result. Omit (the default) to leave the output unconstrained. Streaming generations are unaffected.
413
+ *
414
+ */
415
+ output_schema?: {
416
+ [key: string]: unknown;
417
+ };
404
418
  };
405
419
  /**
406
420
  * At least one field must be present.
@@ -422,6 +436,13 @@ type AgentUpdate = {
422
436
  */
423
437
  tool_ids?: Array<string>;
424
438
  tool_choice?: ToolChoice;
439
+ /**
440
+ * Replace the agent's structured-output schema. An object constrains non-streaming generations to it; `null` clears it and leaves the output unconstrained.
441
+ *
442
+ */
443
+ output_schema?: {
444
+ [key: string]: unknown;
445
+ } | null;
425
446
  status?: 'active' | 'disabled';
426
447
  };
427
448
  type AgentList = {
@@ -610,7 +631,7 @@ type BoardDispatch = {
610
631
  type BoardCompletionRule = {
611
632
  /**
612
633
  * JSON Logic evaluated against `{ task, result }`. `result` is the dispatch's output: for an agent column its generation output; for a tool column the tool's own result object.
613
- * Routing an agent column on *structured* output (`result.object.…`) needs the agent to declare an output schema, and the Agents API does not expose one yet so today an agent column can only route on what its generation happens to return.
634
+ * Routing an agent column on *structured* output (`result.object.…`) needs the agent to declare an `output_schema` set one and every field of it is addressable here.
614
635
  *
615
636
  */
616
637
  when: unknown;
@@ -795,7 +816,7 @@ type Channel = {
795
816
  * the optional `modes` opting into the gateway flows. Discord runs over
796
817
  * the Gateway, so the bot token is kept in naturali's encrypted store
797
818
  * (the worker must present it to authenticate its WebSocket) rather than
798
- * as a SOAT secret; deployments without `CHANNEL_TOKEN_KEY` configured
819
+ * as a secret on the runtime; deployments without `CHANNEL_TOKEN_KEY` configured
799
820
  * return `501`.
800
821
  *
801
822
  * No credential value is ever returned.
@@ -918,7 +939,7 @@ type ChannelBindingSet = {
918
939
  status?: 'active' | 'disabled';
919
940
  };
920
941
  /**
921
- * One contact's dialogue on a channel — naturali-native, keyed by (channel, contact identity) so the same identifier never opens two conversations, and mapped 1:1 to the SOAT session that carries the message history. `contact_id` is who the dialogue is with (see the Contacts API); a merge moves it without disturbing the identity that keys the dialogue.
942
+ * One contact's dialogue on a channel — naturali-native, keyed by (channel, contact identity) so the same identifier never opens two conversations, and mapped 1:1 to the runtime session that carries the message history. `contact_id` is who the dialogue is with (see the Contacts API); a merge moves it without disturbing the identity that keys the dialogue.
922
943
  *
923
944
  */
924
945
  type Conversation = {
@@ -940,12 +961,12 @@ type Conversation = {
940
961
  */
941
962
  contact_identifier: string | null;
942
963
  /**
943
- * The SOAT actor the contact speaks as. Null when the contact has not needed one yet.
964
+ * The runtime actor the contact speaks as. Null when the contact has not needed one yet.
944
965
  *
945
966
  */
946
967
  actor_id: string | null;
947
968
  /**
948
- * The SOAT session this conversation maps 1:1 to.
969
+ * The runtime session this conversation maps 1:1 to.
949
970
  */
950
971
  session_id: string;
951
972
  created_at: Date;
@@ -959,11 +980,11 @@ type ConversationList = {
959
980
  next_cursor: string | null;
960
981
  };
961
982
  /**
962
- * One message in the conversation's transcript, as SOAT records it.
983
+ * One message in the conversation's transcript, as the runtime records it.
963
984
  */
964
985
  type ConversationMessage = {
965
986
  /**
966
- * The SOAT document holding the message text.
987
+ * The runtime document holding the message text.
967
988
  */
968
989
  document_id?: string | null;
969
990
  role?: 'user' | 'assistant' | 'system' | null;
@@ -1016,7 +1037,7 @@ type Contact = {
1016
1037
  [key: string]: unknown;
1017
1038
  } | null;
1018
1039
  /**
1019
- * The SOAT actor the contact speaks as — one per contact, created on first need. Memory hangs off it.
1040
+ * The runtime actor the contact speaks as — one per contact, created on first need. Memory hangs off it.
1020
1041
  *
1021
1042
  */
1022
1043
  actor_id: string | null;
@@ -1106,7 +1127,7 @@ type ContactConversation = {
1106
1127
  contact_id: string;
1107
1128
  contact_identity_id: string;
1108
1129
  /**
1109
- * The SOAT session this conversation maps 1:1 to.
1130
+ * The runtime session this conversation maps 1:1 to.
1110
1131
  */
1111
1132
  session_id: string;
1112
1133
  created_at: Date;
@@ -1243,7 +1264,7 @@ type GenerationResult = {
1243
1264
  }> | null;
1244
1265
  };
1245
1266
  /**
1246
- * A stored generation record — one model loop an agent ran, as SOAT recorded it. This is what a read returns; `GenerationResult` is what running one returns.
1267
+ * A stored generation record — one model loop an agent ran, as the runtime recorded it. This is what a read returns; `GenerationResult` is what running one returns.
1247
1268
  * The record carries no prompt or completion text: the transcript belongs to the session that ran the turn, and the step-level detail to the trace.
1248
1269
  *
1249
1270
  */
@@ -1433,7 +1454,7 @@ type KnowledgeCollectionList = {
1433
1454
  };
1434
1455
  type KnowledgeDocument = {
1435
1456
  /**
1436
- * Public document ID (doc_ prefix) — the SOAT document id.
1457
+ * Public document ID (doc_ prefix) — the runtime document id.
1437
1458
  */
1438
1459
  id: string;
1439
1460
  collection_id: string;
@@ -1525,7 +1546,7 @@ type Model = {
1525
1546
  id: string;
1526
1547
  display_name: string;
1527
1548
  /**
1528
- * SOAT provider slug that serves the model.
1549
+ * The provider slug that serves the model.
1529
1550
  */
1530
1551
  provider: string;
1531
1552
  /**
@@ -1533,10 +1554,10 @@ type Model = {
1533
1554
  */
1534
1555
  vendor: string;
1535
1556
  /**
1536
- * The exact model string SOAT sends to the provider — a cross-region inference-profile id (us.…) when the model is profile-only.
1557
+ * The exact model string the runtime sends to the provider — a cross-region inference-profile id (us.…) when the model is profile-only.
1537
1558
  *
1538
1559
  */
1539
- soat_model: string;
1560
+ provider_model: string;
1540
1561
  /**
1541
1562
  * Accepted input modalities.
1542
1563
  */
@@ -1636,13 +1657,13 @@ type ProjectList = {
1636
1657
  };
1637
1658
  type Provider = {
1638
1659
  /**
1639
- * Public provider ID (aip_ prefix) — the SOAT ai_provider id.
1660
+ * Public provider ID (aip_ prefix) — the provider id on the runtime.
1640
1661
  */
1641
1662
  id: string;
1642
1663
  project_id: string;
1643
1664
  name: string;
1644
1665
  /**
1645
- * SOAT provider slug.
1666
+ * The provider slug.
1646
1667
  */
1647
1668
  provider: 'openai' | 'anthropic' | 'google' | 'xai' | 'groq' | 'ollama' | 'azure' | 'bedrock' | 'gateway' | 'custom';
1648
1669
  default_model: string;
@@ -1661,7 +1682,7 @@ type Provider = {
1661
1682
  };
1662
1683
  /**
1663
1684
  * Two modes, selected by `kind` (default `byok`).
1664
- * `managed` (naturali-keyed, metered at cost on SOAT): supply only `model` (a catalog model id offered as managed, e.g. amazon.nova-lite-v1:0) and an optional `name`. No credential — managed providers use naturali's own AWS access, and are metered at raw AWS cost (customer markup is applied later by the naturali cost API).
1685
+ * `managed` (naturali-keyed, metered at cost on the runtime): supply only `model` (a catalog model id offered as managed, e.g. amazon.nova-lite-v1:0) and an optional `name`. No credential — managed providers use naturali's own AWS access, and are metered at raw AWS cost (customer markup is applied later by the naturali cost API).
1665
1686
  * `byok`: supply `provider`, `default_model` and `api_key` (+ optional `name`, `base_url`). The credential is stored write-only and never priced.
1666
1687
  *
1667
1688
  */
@@ -1672,11 +1693,11 @@ type ProviderCreate = {
1672
1693
  */
1673
1694
  model?: string;
1674
1695
  /**
1675
- * BYOK only — the SOAT provider slug.
1696
+ * BYOK only — the provider slug.
1676
1697
  */
1677
1698
  provider?: 'openai' | 'anthropic' | 'google' | 'xai' | 'groq' | 'ollama' | 'azure' | 'bedrock' | 'gateway' | 'custom';
1678
1699
  /**
1679
- * BYOK only — model string SOAT sends (see /v1/models soat_model).
1700
+ * BYOK only — model string the runtime sends (see /v1/models provider_model).
1680
1701
  */
1681
1702
  default_model?: string;
1682
1703
  /**
@@ -1722,12 +1743,12 @@ type SessionCreate = {
1722
1743
  */
1723
1744
  name?: string;
1724
1745
  /**
1725
- * The contact the session is for (Contacts API, §6). naturali resolves it to the contact's SOAT actor — minting one on first need — so a web or in-app session gets the same continuity, memory and history a channel conversation gets, instead of a throwaway identity per session. When the contact has an `external_id` it rides along in `tool_context` as `actor_external_id`, so the customer's own HTTP tools receive the user reference they already key on; an explicit `tool_context` entry still wins. Mutually exclusive with `actor_id`.
1746
+ * The contact the session is for (Contacts API, §6). naturali resolves it to the contact's runtime actor — minting one on first need — so a web or in-app session gets the same continuity, memory and history a channel conversation gets, instead of a throwaway identity per session. When the contact has an `external_id` it rides along in `tool_context` as `actor_external_id`, so the customer's own HTTP tools receive the user reference they already key on; an explicit `tool_context` entry still wins. Mutually exclusive with `actor_id`.
1726
1747
  *
1727
1748
  */
1728
1749
  contact_id?: string;
1729
1750
  /**
1730
- * Public ID of an existing actor to attach as the user actor. A SOAT id showing through the public contract; prefer `contact_id`. Mutually exclusive with it.
1751
+ * Public ID of an existing actor to attach as the user actor. A runtime id showing through the public contract; prefer `contact_id`. Mutually exclusive with it.
1731
1752
  *
1732
1753
  */
1733
1754
  actor_id?: string;
@@ -1762,7 +1783,7 @@ type Session = {
1762
1783
  */
1763
1784
  agent_id: string;
1764
1785
  /**
1765
- * The underlying SOAT conversation backing the session.
1786
+ * The underlying runtime conversation backing the session.
1766
1787
  */
1767
1788
  conversation_id?: string | null;
1768
1789
  /**
@@ -2061,7 +2082,7 @@ type McpConfig = {
2061
2082
  };
2062
2083
  type Tool = {
2063
2084
  /**
2064
- * Public tool ID (tool_ prefix) — the SOAT tool id.
2085
+ * Public tool ID (tool_ prefix) — the runtime tool id.
2065
2086
  */
2066
2087
  id: string;
2067
2088
  project_id: string;
@@ -2322,7 +2343,7 @@ type GenerationStatus = 'in_progress' | 'requires_action' | 'completed' | 'faile
2322
2343
  */
2323
2344
  type CollectionId = string;
2324
2345
  /**
2325
- * Knowledge document public ID (doc_ prefix) — the SOAT document id.
2346
+ * Knowledge document public ID (doc_ prefix) — the runtime document id.
2326
2347
  */
2327
2348
  type DocumentId = string;
2328
2349
  /**
@@ -2430,7 +2451,7 @@ type CreateAgentErrors = {
2430
2451
  */
2431
2452
  404: ErrorResponse;
2432
2453
  /**
2433
- * The backing SOAT platform could not complete the operation.
2454
+ * The upstream runtime could not complete the operation.
2434
2455
  */
2435
2456
  502: ErrorResponse;
2436
2457
  };
@@ -2477,7 +2498,7 @@ type DeleteAgentErrors = {
2477
2498
  */
2478
2499
  409: ErrorResponse;
2479
2500
  /**
2480
- * The backing SOAT platform could not complete the operation.
2501
+ * The upstream runtime could not complete the operation.
2481
2502
  */
2482
2503
  502: ErrorResponse;
2483
2504
  };
@@ -2551,7 +2572,7 @@ type UpdateAgentErrors = {
2551
2572
  */
2552
2573
  404: ErrorResponse;
2553
2574
  /**
2554
- * The backing SOAT platform could not complete the operation.
2575
+ * The upstream runtime could not complete the operation.
2555
2576
  */
2556
2577
  502: ErrorResponse;
2557
2578
  };
@@ -2908,7 +2929,7 @@ type ListBoardsErrors = {
2908
2929
  */
2909
2930
  404: ErrorResponse;
2910
2931
  /**
2911
- * The backing SOAT platform could not complete the operation.
2932
+ * The upstream runtime could not complete the operation.
2912
2933
  */
2913
2934
  502: ErrorResponse;
2914
2935
  };
@@ -2952,7 +2973,7 @@ type CreateBoardErrors = {
2952
2973
  */
2953
2974
  404: ErrorResponse;
2954
2975
  /**
2955
- * The backing SOAT platform could not complete the operation.
2976
+ * The upstream runtime could not complete the operation.
2956
2977
  */
2957
2978
  502: ErrorResponse;
2958
2979
  };
@@ -2993,7 +3014,7 @@ type DeleteBoardErrors = {
2993
3014
  */
2994
3015
  409: ErrorResponse;
2995
3016
  /**
2996
- * The backing SOAT platform could not complete the operation.
3017
+ * The upstream runtime could not complete the operation.
2997
3018
  */
2998
3019
  502: ErrorResponse;
2999
3020
  };
@@ -3030,7 +3051,7 @@ type GetBoardErrors = {
3030
3051
  */
3031
3052
  404: ErrorResponse;
3032
3053
  /**
3033
- * The backing SOAT platform could not complete the operation.
3054
+ * The upstream runtime could not complete the operation.
3034
3055
  */
3035
3056
  502: ErrorResponse;
3036
3057
  };
@@ -3072,7 +3093,7 @@ type UpdateBoardErrors = {
3072
3093
  */
3073
3094
  404: ErrorResponse;
3074
3095
  /**
3075
- * The backing SOAT platform could not complete the operation.
3096
+ * The upstream runtime could not complete the operation.
3076
3097
  */
3077
3098
  502: ErrorResponse;
3078
3099
  };
@@ -3162,7 +3183,7 @@ type CreateChannelErrors = {
3162
3183
  */
3163
3184
  501: ErrorResponse;
3164
3185
  /**
3165
- * The backing SOAT platform could not complete the operation.
3186
+ * The upstream runtime could not complete the operation.
3166
3187
  */
3167
3188
  502: ErrorResponse;
3168
3189
  };
@@ -3199,7 +3220,7 @@ type DeleteChannelErrors = {
3199
3220
  */
3200
3221
  404: ErrorResponse;
3201
3222
  /**
3202
- * The backing SOAT platform could not complete the operation.
3223
+ * The upstream runtime could not complete the operation.
3203
3224
  */
3204
3225
  502: ErrorResponse;
3205
3226
  };
@@ -3273,7 +3294,7 @@ type UpdateChannelErrors = {
3273
3294
  */
3274
3295
  404: ErrorResponse;
3275
3296
  /**
3276
- * The backing SOAT platform could not complete the operation.
3297
+ * The upstream runtime could not complete the operation.
3277
3298
  */
3278
3299
  502: ErrorResponse;
3279
3300
  };
@@ -3527,7 +3548,7 @@ type ListChannelConversationMessagesErrors = {
3527
3548
  */
3528
3549
  404: ErrorResponse;
3529
3550
  /**
3530
- * The backing SOAT platform could not complete the operation.
3551
+ * The upstream runtime could not complete the operation.
3531
3552
  */
3532
3553
  502: ErrorResponse;
3533
3554
  };
@@ -3671,7 +3692,7 @@ type DeleteContactErrors = {
3671
3692
  */
3672
3693
  409: ErrorResponse;
3673
3694
  /**
3674
- * The backing SOAT platform could not complete the operation.
3695
+ * The upstream runtime could not complete the operation.
3675
3696
  */
3676
3697
  502: ErrorResponse;
3677
3698
  };
@@ -3905,7 +3926,7 @@ type MergeContactErrors = {
3905
3926
  */
3906
3927
  409: ErrorResponse;
3907
3928
  /**
3908
- * The backing SOAT platform could not complete the operation.
3929
+ * The upstream runtime could not complete the operation.
3909
3930
  */
3910
3931
  502: ErrorResponse;
3911
3932
  };
@@ -3983,7 +4004,7 @@ type RevertContactMergeErrors = {
3983
4004
  */
3984
4005
  409: ErrorResponse;
3985
4006
  /**
3986
- * The backing SOAT platform could not complete the operation.
4007
+ * The upstream runtime could not complete the operation.
3987
4008
  */
3988
4009
  502: ErrorResponse;
3989
4010
  };
@@ -4037,7 +4058,7 @@ type ListAgentGenerationsErrors = {
4037
4058
  */
4038
4059
  404: ErrorResponse;
4039
4060
  /**
4040
- * The backing SOAT platform could not complete the operation.
4061
+ * The upstream runtime could not complete the operation.
4041
4062
  */
4042
4063
  502: ErrorResponse;
4043
4064
  };
@@ -4084,7 +4105,7 @@ type CreateGenerationErrors = {
4084
4105
  */
4085
4106
  404: ErrorResponse;
4086
4107
  /**
4087
- * The backing SOAT platform could not complete the operation.
4108
+ * The upstream runtime could not complete the operation.
4088
4109
  */
4089
4110
  502: ErrorResponse;
4090
4111
  };
@@ -4122,7 +4143,7 @@ type GetGenerationErrors = {
4122
4143
  */
4123
4144
  404: ErrorResponse;
4124
4145
  /**
4125
- * The backing SOAT platform could not complete the operation.
4146
+ * The upstream runtime could not complete the operation.
4126
4147
  */
4127
4148
  502: ErrorResponse;
4128
4149
  };
@@ -4159,7 +4180,7 @@ type GetGenerationUsageErrors = {
4159
4180
  */
4160
4181
  404: ErrorResponse;
4161
4182
  /**
4162
- * The backing SOAT platform could not complete the operation.
4183
+ * The upstream runtime could not complete the operation.
4163
4184
  */
4164
4185
  502: ErrorResponse;
4165
4186
  };
@@ -4392,7 +4413,7 @@ type QueryKnowledgeCollectionErrors = {
4392
4413
  */
4393
4414
  404: ErrorResponse;
4394
4415
  /**
4395
- * The backing SOAT platform could not complete the operation.
4416
+ * The upstream runtime could not complete the operation.
4396
4417
  */
4397
4418
  502: ErrorResponse;
4398
4419
  };
@@ -4438,7 +4459,7 @@ type ListKnowledgeDocumentsErrors = {
4438
4459
  */
4439
4460
  404: ErrorResponse;
4440
4461
  /**
4441
- * The backing SOAT platform could not complete the operation.
4462
+ * The upstream runtime could not complete the operation.
4442
4463
  */
4443
4464
  502: ErrorResponse;
4444
4465
  };
@@ -4485,7 +4506,7 @@ type CreateKnowledgeDocumentErrors = {
4485
4506
  */
4486
4507
  404: ErrorResponse;
4487
4508
  /**
4488
- * The backing SOAT platform could not complete the operation.
4509
+ * The upstream runtime could not complete the operation.
4489
4510
  */
4490
4511
  502: ErrorResponse;
4491
4512
  };
@@ -4509,7 +4530,7 @@ type DeleteKnowledgeDocumentData = {
4509
4530
  */
4510
4531
  collection_id: string;
4511
4532
  /**
4512
- * Knowledge document public ID (doc_ prefix) — the SOAT document id.
4533
+ * Knowledge document public ID (doc_ prefix) — the runtime document id.
4513
4534
  */
4514
4535
  document_id: string;
4515
4536
  };
@@ -4526,7 +4547,7 @@ type DeleteKnowledgeDocumentErrors = {
4526
4547
  */
4527
4548
  404: ErrorResponse;
4528
4549
  /**
4529
- * The backing SOAT platform could not complete the operation.
4550
+ * The upstream runtime could not complete the operation.
4530
4551
  */
4531
4552
  502: ErrorResponse;
4532
4553
  };
@@ -4550,7 +4571,7 @@ type GetKnowledgeDocumentData = {
4550
4571
  */
4551
4572
  collection_id: string;
4552
4573
  /**
4553
- * Knowledge document public ID (doc_ prefix) — the SOAT document id.
4574
+ * Knowledge document public ID (doc_ prefix) — the runtime document id.
4554
4575
  */
4555
4576
  document_id: string;
4556
4577
  };
@@ -4567,7 +4588,7 @@ type GetKnowledgeDocumentErrors = {
4567
4588
  */
4568
4589
  404: ErrorResponse;
4569
4590
  /**
4570
- * The backing SOAT platform could not complete the operation.
4591
+ * The upstream runtime could not complete the operation.
4571
4592
  */
4572
4593
  502: ErrorResponse;
4573
4594
  };
@@ -4591,7 +4612,7 @@ type ReingestKnowledgeDocumentData = {
4591
4612
  */
4592
4613
  collection_id: string;
4593
4614
  /**
4594
- * Knowledge document public ID (doc_ prefix) — the SOAT document id.
4615
+ * Knowledge document public ID (doc_ prefix) — the runtime document id.
4595
4616
  */
4596
4617
  document_id: string;
4597
4618
  };
@@ -4608,7 +4629,7 @@ type ReingestKnowledgeDocumentErrors = {
4608
4629
  */
4609
4630
  404: ErrorResponse;
4610
4631
  /**
4611
- * The backing SOAT platform could not complete the operation.
4632
+ * The upstream runtime could not complete the operation.
4612
4633
  */
4613
4634
  502: ErrorResponse;
4614
4635
  };
@@ -4637,7 +4658,7 @@ type ListModelsData = {
4637
4658
  */
4638
4659
  vendor?: string;
4639
4660
  /**
4640
- * Filter by the SOAT provider slug that serves the model.
4661
+ * Filter by the provider slug that serves the model.
4641
4662
  */
4642
4663
  provider?: string;
4643
4664
  /**
@@ -4790,7 +4811,7 @@ type DeleteProjectErrors = {
4790
4811
  */
4791
4812
  404: ErrorResponse;
4792
4813
  /**
4793
- * The project still has dependent resources in SOAT (retry with `force=true`).
4814
+ * The project still has dependent resources on the runtime (retry with `force=true`).
4794
4815
  */
4795
4816
  409: ErrorResponse;
4796
4817
  };
@@ -4975,7 +4996,7 @@ type CreateProviderErrors = {
4975
4996
  */
4976
4997
  404: ErrorResponse;
4977
4998
  /**
4978
- * The backing SOAT platform could not complete the operation.
4999
+ * The upstream runtime could not complete the operation.
4979
5000
  */
4980
5001
  502: ErrorResponse;
4981
5002
  };
@@ -5022,7 +5043,7 @@ type DeleteProviderErrors = {
5022
5043
  */
5023
5044
  409: ErrorResponse;
5024
5045
  /**
5025
- * The backing SOAT platform could not complete the operation.
5046
+ * The upstream runtime could not complete the operation.
5026
5047
  */
5027
5048
  502: ErrorResponse;
5028
5049
  };
@@ -5096,7 +5117,7 @@ type UpdateProviderErrors = {
5096
5117
  */
5097
5118
  404: ErrorResponse;
5098
5119
  /**
5099
- * The backing SOAT platform could not complete the operation.
5120
+ * The upstream runtime could not complete the operation.
5100
5121
  */
5101
5122
  502: ErrorResponse;
5102
5123
  };
@@ -5143,7 +5164,7 @@ type CreateSessionErrors = {
5143
5164
  */
5144
5165
  404: ErrorResponse;
5145
5166
  /**
5146
- * The backing SOAT platform could not complete the operation.
5167
+ * The upstream runtime could not complete the operation.
5147
5168
  */
5148
5169
  502: ErrorResponse;
5149
5170
  };
@@ -5184,7 +5205,7 @@ type GetSessionErrors = {
5184
5205
  */
5185
5206
  404: ErrorResponse;
5186
5207
  /**
5187
- * The backing SOAT platform could not complete the operation.
5208
+ * The upstream runtime could not complete the operation.
5188
5209
  */
5189
5210
  502: ErrorResponse;
5190
5211
  };
@@ -5229,7 +5250,7 @@ type AddSessionMessageErrors = {
5229
5250
  */
5230
5251
  404: ErrorResponse;
5231
5252
  /**
5232
- * The backing SOAT platform could not complete the operation.
5253
+ * The upstream runtime could not complete the operation.
5233
5254
  */
5234
5255
  502: ErrorResponse;
5235
5256
  };
@@ -5287,7 +5308,7 @@ type GenerateSessionResponseErrors = {
5287
5308
  */
5288
5309
  410: ErrorResponse;
5289
5310
  /**
5290
- * The backing SOAT platform could not complete the operation.
5311
+ * The upstream runtime could not complete the operation.
5291
5312
  */
5292
5313
  502: ErrorResponse;
5293
5314
  };
@@ -5349,7 +5370,7 @@ type ListTasksErrors = {
5349
5370
  */
5350
5371
  404: ErrorResponse;
5351
5372
  /**
5352
- * The backing SOAT platform could not complete the operation.
5373
+ * The upstream runtime could not complete the operation.
5353
5374
  */
5354
5375
  502: ErrorResponse;
5355
5376
  };
@@ -5392,7 +5413,7 @@ type CreateTaskErrors = {
5392
5413
  */
5393
5414
  404: ErrorResponse;
5394
5415
  /**
5395
- * The backing SOAT platform could not complete the operation.
5416
+ * The upstream runtime could not complete the operation.
5396
5417
  */
5397
5418
  502: ErrorResponse;
5398
5419
  };
@@ -5429,7 +5450,7 @@ type DeleteTaskErrors = {
5429
5450
  */
5430
5451
  404: ErrorResponse;
5431
5452
  /**
5432
- * The backing SOAT platform could not complete the operation.
5453
+ * The upstream runtime could not complete the operation.
5433
5454
  */
5434
5455
  502: ErrorResponse;
5435
5456
  };
@@ -5466,7 +5487,7 @@ type GetTaskErrors = {
5466
5487
  */
5467
5488
  404: ErrorResponse;
5468
5489
  /**
5469
- * The backing SOAT platform could not complete the operation.
5490
+ * The upstream runtime could not complete the operation.
5470
5491
  */
5471
5492
  502: ErrorResponse;
5472
5493
  };
@@ -5507,7 +5528,7 @@ type UpdateTaskErrors = {
5507
5528
  */
5508
5529
  404: ErrorResponse;
5509
5530
  /**
5510
- * The backing SOAT platform could not complete the operation.
5531
+ * The upstream runtime could not complete the operation.
5511
5532
  */
5512
5533
  502: ErrorResponse;
5513
5534
  };
@@ -5552,7 +5573,7 @@ type TransitionTaskErrors = {
5552
5573
  */
5553
5574
  409: ErrorResponse;
5554
5575
  /**
5555
- * The backing SOAT platform could not complete the operation.
5576
+ * The upstream runtime could not complete the operation.
5556
5577
  */
5557
5578
  502: ErrorResponse;
5558
5579
  };
@@ -5589,7 +5610,7 @@ type ListTaskTransitionsErrors = {
5589
5610
  */
5590
5611
  404: ErrorResponse;
5591
5612
  /**
5592
- * The backing SOAT platform could not complete the operation.
5613
+ * The upstream runtime could not complete the operation.
5593
5614
  */
5594
5615
  502: ErrorResponse;
5595
5616
  };
@@ -5670,7 +5691,7 @@ type CreateToolErrors = {
5670
5691
  */
5671
5692
  404: ErrorResponse;
5672
5693
  /**
5673
- * The backing SOAT platform could not complete the operation.
5694
+ * The upstream runtime could not complete the operation.
5674
5695
  */
5675
5696
  502: ErrorResponse;
5676
5697
  };
@@ -5711,7 +5732,7 @@ type DeleteToolErrors = {
5711
5732
  */
5712
5733
  409: ErrorResponse;
5713
5734
  /**
5714
- * The backing SOAT platform could not complete the operation.
5735
+ * The upstream runtime could not complete the operation.
5715
5736
  */
5716
5737
  502: ErrorResponse;
5717
5738
  };
@@ -5785,7 +5806,7 @@ type UpdateToolErrors = {
5785
5806
  */
5786
5807
  404: ErrorResponse;
5787
5808
  /**
5788
- * The backing SOAT platform could not complete the operation.
5809
+ * The upstream runtime could not complete the operation.
5789
5810
  */
5790
5811
  502: ErrorResponse;
5791
5812
  };
@@ -5831,7 +5852,7 @@ type ListTracesErrors = {
5831
5852
  */
5832
5853
  404: ErrorResponse;
5833
5854
  /**
5834
- * The backing SOAT platform could not complete the operation.
5855
+ * The upstream runtime could not complete the operation.
5835
5856
  */
5836
5857
  502: ErrorResponse;
5837
5858
  };
@@ -5868,7 +5889,7 @@ type GetTraceErrors = {
5868
5889
  */
5869
5890
  404: ErrorResponse;
5870
5891
  /**
5871
- * The backing SOAT platform could not complete the operation.
5892
+ * The upstream runtime could not complete the operation.
5872
5893
  */
5873
5894
  502: ErrorResponse;
5874
5895
  };
@@ -5915,7 +5936,7 @@ type GetTraceTreeErrors = {
5915
5936
  */
5916
5937
  404: ErrorResponse;
5917
5938
  /**
5918
- * The backing SOAT platform could not complete the operation.
5939
+ * The upstream runtime could not complete the operation.
5919
5940
  */
5920
5941
  502: ErrorResponse;
5921
5942
  };
@@ -5969,7 +5990,7 @@ type ListTraceGenerationsErrors = {
5969
5990
  */
5970
5991
  404: ErrorResponse;
5971
5992
  /**
5972
- * The backing SOAT platform could not complete the operation.
5993
+ * The upstream runtime could not complete the operation.
5973
5994
  */
5974
5995
  502: ErrorResponse;
5975
5996
  };
@@ -6013,7 +6034,7 @@ declare class Agents {
6013
6034
  /**
6014
6035
  * Delete an agent
6015
6036
  *
6016
- * Deletes the backing SOAT agent. Returns 409 if the agent still has dependent generations or traces — pass `force=true` to delete those along with the agent (destructive and irreversible).
6037
+ * Deletes the backing runtime agent. Returns 409 if the agent still has dependent generations or traces — pass `force=true` to delete those along with the agent (destructive and irreversible).
6017
6038
  *
6018
6039
  */
6019
6040
  static deleteAgent<ThrowOnError extends boolean = false>(options: Options<DeleteAgentData, ThrowOnError>): RequestResult<DeleteAgentResponses, DeleteAgentErrors, ThrowOnError>;
@@ -6024,7 +6045,7 @@ declare class Agents {
6024
6045
  /**
6025
6046
  * Update an agent
6026
6047
  *
6027
- * Change the bound provider, name, model, instructions, sampling/step config, attached tools (tool_ids/tool_choice), or the naturali-side status. At least one field is required.
6048
+ * Change the bound provider, name, model, instructions, sampling/step config, attached tools (tool_ids/tool_choice), the structured-output schema (output_schema), or the naturali-side status. At least one field is required.
6028
6049
  *
6029
6050
  */
6030
6051
  static updateAgent<ThrowOnError extends boolean = false>(options: Options<UpdateAgentData, ThrowOnError>): RequestResult<UpdateAgentResponses, UpdateAgentErrors, ThrowOnError>;
@@ -6203,7 +6224,7 @@ declare class Channels {
6203
6224
  /**
6204
6225
  * List the channel's conversations
6205
6226
  *
6206
- * A cursor page of the channel's conversations, newest first. A conversation is one contact's dialogue on the channel — the continuity anchor that resumes the same SOAT session instead of starting fresh per message — so this is the read path for who has talked to the channel and which actor/session their dialogue resolved to.
6227
+ * A cursor page of the channel's conversations, newest first. A conversation is one contact's dialogue on the channel — the continuity anchor that resumes the same runtime session instead of starting fresh per message — so this is the read path for who has talked to the channel and which actor/session their dialogue resolved to.
6207
6228
  * Conversations are created by the inbound path (the WhatsApp webhook, the Discord gateway worker) when a real message arrives; there is no way to create one directly.
6208
6229
  *
6209
6230
  */
@@ -6215,7 +6236,7 @@ declare class Channels {
6215
6236
  /**
6216
6237
  * Read a conversation's transcript
6217
6238
  *
6218
- * The conversation's messages, oldest first. naturali stores no message bodies — the dialogue lives in the SOAT session the conversation maps to, so this reads through to SOAT. Pagination is `limit`/`offset` rather than an opaque cursor because the upstream is offset-based over a stable `position` ordering.
6239
+ * The conversation's messages, oldest first. naturali stores no message bodies — the dialogue lives in the runtime session the conversation maps to, so this reads through to the runtime. Pagination is `limit`/`offset` rather than an opaque cursor because the upstream is offset-based over a stable `position` ordering.
6219
6240
  *
6220
6241
  */
6221
6242
  static listChannelConversationMessages<ThrowOnError extends boolean = false>(options: Options<ListChannelConversationMessagesData, ThrowOnError>): RequestResult<ListChannelConversationMessagesResponses, ListChannelConversationMessagesErrors, ThrowOnError>;
@@ -6233,14 +6254,14 @@ declare class Contacts {
6233
6254
  * Create a contact
6234
6255
  *
6235
6256
  * Record a contact the customer already knows about, optionally with the identifiers it is expected to arrive at.
6236
- * Optional by design — the inbound path creates contacts on its own. This is for the embedder who has a user in their own system and wants naturali to agree about who that is before the first message, which is what makes `external_id` (and, through it, a session's `tool_context`) useful. No SOAT actor is created here; the contact gets one on first need.
6257
+ * Optional by design — the inbound path creates contacts on its own. This is for the embedder who has a user in their own system and wants naturali to agree about who that is before the first message, which is what makes `external_id` (and, through it, a session's `tool_context`) useful. No runtime actor is created here; the contact gets one on first need.
6237
6258
  *
6238
6259
  */
6239
6260
  static createContact<ThrowOnError extends boolean = false>(options: Options<CreateContactData, ThrowOnError>): RequestResult<CreateContactResponses, CreateContactErrors, ThrowOnError>;
6240
6261
  /**
6241
6262
  * Erase a contact
6242
6263
  *
6243
- * **Erasure (C4/LGPD).** Not a soft delete and not reversible: the contact's sessions — with their messages and media — its SOAT actor, its memory container and every identifier it was reachable at are removed, along with the merge records that reference it.
6264
+ * **Erasure (C4/LGPD).** Not a soft delete and not reversible: the contact's sessions — with their messages and media — its runtime actor, its memory container and every identifier it was reachable at are removed, along with the merge records that reference it.
6244
6265
  * The upstream deletes happen first, so a failure there aborts before the local pointers are dropped and a retry can still find what is left. A contact that was merged into another cannot be erased directly: its data lives with the survivor, so erase that one.
6245
6266
  *
6246
6267
  */
@@ -6281,7 +6302,7 @@ declare class Contacts {
6281
6302
  * Merge another contact into this one
6282
6303
  *
6283
6304
  * Fold `source_contact_id` into this contact — "same human, two identifiers" (C4).
6284
- * What moves: every identity and every conversation, so the survivor's history is the union of both. What is *shared* rather than moved: agent memory — SOAT hangs it off the actor, so the source's actor is re-pointed at the survivor's memory container and both keep answering with one recollection. Existing sessions keep working, which is the point of not rewriting them.
6305
+ * What moves: every identity and every conversation, so the survivor's history is the union of both. What is *shared* rather than moved: agent memory — the runtime hangs it off the actor, so the source's actor is re-pointed at the survivor's memory container and both keep answering with one recollection. Existing sessions keep working, which is the point of not rewriting them.
6285
6306
  * The source is not deleted: it stays as a tombstone pointing at the survivor, and the returned merge record lists exactly what moved, so the merge can be audited and reverted.
6286
6307
  *
6287
6308
  */
@@ -6313,7 +6334,7 @@ declare class Generations {
6313
6334
  /**
6314
6335
  * Run an agent generation
6315
6336
  *
6316
- * Sends messages to the agent, resolves its tools, and runs the model loop. Returns the final text when `status` is `completed` (plus `object` when the agent has an output schema), or the pending `tool_calls` when `status` is `requires_action`. With `stream: true` the response is a Server-Sent Events stream (Content-Type text/event-stream) proxied from SOAT instead of a single JSON body.
6337
+ * Sends messages to the agent, resolves its tools, and runs the model loop. Returns the final text when `status` is `completed` (plus `object` when the agent has an output schema), or the pending `tool_calls` when `status` is `requires_action`. With `stream: true` the response is a Server-Sent Events stream (Content-Type text/event-stream) proxied from the runtime instead of a single JSON body.
6317
6338
  *
6318
6339
  */
6319
6340
  static createGeneration<ThrowOnError extends boolean = false>(options: Options<CreateGenerationData, ThrowOnError>): RequestResult<CreateGenerationResponses, CreateGenerationErrors, ThrowOnError>;
@@ -6328,7 +6349,7 @@ declare class Generations {
6328
6349
  /**
6329
6350
  * Get a generation's cost
6330
6351
  *
6331
- * What this one generation cost, and the tokens it was charged on — the billing-grade receipt SOAT froze at write time, per model line item.
6352
+ * What this one generation cost, and the tokens it was charged on — the billing-grade receipt the runtime froze at write time, per model line item.
6332
6353
  * This is the per-generation grain that `GET /v1/projects/{project_id}/usage` cannot express: that meter buckets a whole project by model, agent, run, day or meter type, and a run can hold more than one generation. Use this to price a single turn, and the project meter to roll spend up.
6333
6354
  * `cost_usd` is `null` when nothing was priced — never that the work was free. Only naturali-managed providers are priced; a BYOK generation runs on your own provider account, so it carries no LLM cost here (its tokens are still reported).
6334
6355
  * A generation belonging to another project responds `404`, not `403`.
@@ -6434,7 +6455,7 @@ declare class Projects {
6434
6455
  /**
6435
6456
  * Delete a project
6436
6457
  *
6437
- * Permanently deletes the project and its backing SOAT project. Fails with 409 if the SOAT project still has dependent resources — remove them first, or pass `force=true` to delete the project and all its dependents (agents, providers, tools, sessions, generations, traces). Forcing is destructive and irreversible.
6458
+ * Permanently deletes the project and its backing runtime project. Fails with 409 if the runtime project still has dependent resources — remove them first, or pass `force=true` to delete the project and all its dependents (agents, providers, tools, sessions, generations, traces). Forcing is destructive and irreversible.
6438
6459
  *
6439
6460
  */
6440
6461
  static deleteProject<ThrowOnError extends boolean = false>(options: Options<DeleteProjectData, ThrowOnError>): RequestResult<DeleteProjectResponses, DeleteProjectErrors, ThrowOnError>;
@@ -6451,7 +6472,7 @@ declare class Projects {
6451
6472
  /**
6452
6473
  * Get per-project usage
6453
6474
  *
6454
- * The per-project meter — the re-billing view (A11/C12/P3). Aggregates the project's usage over an optional [from, to] window, bucketed by a single dimension. Costs are the billing-grade cost_usd SOAT freezes at write time; null means nothing in the bucket was priced (never that it was free). Only managed providers are priced (on SOAT), so cost reflects managed usage; BYOK usage carries no LLM cost.
6475
+ * The per-project meter — the re-billing view (A11/C12/P3). Aggregates the project's usage over an optional [from, to] window, bucketed by a single dimension. Costs are the billing-grade cost_usd the runtime freezes at write time; null means nothing in the bucket was priced (never that it was free). Only managed providers are priced (on the runtime), so cost reflects managed usage; BYOK usage carries no LLM cost.
6455
6476
  *
6456
6477
  */
6457
6478
  static getProjectUsage<ThrowOnError extends boolean = false>(options: Options<GetProjectUsageData, ThrowOnError>): RequestResult<GetProjectUsageResponses, GetProjectUsageErrors, ThrowOnError>;
@@ -6466,14 +6487,14 @@ declare class Providers {
6466
6487
  /**
6467
6488
  * Register a provider (managed or BYOK)
6468
6489
  *
6469
- * Register a managed provider (naturali-keyed, priced on SOAT) or a BYOK provider (your credentials, stored write-only and never priced). See ProviderCreate for the fields each mode takes.
6490
+ * Register a managed provider (naturali-keyed, priced on the runtime) or a BYOK provider (your credentials, stored write-only and never priced). See ProviderCreate for the fields each mode takes.
6470
6491
  *
6471
6492
  */
6472
6493
  static createProvider<ThrowOnError extends boolean = false>(options: Options<CreateProviderData, ThrowOnError>): RequestResult<CreateProviderResponses, CreateProviderErrors, ThrowOnError>;
6473
6494
  /**
6474
6495
  * Delete a provider
6475
6496
  *
6476
- * Deletes the backing SOAT ai_provider and its secret. Returns 409 if the provider is still referenced by live resources (agents) — detach those first. `force=true` clears only soft dependents (price overrides, usage history); live references always block deletion.
6497
+ * Deletes the backing provider record on the runtime and its secret. Returns 409 if the provider is still referenced by live resources (agents) — detach those first. `force=true` clears only soft dependents (price overrides, usage history); live references always block deletion.
6477
6498
  *
6478
6499
  */
6479
6500
  static deleteProvider<ThrowOnError extends boolean = false>(options: Options<DeleteProviderData, ThrowOnError>): RequestResult<DeleteProviderResponses, DeleteProviderErrors, ThrowOnError>;
@@ -6493,14 +6514,14 @@ declare class Sessions {
6493
6514
  /**
6494
6515
  * Open a session
6495
6516
  *
6496
- * Opens a durable session against the agent. The session accumulates messages and is resumable by id; its lifecycle (open / closed / expired) and configuration live in the backing SOAT session.
6517
+ * Opens a durable session against the agent. The session accumulates messages and is resumable by id; its lifecycle (open / closed / expired) and configuration live in the backing runtime session.
6497
6518
  *
6498
6519
  */
6499
6520
  static createSession<ThrowOnError extends boolean = false>(options: Options<CreateSessionData, ThrowOnError>): RequestResult<CreateSessionResponses, CreateSessionErrors, ThrowOnError>;
6500
6521
  /**
6501
6522
  * Get a session
6502
6523
  *
6503
- * Returns the session's current state — status, activity timestamps and configuration — read live from the backing SOAT session, so a resumed session reflects everything that has happened since it was opened.
6524
+ * Returns the session's current state — status, activity timestamps and configuration — read live from the backing runtime session, so a resumed session reflects everything that has happened since it was opened.
6504
6525
  *
6505
6526
  */
6506
6527
  static getSession<ThrowOnError extends boolean = false>(options: Options<GetSessionData, ThrowOnError>): RequestResult<GetSessionResponses, GetSessionErrors, ThrowOnError>;
@@ -6589,7 +6610,7 @@ declare class Tools {
6589
6610
  /**
6590
6611
  * Delete a tool
6591
6612
  *
6592
- * Deletes the backing SOAT tool. Returns 409 if the tool is still attached to an agent (detach it first).
6613
+ * Deletes the backing runtime tool. Returns 409 if the tool is still attached to an agent (detach it first).
6593
6614
  *
6594
6615
  */
6595
6616
  static deleteTool<ThrowOnError extends boolean = false>(options: Options<DeleteToolData, ThrowOnError>): RequestResult<DeleteToolResponses, DeleteToolErrors, ThrowOnError>;