@soat/sdk 0.56.0 → 0.58.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
@@ -487,6 +487,16 @@ type Agent = {
487
487
  *
488
488
  */
489
489
  min_score?: number;
490
+ /**
491
+ * The `k` in the fusion term `1 / (k + rank)`, the same knob knowledge search takes. Smaller weights the top of each ranking more heavily. Omitted, the deployment's `KNOWLEDGE_RRF_K` applies.
492
+ *
493
+ */
494
+ rrf_k?: number;
495
+ /**
496
+ * Half-life in days of the decay applied to **memory** results after fusion, the same knob knowledge search takes. `0` disables it. Omitted, the deployment's `KNOWLEDGE_RECENCY_HALF_LIFE_DAYS` applies.
497
+ *
498
+ */
499
+ recency_half_life_days?: number;
490
500
  /**
491
501
  * Maximum number of results to inject. Omitted, 10 are injected.
492
502
  *
@@ -691,6 +701,16 @@ type CreateAgentRequest = {
691
701
  *
692
702
  */
693
703
  min_score?: number;
704
+ /**
705
+ * The `k` in the fusion term `1 / (k + rank)`, the same knob knowledge search takes. Smaller weights the top of each ranking more heavily. Omitted, the deployment's `KNOWLEDGE_RRF_K` applies.
706
+ *
707
+ */
708
+ rrf_k?: number;
709
+ /**
710
+ * Half-life in days of the decay applied to **memory** results after fusion, the same knob knowledge search takes. `0` disables it. Omitted, the deployment's `KNOWLEDGE_RECENCY_HALF_LIFE_DAYS` applies.
711
+ *
712
+ */
713
+ recency_half_life_days?: number;
694
714
  /**
695
715
  * Maximum number of results to inject. Omitted, 10 are injected.
696
716
  *
@@ -789,6 +809,16 @@ type UpdateAgentRequest = {
789
809
  *
790
810
  */
791
811
  min_score?: number;
812
+ /**
813
+ * The `k` in the fusion term `1 / (k + rank)`, the same knob knowledge search takes. Smaller weights the top of each ranking more heavily. Omitted, the deployment's `KNOWLEDGE_RRF_K` applies.
814
+ *
815
+ */
816
+ rrf_k?: number;
817
+ /**
818
+ * Half-life in days of the decay applied to **memory** results after fusion, the same knob knowledge search takes. `0` disables it. Omitted, the deployment's `KNOWLEDGE_RECENCY_HALF_LIFE_DAYS` applies.
819
+ *
820
+ */
821
+ recency_half_life_days?: number;
792
822
  /**
793
823
  * Maximum number of results to inject. Omitted, 10 are injected.
794
824
  *
@@ -834,6 +864,10 @@ type UpdateAgentRequest = {
834
864
  * Optional tag for the config version this write archives (e.g. `pre-tone-change`). Annotates the version only — it is not stored on the agent and is not part of the config, so labelling a change is never itself a change. Ignored when the write changes nothing, since no version is created.
835
865
  */
836
866
  version_label?: string | null;
867
+ /**
868
+ * Refuses the write unless the resource is at this version.
869
+ */
870
+ expected_version?: ExpectedVersion;
837
871
  };
838
872
  type CreateAgentGenerationRequest = {
839
873
  messages: Array<{
@@ -879,11 +913,9 @@ type CreateAgentGenerationRequest = {
879
913
  /**
880
914
  * Caller-supplied key/value metadata attached to the generation record for per-run audit attribution (e.g. the knowledge-corpus version that produced this action). Round-trips verbatim when the generation is fetched via the generations API. The bag is caller-owned and no key is reserved: server-owned state (usage attribution, the served agent version, the model route's record, the extraction summary) lives in its own top-level generation fields and cannot be written from here. Use the request's own `action_id` field to set the usage-attribution label.
881
915
  */
882
- metadata?: {
883
- [key: string]: unknown;
884
- } | null;
916
+ metadata?: NullableMetadataBag;
885
917
  /**
886
- * Per-generation knowledge retrieval override. Array filters (memory_store_ids, document_ids, document_paths) are unioned with the agent's stored knowledge_config; `tags` pairs are merged with the override winning per key; scalar fields (min_score, limit) use the per-generation value when present.
918
+ * Per-generation knowledge retrieval override. Array filters (memory_store_ids, document_ids, document_paths) are unioned with the agent's stored knowledge_config; `tags` pairs are merged with the override winning per key; scalar fields (min_score, rrf_k, recency_half_life_days, limit) use the per-generation value when present.
887
919
  */
888
920
  knowledge_config?: {
889
921
  memory_store_ids?: Array<string>;
@@ -898,6 +930,16 @@ type CreateAgentGenerationRequest = {
898
930
  *
899
931
  */
900
932
  min_score?: number;
933
+ /**
934
+ * The `k` in the fusion term `1 / (k + rank)`, the same knob knowledge search takes. Smaller weights the top of each ranking more heavily. Omitted, the deployment's `KNOWLEDGE_RRF_K` applies.
935
+ *
936
+ */
937
+ rrf_k?: number;
938
+ /**
939
+ * Half-life in days of the decay applied to **memory** results after fusion, the same knob knowledge search takes. `0` disables it. Omitted, the deployment's `KNOWLEDGE_RECENCY_HALF_LIFE_DAYS` applies.
940
+ *
941
+ */
942
+ recency_half_life_days?: number;
901
943
  /**
902
944
  * Maximum number of results to inject. Omitted, 10 are injected.
903
945
  *
@@ -1545,6 +1587,14 @@ type ChatCompletionResponse = {
1545
1587
  };
1546
1588
  };
1547
1589
  };
1590
+ /**
1591
+ * The version the caller believes the resource holds. When the resource is at any other version the write is refused with `409 VERSION_CONFLICT` and nothing is written; `meta.current_version` on that response names the version in force.
1592
+ *
1593
+ * Omit it to write unconditionally. Omitting it does not make the write unordered: two writes that reach the server together are still serialized, and the one whose version was taken first is refused the same way. What the field adds is refusing a write whose author read the resource some time ago and has not seen what happened since.
1594
+ *
1595
+ * The `If-Match` header carries the same precondition for a client that prefers the HTTP spelling. Sending both with different versions is `400 VALIDATION_FAILED`.
1596
+ */
1597
+ type ExpectedVersion = number | null;
1548
1598
  type ConversationRecord = {
1549
1599
  /**
1550
1600
  * Conversation ID
@@ -1603,9 +1653,7 @@ type ConversationMessageRecord = {
1603
1653
  /**
1604
1654
  * Optional structured metadata attached to the message
1605
1655
  */
1606
- metadata?: {
1607
- [key: string]: unknown;
1608
- } | null;
1656
+ metadata?: NullableMetadataBag;
1609
1657
  /**
1610
1658
  * Full text content of the message
1611
1659
  */
@@ -1661,6 +1709,42 @@ type GenerateConversationMessageResponse = ({
1661
1709
  } & GenerateConversationMessageCompleted) | ({
1662
1710
  status: 'requires_action';
1663
1711
  } & GenerateConversationMessageRequiresAction);
1712
+ /**
1713
+ * An immutable archive of a document's content and annotations at one version.
1714
+ */
1715
+ type DocumentVersion = {
1716
+ /**
1717
+ * Public ID of the archived version
1718
+ */
1719
+ id?: string;
1720
+ /**
1721
+ * Public ID of the document this version belongs to
1722
+ */
1723
+ document_id?: string;
1724
+ /**
1725
+ * The archived version number
1726
+ */
1727
+ version?: number;
1728
+ /**
1729
+ * The document's versioned surface as it stood at this version: its `content`, `title`, `path`, `metadata`, `tags` and chunk configuration. A full snapshot rather than a diff, because what a restore has to reproduce is what a run read — which is a read by version, and a diff chain would have to be replayed to answer it.
1730
+ *
1731
+ * A withdrawal is archived as a version too, carrying `withdrawn: true` and no content. Restoring one is refused; restore the version before it.
1732
+ *
1733
+ * Deliberately open rather than a fixed schema: an archive written by an earlier release of SOAT reflects the document surface **of its own time**, so it may carry fields the current API no longer documents.
1734
+ */
1735
+ config?: {
1736
+ [key: string]: unknown;
1737
+ };
1738
+ /**
1739
+ * Optional human tag for this version, e.g. `pre-correction`. Set from the `version_label` of the write that archived it, or generated for a restore or a withdrawal.
1740
+ */
1741
+ label?: string | null;
1742
+ /**
1743
+ * Public ID of the user whose write produced this version; null for a write with no request user behind it.
1744
+ */
1745
+ created_by?: string | null;
1746
+ created_at?: Date;
1747
+ };
1664
1748
  type DocumentRecord = {
1665
1749
  /**
1666
1750
  * Document ID
@@ -1691,9 +1775,13 @@ type DocumentRecord = {
1691
1775
  */
1692
1776
  size?: number;
1693
1777
  /**
1694
- * Ingestion lifecycle state. `pending` — enqueued; `processing` — chunks being extracted and embedded; `ready` — fully indexed; `failed` — processing error (see the `error` field on `GET /documents/{id}/status`).
1778
+ * Ingestion lifecycle state. `pending` — enqueued; `processing` — chunks being extracted and embedded; `ready` — fully indexed; `failed` — processing error (see the `error` field on `GET /documents/{id}/status`); `withdrawn` — taken out of listings and search, with its chunks dropped, and restorable from an earlier version.
1695
1779
  */
1696
- status?: 'pending' | 'processing' | 'ready' | 'failed';
1780
+ status?: 'pending' | 'processing' | 'ready' | 'failed' | 'withdrawn';
1781
+ /**
1782
+ * The document's content version, starting at 1. Every write that changes the content or its annotations archives the state it replaced and increments this.
1783
+ */
1784
+ version?: number;
1697
1785
  /**
1698
1786
  * Text content (only present on getDocument, and only when status is ready)
1699
1787
  */
@@ -1710,9 +1798,32 @@ type DocumentRecord = {
1710
1798
  * Overlap in characters between consecutive windows used when `chunk_strategy=size`. Absent otherwise.
1711
1799
  */
1712
1800
  chunk_overlap?: number;
1801
+ /**
1802
+ * The typed edges this document asserts about others, on a single document read. Absent from a listing, which is a page of documents rather than of edges.
1803
+ */
1804
+ relations?: Array<DocumentRelation>;
1713
1805
  created_at?: Date;
1714
1806
  updated_at?: Date;
1715
1807
  };
1808
+ /**
1809
+ * A typed edge one document asserts about another, within one project.
1810
+ */
1811
+ type DocumentRelation = {
1812
+ id?: string;
1813
+ /**
1814
+ * What the asserting document claims: it was `derived_from` the other, `supersedes` it, or `cites` it.
1815
+ */
1816
+ type?: 'derived_from' | 'supersedes' | 'cites';
1817
+ /**
1818
+ * The document that asserts the edge
1819
+ */
1820
+ from_document_id?: string;
1821
+ /**
1822
+ * The document the edge points at
1823
+ */
1824
+ to_document_id?: string;
1825
+ created_at?: Date;
1826
+ };
1716
1827
  type IngestedDocumentRecord = DocumentRecord & {
1717
1828
  /**
1718
1829
  * Number of chunks created from the file.
@@ -1915,9 +2026,7 @@ type DatasetItem = {
1915
2026
  dataset_id?: string;
1916
2027
  input?: DatasetItemInput;
1917
2028
  expected_output?: string | null;
1918
- metadata?: {
1919
- [key: string]: unknown;
1920
- } | null;
2029
+ metadata?: NullableMetadataBag;
1921
2030
  /**
1922
2031
  * The generation this item was curated from. A curated item is a deliberate fixture: erasing the source generation neither deletes nor mutates it.
1923
2032
  */
@@ -2013,9 +2122,7 @@ type EvalRun = {
2013
2122
  /**
2014
2123
  * The caller-owned key/value metadata supplied when the run was started, returned verbatim. Null when the run was started without any (a trigger-started run included — see `trigger_id` for that provenance). The server writes nothing here.
2015
2124
  */
2016
- metadata?: {
2017
- [key: string]: unknown;
2018
- } | null;
2125
+ metadata?: NullableMetadataBag;
2019
2126
  started_at?: Date | null;
2020
2127
  finished_at?: Date | null;
2021
2128
  created_at?: Date;
@@ -2124,10 +2231,7 @@ type UploadFileBase64Request = {
2124
2231
  * MIME type of the file
2125
2232
  */
2126
2233
  content_type?: string;
2127
- /**
2128
- * JSON string with additional metadata
2129
- */
2130
- metadata?: string;
2234
+ metadata?: MetadataBag;
2131
2235
  };
2132
2236
  type PresignedUrlRequest = {
2133
2237
  /**
@@ -2174,10 +2278,7 @@ type UploadFileWithTokenRequest = {
2174
2278
  * MIME type of the file (overrides the token's content type)
2175
2279
  */
2176
2280
  content_type?: string;
2177
- /**
2178
- * JSON string with additional metadata
2179
- */
2180
- metadata?: string;
2281
+ metadata?: MetadataBag;
2181
2282
  };
2182
2283
  /**
2183
2284
  * Stored file metadata
@@ -2207,10 +2308,7 @@ type FileRecord = {
2207
2308
  * File size in bytes
2208
2309
  */
2209
2310
  size?: number | null;
2210
- /**
2211
- * JSON string with additional metadata
2212
- */
2213
- metadata?: string | null;
2311
+ metadata?: NullableMetadataBag;
2214
2312
  tags?: TagBag;
2215
2313
  /**
2216
2314
  * Creation timestamp
@@ -2251,9 +2349,7 @@ type FormationTemplate = {
2251
2349
  * Arbitrary metadata attached to the template. Supports the same substitution as `outputs`: `{ "ref": "logicalId" }` resolves to a created resource's physical ID, and `{ "param": "ParamName" }` / `{ "sub": "text ${ParamName}" }` embed parameter values. The raw expressions are preserved here; the resolved values from the last deploy are exposed on the formation's `resolved_metadata` field.
2252
2350
  *
2253
2351
  */
2254
- metadata?: {
2255
- [key: string]: unknown;
2256
- } | null;
2352
+ metadata?: NullableMetadataBag;
2257
2353
  };
2258
2354
  type ParameterDeclaration = {
2259
2355
  /**
@@ -2439,9 +2535,17 @@ type AgentResourceProperties = {
2439
2535
  */
2440
2536
  tags?: TagBag;
2441
2537
  /**
2442
- * Minimum similarity score (0–1) for retrieved chunks
2538
+ * Minimum raw cosine similarity (0–1) a vector candidate must reach to be ranked. Omitted, there is no floor.
2443
2539
  */
2444
2540
  min_score?: number;
2541
+ /**
2542
+ * The `k` in the fusion term `1 / (k + rank)`; smaller weights the top of each ranking more heavily
2543
+ */
2544
+ rrf_k?: number;
2545
+ /**
2546
+ * Half-life in days of the decay applied to memory results after fusion; `0` disables it
2547
+ */
2548
+ recency_half_life_days?: number;
2445
2549
  /**
2446
2550
  * Maximum number of chunks to inject
2447
2551
  */
@@ -2689,9 +2793,7 @@ type DatasetItemResourceProperties = {
2689
2793
  /**
2690
2794
  * Free-form tags on the case, e.g. `{"topic": "billing"}`
2691
2795
  */
2692
- metadata?: {
2693
- [key: string]: unknown;
2694
- } | null;
2796
+ metadata?: NullableMetadataBag;
2695
2797
  };
2696
2798
  /**
2697
2799
  * Binds an agent under test to a dataset and the scorers its outputs are judged by. `pass_threshold` is the pass rate a run must reach for its `passed` verdict — the gate an agent-version promotion consumes.
@@ -2743,9 +2845,7 @@ type DocumentResourceProperties = {
2743
2845
  /**
2744
2846
  * Arbitrary metadata key-value pairs
2745
2847
  */
2746
- metadata?: {
2747
- [key: string]: unknown;
2748
- } | null;
2848
+ metadata?: NullableMetadataBag;
2749
2849
  /**
2750
2850
  * Tag key-value pairs for filtering
2751
2851
  */
@@ -2814,9 +2914,7 @@ type MemoryResourceProperties = {
2814
2914
  /**
2815
2915
  * Arbitrary structured metadata attached to the memory
2816
2916
  */
2817
- metadata?: {
2818
- [key: string]: unknown;
2819
- } | null;
2917
+ metadata?: NullableMetadataBag;
2820
2918
  };
2821
2919
  /**
2822
2920
  * Declares a model route within the formation's project: a named, ordered list of provider+model failover targets with retry and circuit-breaker configuration. Consumers reference it through their own `model_route_id`, or inherit it as the project's `default_model_route_id`.
@@ -2915,6 +3013,12 @@ type TriggerResourceProperties = {
2915
3013
  input?: {
2916
3014
  [key: string]: unknown;
2917
3015
  } | null;
3016
+ /**
3017
+ * Caller context every firing forwards to the run it starts, so an agent whose tools authorize through `{{context:<key>}}` can be scheduled. Write-only. A value may be a `{{secret:...}}` reference, which is what a template should carry — the credential stays in the secret store and only its name is checked in
3018
+ */
3019
+ tool_context?: {
3020
+ [key: string]: string;
3021
+ } | null;
2918
3022
  /**
2919
3023
  * 5-field cron expression (UTC). Required when type is schedule
2920
3024
  */
@@ -3004,9 +3108,9 @@ type FileResourceProperties = {
3004
3108
  */
3005
3109
  size?: number | null;
3006
3110
  /**
3007
- * JSON string with additional metadata
3111
+ * Caller-owned annotations on the file, stored as the object they were written as; `null` clears the bag. Keys are stored and returned verbatim in the casing supplied.
3008
3112
  */
3009
- metadata?: string | null;
3113
+ metadata?: NullableMetadataBag;
3010
3114
  };
3011
3115
  /**
3012
3116
  * Creates an access-control policy within the formation's project.
@@ -3120,7 +3224,7 @@ type SessionResourceProperties = {
3120
3224
  */
3121
3225
  inactivity_ttl_seconds?: number;
3122
3226
  /**
3123
- * Optional context object passed to tool calls
3227
+ * Optional context object passed to tool calls. Write-only: no read of a session returns it.
3124
3228
  */
3125
3229
  tool_context?: {
3126
3230
  [key: string]: unknown;
@@ -3175,9 +3279,7 @@ type IngestionRuleResourceProperties = {
3175
3279
  /**
3176
3280
  * Arbitrary JSON metadata
3177
3281
  */
3178
- metadata?: {
3179
- [key: string]: unknown;
3180
- } | null;
3282
+ metadata?: NullableMetadataBag;
3181
3283
  };
3182
3284
  /**
3183
3285
  * Declares what a memory store accepts from completed agent turns: a selector, an event, and a handler. With neither `agent_id` nor `tool_id` the built-in extractor runs, configurable through `prompt`, `ai_provider_id` and `model`. See the Memory Rules section of the Memories module docs.
@@ -3298,6 +3400,25 @@ type WorkflowResourceProperties = {
3298
3400
  [key: string]: unknown;
3299
3401
  } | null;
3300
3402
  };
3403
+ /**
3404
+ * Declares what `metadata` must satisfy for one resource type under one selector, so a template ships the corpus and the rule governing it together. `resource_type` is immutable: changing it in a template is a delete and a create.
3405
+ */
3406
+ type MetadataSchemaResourceProperties = {
3407
+ /**
3408
+ * The resource whose metadata this declaration governs.
3409
+ */
3410
+ resource_type: 'document';
3411
+ /**
3412
+ * The selector a `document` declaration must carry: the directory it governs, matched on a path boundary.
3413
+ */
3414
+ path_prefix?: string;
3415
+ /**
3416
+ * A JSON Schema, stored as written.
3417
+ */
3418
+ schema: {
3419
+ [key: string]: unknown;
3420
+ };
3421
+ };
3301
3422
  /**
3302
3423
  * Creates a quota — a project-scoped cap that blocks (`enforce`) or reports (`monitor`) when a windowed aggregate is exceeded. `requests` quotas are enforced by the request middleware; `tokens`/`cost_usd` quotas at the pre-generation check. Mirrors the quotas REST contract; `scope`, `metric`, `window`, and `meter_type` are immutable after creation (only `limit`, `mode`, and `on_unpriced` update).
3303
3424
  */
@@ -3378,7 +3499,7 @@ type GuardrailResourceProperties = {
3378
3499
  };
3379
3500
  type ResourceDeclaration = {
3380
3501
  /**
3381
- * Resource type. The built-in types are `ai_provider`, `tool`, `agent`, `actor`, `api_key`, `chat`, `conversation`, `dataset`, `dataset_item`, `document`, `file`, `guardrail`, `ingestion_rule`, `memory_store`, `memory`, `memory_rule`, `model_route`, `eval`, `orchestration`, `policy`, `project_price`, `quota`, `secret`, `session`, `webhook`, `trigger` and `workflow`.
3502
+ * Resource type. The built-in types are `ai_provider`, `tool`, `agent`, `actor`, `api_key`, `chat`, `conversation`, `dataset`, `dataset_item`, `document`, `file`, `guardrail`, `ingestion_rule`, `memory_store`, `memory`, `memory_rule`, `metadata_schema`, `model_route`, `eval`, `orchestration`, `policy`, `project_price`, `quota`, `secret`, `session`, `webhook`, `trigger` and `workflow`.
3382
3503
  *
3383
3504
  * This is deliberately not an enum: a deployment operator can register additional resource types backed by their own handler, and those are declared here exactly like a built-in one. The set a given deployment accepts is authoritative in the server, which rejects an unregistered type with `VALIDATION_FAILED` and lists what it does support.
3384
3505
  *
@@ -3400,9 +3521,7 @@ type ResourceDeclaration = {
3400
3521
  *
3401
3522
  */
3402
3523
  deletion_policy?: 'delete' | 'retain';
3403
- metadata?: {
3404
- [key: string]: unknown;
3405
- } | null;
3524
+ metadata?: NullableMetadataBag;
3406
3525
  };
3407
3526
  type FormationResource = {
3408
3527
  /**
@@ -3459,9 +3578,7 @@ type Formation = {
3459
3578
  * Static annotations stored on the formation record (supplied at create/update). Not a substitution site — `sub`/`param`/`ref` expressions are rejected. Use the template's top-level `metadata` block for deploy-time substitution (see `resolved_metadata`).
3460
3579
  *
3461
3580
  */
3462
- metadata?: {
3463
- [key: string]: unknown;
3464
- } | null;
3581
+ metadata?: NullableMetadataBag;
3465
3582
  /**
3466
3583
  * The template's top-level `metadata` block after parameter (`sub`/`param`) and resource (`ref`) substitution at the last deploy. Null when the template declares no metadata.
3467
3584
  *
@@ -3793,9 +3910,7 @@ type Generation = {
3793
3910
  * Caller-owned key/value annotations, attached at create time (via the `metadata` field on the create-agent-generation request) or afterwards (via the update-generation request), and returned verbatim. The server writes nothing here: every piece of state it owns — usage attribution, the served agent version, the route's record, the extraction summary, internal recovery state — is a field of its own, so no key written here can reach platform state. Keys are never transformed, and no key is reserved.
3794
3911
  *
3795
3912
  */
3796
- metadata?: {
3797
- [key: string]: unknown;
3798
- } | null;
3913
+ metadata?: NullableMetadataBag;
3799
3914
  /**
3800
3915
  * When the generation's content was purged. Non-null means `metadata`, `error`, `extraction` and the internal recovery state have been cleared, while the usage/audit skeleton — ids, timestamps, status, stop reason and the attribution fields — is preserved.
3801
3916
  *
@@ -3818,9 +3933,7 @@ type UpdateGenerationRequest = {
3818
3933
  * Caller-supplied key/value metadata to shallow-merge into the generation record's caller-owned `metadata` bag. No key is reserved: server-owned state lives in its own top-level fields and cannot be written from here.
3819
3934
  *
3820
3935
  */
3821
- metadata: {
3822
- [key: string]: unknown;
3823
- };
3936
+ metadata: MetadataBag;
3824
3937
  };
3825
3938
  /**
3826
3939
  * One tool call the model made during a step.
@@ -4139,6 +4252,10 @@ type UpdateGuardrailRequest = {
4139
4252
  * Optional tag for the config version this write archives (e.g. `pre-tightening`). Annotates the version only — it is not stored on the guardrail and is not part of the config, so labelling a change is never itself a change. Ignored when the write changes no policy, since no version is created.
4140
4253
  */
4141
4254
  version_label?: string;
4255
+ /**
4256
+ * Refuses the write unless the resource is at this version.
4257
+ */
4258
+ expected_version?: ExpectedVersion;
4142
4259
  };
4143
4260
  type IngestionRule = {
4144
4261
  id?: string;
@@ -4155,9 +4272,7 @@ type IngestionRule = {
4155
4272
  chunk_strategy?: string | null;
4156
4273
  chunk_size?: number | null;
4157
4274
  chunk_overlap?: number | null;
4158
- metadata?: {
4159
- [key: string]: unknown;
4160
- } | null;
4275
+ metadata?: NullableMetadataBag;
4161
4276
  created_at?: Date;
4162
4277
  updated_at?: Date;
4163
4278
  };
@@ -4210,9 +4325,7 @@ type DocumentKnowledgeResult = {
4210
4325
  /**
4211
4326
  * Arbitrary metadata attached to the document, returned verbatim in the casing it was written with at create/update time (e.g. a key written as `strapiDocumentId` is returned as `strapiDocumentId`, not `strapi_document_id`) — it is not converted between snake_case and camelCase like other response fields.
4212
4327
  */
4213
- metadata?: {
4214
- [key: string]: unknown;
4215
- };
4328
+ metadata?: MetadataBag;
4216
4329
  tags?: TagBag;
4217
4330
  /**
4218
4331
  * Full text content of the document
@@ -4321,17 +4434,19 @@ type Memory = {
4321
4434
  /**
4322
4435
  * Arbitrary structured metadata attached to the memory
4323
4436
  */
4324
- metadata?: {
4325
- [key: string]: unknown;
4326
- } | null;
4437
+ metadata?: NullableMetadataBag;
4327
4438
  /**
4328
- * When the memory was superseded. Null means the memory is currently valid. Invalidated memories are excluded from listing, from write deduplication, and from knowledge search, but remain readable by ID — with their original text — for audit.
4439
+ * When the memory stopped holding, whether a supersede replaced it or a retraction withdrew it. Null means the memory is currently valid. Invalidated memories are excluded from listing, from write deduplication, and from knowledge search, but remain readable by ID — with their original text — for audit.
4329
4440
  */
4330
4441
  invalidated_at?: Date | null;
4331
4442
  /**
4332
- * The memory that replaced this one, when it was superseded. Null for valid memories.
4443
+ * The memory that replaced this one, when it was superseded. Null for a valid memory and for a retracted one, which nothing replaced.
4333
4444
  */
4334
4445
  superseded_by_memory_id?: string | null;
4446
+ /**
4447
+ * The memory's write version, starting at 1 and incremented on every update. States a precondition against it with `expected_version` or `If-Match` on `PUT /memories/{memory_id}`.
4448
+ */
4449
+ version?: number;
4335
4450
  created_at?: Date;
4336
4451
  updated_at?: Date;
4337
4452
  };
@@ -4348,11 +4463,11 @@ type MemoryAssertion = {
4348
4463
  id?: string;
4349
4464
  memory_store_id?: string;
4350
4465
  /**
4351
- * The memory this assertion resolved into: the new memory for `created` and `superseded`, the existing memory that matched for `skipped`. Null only once that memory has been deleted.
4466
+ * The memory this assertion resolved into: the new memory for `created` and `superseded`, the existing memory that matched for `skipped`, the memory withdrawn for `retracted`. Null only once that memory has been deleted.
4352
4467
  */
4353
4468
  memory_id?: string | null;
4354
4469
  /**
4355
- * The memory this assertion retired, on a `superseded` outcome; null otherwise. Read back from `memories.superseded_by_memory_id` rather than stored here, because validity lives on the memory — where every read filters it — and exactly one memory is superseded per assertion.
4470
+ * The memory this assertion retired, on a `superseded` outcome; null otherwise, a retraction included — it retires its own memory, which `memory_id` already names. Read back from `memories.superseded_by_memory_id` rather than stored here, because validity lives on the memory — where every read filters it — and exactly one memory is superseded per assertion.
4356
4471
  */
4357
4472
  superseded_memory_id?: string | null;
4358
4473
  /**
@@ -4377,15 +4492,15 @@ type MemoryAssertion = {
4377
4492
  principal_type?: string;
4378
4493
  principal_id?: string;
4379
4494
  /**
4380
- * What the write resolved to. `created` is a distinct fact, `superseded` is the same fact changed (the top match was invalidated and replaced), `skipped` is a fact already known.
4495
+ * What the write resolved to. `created` is a distinct fact, `superseded` is the same fact changed (the top match was invalidated and replaced), `skipped` is a fact already known, `retracted` is a fact that stopped holding with nothing replacing it.
4381
4496
  */
4382
- outcome?: 'created' | 'superseded' | 'skipped';
4497
+ outcome?: 'created' | 'superseded' | 'skipped' | 'retracted';
4383
4498
  /**
4384
- * The cosine similarity the outcome was decided against — the top match's, or the declared target's when `declared` is true, where it decides nothing and only records how far apart the two statements were. Null when there was nothing to compare against, or when the content could not be embedded.
4499
+ * The cosine similarity the outcome was decided against — the top match's, or the declared target's when `declared` is true, where it decides nothing and only records how far apart the two statements were. Null when there was nothing to compare against, when the content could not be embedded, and on a `retracted` outcome, which compares nothing.
4385
4500
  */
4386
4501
  similarity?: number | null;
4387
4502
  /**
4388
- * Whether the write named the memory it replaced (`supersedes` on create) instead of the thresholds choosing one. Always false on a `created` or `skipped` outcome.
4503
+ * Whether the write named the memory it replaced (`supersedes` on create) instead of the thresholds choosing one. Always false on a `created`, `skipped` or `retracted` outcome.
4389
4504
  */
4390
4505
  declared?: boolean;
4391
4506
  created_at?: Date;
@@ -4433,6 +4548,57 @@ type MemoryStore = {
4433
4548
  created_at?: Date;
4434
4549
  updated_at?: Date;
4435
4550
  };
4551
+ /**
4552
+ * Narrows results by the `metadata` bag. Each key is a field; its value is either a value to match exactly, or an object naming one or more operators.
4553
+ *
4554
+ * Equality and `in` match the stored value exactly, so `3` and `"3"` are different filters.
4555
+ *
4556
+ * `gt`, `gte`, `lt` and `lte` order the field against the operand, and the operand's own JSON type says which comparison is meant: a number orders numerically, a string lexicographically. They work on any field, in any scope. A document whose field holds another type is excluded from the comparison rather than erroring on it, so a range never fails on a bag that happens to hold text where another holds a number. An operand that is neither a number nor a string — a boolean, `null`, a list, an object — has no ordering and is `400 VALIDATION_FAILED`, naming the field in `meta.field`.
4557
+ */
4558
+ type MetadataFilter = {
4559
+ [key: string]: unknown;
4560
+ };
4561
+ type MetadataSchemaRecord = {
4562
+ /**
4563
+ * Public ID (mdschema_ prefix)
4564
+ */
4565
+ id?: string;
4566
+ project_id?: string;
4567
+ /**
4568
+ * The resource whose metadata this declaration governs.
4569
+ */
4570
+ resource_type?: 'document';
4571
+ /**
4572
+ * The selector, in the field its resource type is addressed by. A document's is the directory it is filed under.
4573
+ */
4574
+ path_prefix?: string;
4575
+ /**
4576
+ * The declared JSON Schema, as written.
4577
+ */
4578
+ schema?: {
4579
+ [key: string]: unknown;
4580
+ };
4581
+ created_at?: Date;
4582
+ updated_at?: Date;
4583
+ };
4584
+ /**
4585
+ * Caller-owned annotations on a resource, stored as the object they were written as: the types a value was written with are the types a read returns, so a filter can ask an ordering question about a number. Unlike other body fields, keys are stored and returned verbatim in the casing supplied — they are not converted between snake_case and camelCase.
4586
+ *
4587
+ * No key is reserved, and that is the point: every piece of state the platform owns lives in its own typed column, so nothing written here reaches platform state. The platform never reads the bag — it is not an IAM context, not a policy input and not part of a prompt — which is what separates it from a tag bag.
4588
+ */
4589
+ type MetadataBag = {
4590
+ [key: string]: unknown;
4591
+ };
4592
+ /**
4593
+ * A `MetadataBag` on a field where `null` is meaningful — a full-replacement update that clears the bag, or a record whose bag was never set.
4594
+ */
4595
+ type NullableMetadataBag = {
4596
+ [key: string]: unknown;
4597
+ } | null;
4598
+ /**
4599
+ * A `MetadataBag` as JSON text. A multipart field carries text, so the object travels serialized on those surfaces and is parsed on arrival; a JSON body carries the object itself. Text that is not a JSON object is `400 VALIDATION_FAILED`.
4600
+ */
4601
+ type MetadataBagText = string;
4436
4602
  type ModelRouteTarget = {
4437
4603
  /**
4438
4604
  * AI provider in the route's project
@@ -4931,6 +5097,10 @@ type UpdateOrchestrationRequest = {
4931
5097
  * Optional tag for the version this write archives, e.g. `pre-rewire`. Ignored when the write changes no graph field, since no version is archived.
4932
5098
  */
4933
5099
  version_label?: string;
5100
+ /**
5101
+ * Refuses the write unless the resource is at this version.
5102
+ */
5103
+ expected_version?: ExpectedVersion;
4934
5104
  };
4935
5105
  /**
4936
5106
  * An immutable archive of an orchestration's graph at one version.
@@ -5033,18 +5203,10 @@ type OrchestrationRun = {
5033
5203
  input?: {
5034
5204
  [key: string]: unknown;
5035
5205
  } | null;
5036
- /**
5037
- * The `tool_context` supplied at run creation, forwarded as `X-Soat-Context-<key>` headers on every tool call the run's agent nodes make. Null when the run was started without one.
5038
- */
5039
- tool_context?: {
5040
- [key: string]: string;
5041
- } | null;
5042
5206
  /**
5043
5207
  * The caller-owned key/value metadata supplied at run creation, returned verbatim. Null when the run was started without any. The server writes nothing here and no key is reserved; the bag is never merged into `state`, so nothing in it reaches the graph.
5044
5208
  */
5045
- metadata?: {
5046
- [key: string]: unknown;
5047
- } | null;
5209
+ metadata?: NullableMetadataBag;
5048
5210
  /**
5049
5211
  * The deduplication key the run was started under, unique within the project and claimed for as long as the run record exists. Null for a run started without one, which every platform-started run is.
5050
5212
  */
@@ -5213,7 +5375,7 @@ type StartOrchestrationRunRequest = {
5213
5375
  /**
5214
5376
  * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `builtin` tool call made by an agent node of this run — including the agents of any child run a `loop` or `sub_orchestration` node starts. The header name is `X-Soat-Context-` plus the key verbatim; no character is re-cased.
5215
5377
  *
5216
- * The bag is stored on the run and re-read on every step, so it survives an `awaiting_input` pause, a `sleeping` wait, a background worker drive and a crash redrive. A key that is not a valid HTTP header name, or two keys that map to the same header, are rejected with `400 INVALID_TOOL_CONTEXT_KEY` and no run is created.
5378
+ * The bag is stored on the run and re-read on every step, so it survives an `awaiting_input` pause, a `sleeping` wait, a background worker drive and a crash redrive. It is **write-only**: a run is a record every principal who may read runs can read, and a credential in it is not theirs to see, so it is never returned on one. It also does not outlive the run: reaching a terminal status (`succeeded`, `failed`, `cancelled` or `expired`) clears it. A key that is not a valid HTTP header name, or two keys that map to the same header, are rejected with `400 INVALID_TOOL_CONTEXT_KEY` and no run is created.
5217
5379
  *
5218
5380
  * The reserved identity keys (`session_id`, `actor_id`, `actor_external_id`) are stripped at generation time — a caller cannot address them from here.
5219
5381
  */
@@ -5227,9 +5389,7 @@ type StartOrchestrationRunRequest = {
5227
5389
  *
5228
5390
  * It is **not** merged into run state: no graph node sees it, and an `input_schema` never has to tolerate it — which is what makes it the place for an infrastructural label, rather than `input`. Keys are never transformed. It is not inherited by the child runs a `loop` or `sub_orchestration` node starts; each child carries whatever the graph gives it, which today is nothing.
5229
5391
  */
5230
- metadata?: {
5231
- [key: string]: unknown;
5232
- };
5392
+ metadata?: MetadataBag;
5233
5393
  /**
5234
5394
  * Deduplication key, unique within the project, that makes a retry of an ambiguous failure safe. The first request under a key starts the run and answers `201`; any later request carrying the same key answers `200` with that same run, whatever state it has reached — including a retry that arrives while the original is still running.
5235
5395
  *
@@ -5253,6 +5413,24 @@ type ValidateOrchestrationRequest = {
5253
5413
  [key: string]: unknown;
5254
5414
  } | null;
5255
5415
  };
5416
+ type OrchestrationValidationError = {
5417
+ /**
5418
+ * Location of the issue (e.g. nodes[1].input_mapping.val).
5419
+ */
5420
+ path?: string;
5421
+ /**
5422
+ * Human-readable description of the issue.
5423
+ */
5424
+ message?: string;
5425
+ };
5426
+ type OrchestrationValidationResult = {
5427
+ /**
5428
+ * True when there are no blocking errors.
5429
+ */
5430
+ valid: boolean;
5431
+ errors: Array<OrchestrationValidationError>;
5432
+ warnings: Array<OrchestrationValidationError>;
5433
+ };
5256
5434
  type PolicyStatement = {
5257
5435
  effect: 'Allow' | 'Deny';
5258
5436
  action: Array<string>;
@@ -5309,6 +5487,10 @@ type ProjectRecord = {
5309
5487
  * Whether `GET` requests naming this project are recorded in the audit log. `false` by default — v1 audits mutations only.
5310
5488
  */
5311
5489
  audit_reads_enabled?: boolean;
5490
+ /**
5491
+ * Whether a generation whose model carries no price row is refused with `409 MODEL_NOT_PRICED`. `false` by default, where an unpriced model runs and meters at `cost_usd: null`.
5492
+ */
5493
+ require_priced_model?: boolean;
5312
5494
  /**
5313
5495
  * What a conversation that names no `retrieval` of its own does. `none` by default.
5314
5496
  */
@@ -5451,12 +5633,6 @@ type SessionRecord = {
5451
5633
  generating_at?: Date | null;
5452
5634
  created_at?: Date;
5453
5635
  updated_at?: Date;
5454
- /**
5455
- * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `builtin` tool call in this session. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased. Keys are never case-converted — they round-trip exactly as sent. A key that is not a valid HTTP header name, or two keys that map to the same header, are rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
5456
- */
5457
- tool_context?: {
5458
- [key: string]: string;
5459
- } | null;
5460
5636
  /**
5461
5637
  * Number of seconds of inactivity after which the session expires. 0 means the session never expires.
5462
5638
  */
@@ -5530,7 +5706,7 @@ type CreateSessionRequest = {
5530
5706
  */
5531
5707
  auto_generate?: boolean;
5532
5708
  /**
5533
- * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `builtin` tool call in this session. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased. Keys are never case-converted — they round-trip exactly as sent. A key that is not a valid HTTP header name, or two keys that map to the same header, are rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
5709
+ * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `builtin` tool call in this session. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased. Keys are stored exactly as sent and never case-converted. A key that is not a valid HTTP header name, or two keys that map to the same header, are rejected with `400 INVALID_TOOL_CONTEXT_KEY`. `session_id`, `actor_id` and `actor_external_id` are server-derived and dropped from the stored bag, in any casing. Write-only: no read of a session returns it. It also does not outlive the session: closing or expiring it clears the bag.
5534
5710
  */
5535
5711
  tool_context?: {
5536
5712
  [key: string]: string;
@@ -5559,7 +5735,7 @@ type UpdateSessionRequest = {
5559
5735
  */
5560
5736
  auto_generate?: boolean;
5561
5737
  /**
5562
- * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `builtin` tool call in this session. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased. Keys are never case-converted — they round-trip exactly as sent. A key that is not a valid HTTP header name, or two keys that map to the same header, are rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
5738
+ * Key-value pairs forwarded as `X-Soat-Context-<key>` headers on every `http`, `mcp` and `builtin` tool call in this session. The header name is the deployment's configured context prefix (`X-Soat-Context-` by default) plus the key verbatim — no character is re-cased. Keys are stored exactly as sent and never case-converted. A key that is not a valid HTTP header name, or two keys that map to the same header, are rejected with `400 INVALID_TOOL_CONTEXT_KEY`. `session_id`, `actor_id` and `actor_external_id` are server-derived and dropped from the stored bag, in any casing. Write-only: no read of a session returns it. It also does not outlive the session: closing or expiring it clears the bag.
5563
5739
  */
5564
5740
  tool_context?: {
5565
5741
  [key: string]: string;
@@ -5690,6 +5866,8 @@ type SubmitSessionToolOutputsRequest = {
5690
5866
  * Key-value labels on a resource. A flat object of string values — an array, a nested object or a number is rejected with `400 VALIDATION_FAILED`, never coerced. Keys are opaque and stored verbatim, so `cost_center` and `costCenter` are two different tags. Matched by JSONB containment wherever tags are read: the `?tags=` filter, knowledge search, and the IAM `soat:ResourceTag/<key>` condition.
5691
5867
  *
5692
5868
  * Keys beginning `system.` are reserved: the platform writes them to record which conversation, actor, agent and role a row came from, and a write naming one is refused with `400 RESERVED_TAG_KEY`. They are read and filtered like any other tag.
5869
+ *
5870
+ * The bag is bounded, because every pair reaches the IAM context of every access check on the resource: at most 50 keys, each key at most 128 characters and each value at most 256. A write past a bound — including a merge that would grow the stored bag past the key count — is `400 VALIDATION_FAILED` with `meta.limit` naming the bound it crossed. `system.*` keys are the platform's and do not count against the 50.
5693
5871
  */
5694
5872
  type TagBag = {
5695
5873
  [key: string]: string;
@@ -5720,9 +5898,7 @@ type Task = {
5720
5898
  /**
5721
5899
  * The caller-owned key/value metadata supplied when the task was created, returned verbatim. Null when the task was created without any. Unlike `payload` it is invisible to guards and to `payload_writes`, so it is the place for an attribution label rather than task data.
5722
5900
  */
5723
- metadata?: {
5724
- [key: string]: unknown;
5725
- } | null;
5901
+ metadata?: NullableMetadataBag;
5726
5902
  /**
5727
5903
  * Server-owned. The result of the current state's last completed dispatch, overwritten on every dispatch. Read-only — exposed to transition guards and `on_complete`/`payload_writes` expressions as `task.last_result`, a namespace a caller cannot write.
5728
5904
  */
@@ -5818,9 +5994,7 @@ type CreateTaskRequest = {
5818
5994
  *
5819
5995
  * Prefer this over `payload` for anything that is not task data: `payload` is read by every guard as `task.payload` and may be written by the workflow's declared `payload_writes`, so a label parked there is neither invisible to the state machine nor safe from it. A non-object is rejected with `400 VALIDATION_FAILED` and no task is created.
5820
5996
  */
5821
- metadata?: {
5822
- [key: string]: unknown;
5823
- };
5997
+ metadata?: MetadataBag;
5824
5998
  };
5825
5999
  type UpdateTaskRequest = {
5826
6000
  title?: string;
@@ -6327,6 +6501,17 @@ type CreateTriggerRequest = {
6327
6501
  input?: {
6328
6502
  [key: string]: unknown;
6329
6503
  };
6504
+ /**
6505
+ * Caller context every firing forwards to the run it starts, so an agent whose tools authorize through `{{context:<key>}}` can be put on a schedule — a firing has no request to carry one. Each key is forwarded as one `X-Soat-Context-<key>` header.
6506
+ *
6507
+ * **Write-only.** It is accepted here and never returned on a read, so the record cannot be used to recover a value.
6508
+ *
6509
+ * A value may be a `{{secret:...}}` reference, which keeps the credential in the [secret](/docs/modules/secrets) store and leaves only its name on the trigger; it is resolved at fire time, so rotating the secret changes the next firing without touching the trigger. A reference naming a secret that does not exist in this project is refused here rather than at fire time.
6510
+ *
6511
+ */
6512
+ tool_context?: {
6513
+ [key: string]: string;
6514
+ };
6330
6515
  /**
6331
6516
  * 5-field cron expression (UTC). Required when type is schedule
6332
6517
  */
@@ -6347,6 +6532,13 @@ type UpdateTriggerRequest = {
6347
6532
  input?: {
6348
6533
  [key: string]: unknown;
6349
6534
  } | null;
6535
+ /**
6536
+ * Replaces the stored bag; `null` clears it. Write-only and resolved at fire time — see `CreateTriggerRequest.tool_context`.
6537
+ *
6538
+ */
6539
+ tool_context?: {
6540
+ [key: string]: string;
6541
+ } | null;
6350
6542
  cron?: string | null;
6351
6543
  event_pattern?: string | null;
6352
6544
  active?: boolean;
@@ -6359,6 +6551,15 @@ type FireTriggerRequest = {
6359
6551
  input?: {
6360
6552
  [key: string]: unknown;
6361
6553
  };
6554
+ /**
6555
+ * Fire-time caller context, shallow-merged per key over the trigger's stored `tool_context`. A manual fire has a caller, so this is the one path that can supply a value without storing it.
6556
+ *
6557
+ * Forwarded exactly as written: a `{{secret:...}}` reference is resolved only in the trigger's stored bag, never in one supplied here.
6558
+ *
6559
+ */
6560
+ tool_context?: {
6561
+ [key: string]: string;
6562
+ };
6362
6563
  };
6363
6564
  type TriggerSecretResponse = {
6364
6565
  secret?: string;
@@ -6384,6 +6585,14 @@ type TriggerFiring = {
6384
6585
  error?: {
6385
6586
  [key: string]: unknown;
6386
6587
  } | null;
6588
+ /**
6589
+ * `<event_id>:<trigger_id>` for an `event` firing, null for every other source. The same event reaching the same trigger twice produces one firing under this key, so a consumer reading firings can recognise a redelivery.
6590
+ */
6591
+ idempotency_key?: string | null;
6592
+ /**
6593
+ * Dispatch attempts started. Above 1 means an earlier attempt was interrupted before it recorded a result and the firing was redelivered — not that the target refused it, which is recorded terminally in `error` and never retried.
6594
+ */
6595
+ attempts?: number;
6387
6596
  started_at?: Date | null;
6388
6597
  completed_at?: Date | null;
6389
6598
  created_at?: Date;
@@ -7080,6 +7289,10 @@ type UpdateWorkflowRequest = {
7080
7289
  * Optional tag for the version this write archives, e.g. `pre-rewire`. Ignored when the write changes no definition field, since no version is archived.
7081
7290
  */
7082
7291
  version_label?: string;
7292
+ /**
7293
+ * Refuses the write unless the resource is at this version.
7294
+ */
7295
+ expected_version?: ExpectedVersion;
7083
7296
  };
7084
7297
  /**
7085
7298
  * An immutable archive of a workflow's state machine at one version.
@@ -7146,10 +7359,7 @@ type FileRecordWritable = {
7146
7359
  * File size in bytes
7147
7360
  */
7148
7361
  size?: number | null;
7149
- /**
7150
- * JSON string with additional metadata
7151
- */
7152
- metadata?: string | null;
7362
+ metadata?: NullableMetadataBag;
7153
7363
  tags?: TagBag;
7154
7364
  /**
7155
7365
  * Creation timestamp
@@ -7168,10 +7378,18 @@ type ApprovalId = string;
7168
7378
  * Continuation chain ID
7169
7379
  */
7170
7380
  type ChainId = string;
7381
+ /**
7382
+ * The version the caller believes the resource holds, as an entity tag (`3` or `"3"`). Equivalent to `expected_version` in the request body; `*` states no precondition beyond the resource existing. A mismatch is `409 VERSION_CONFLICT`.
7383
+ */
7384
+ type IfMatchVersion = string;
7171
7385
  /**
7172
7386
  * Exception item ID
7173
7387
  */
7174
7388
  type ExceptionId = string;
7389
+ /**
7390
+ * A `MetadataFilter` as JSON, url-encoded. It travels as JSON rather than as `key:value` pairs because the match is exact and a query string cannot otherwise say whether `3` is the number or the string.
7391
+ */
7392
+ type MetadataQuery = string;
7175
7393
  /**
7176
7394
  * Public ID of the orchestration (orch_...)
7177
7395
  */
@@ -7259,22 +7477,74 @@ type ListActivityResponses = {
7259
7477
  };
7260
7478
  };
7261
7479
  type ListActivityResponse = ListActivityResponses[keyof ListActivityResponses];
7262
- type ListActorsData = {
7480
+ type ExportActivityData = {
7263
7481
  body?: never;
7264
7482
  path?: never;
7265
- query?: {
7483
+ query: {
7266
7484
  /**
7267
- * Project ID (optional)
7485
+ * Project whose activity is exported
7268
7486
  */
7269
- project_id?: string;
7487
+ project_id: string;
7270
7488
  /**
7271
- * External ID to filter by (e.g. WhatsApp phone number)
7489
+ * Only entries of this kind
7272
7490
  */
7273
- external_id?: string;
7491
+ kind?: string;
7274
7492
  /**
7275
- * Case-insensitive substring match on the actor name
7493
+ * Only entries of this severity
7276
7494
  */
7277
- name?: string;
7495
+ severity?: string;
7496
+ /**
7497
+ * Only entries an agent produced
7498
+ */
7499
+ agent_id?: string;
7500
+ /**
7501
+ * Only entries a generation produced
7502
+ */
7503
+ generation_id?: string;
7504
+ /**
7505
+ * Only entries an orchestration run produced
7506
+ */
7507
+ orchestration_run_id?: string;
7508
+ };
7509
+ url: '/api/v1/activity/export';
7510
+ };
7511
+ type ExportActivityErrors = {
7512
+ /**
7513
+ * `project_id` is required
7514
+ */
7515
+ 400: unknown;
7516
+ /**
7517
+ * Unauthorized
7518
+ */
7519
+ 401: unknown;
7520
+ /**
7521
+ * Forbidden
7522
+ */
7523
+ 403: unknown;
7524
+ };
7525
+ type ExportActivityResponses = {
7526
+ /**
7527
+ * A newline-delimited stream of activity entries. Each line is a JSON object with the same fields as `ActivityEntry`.
7528
+ */
7529
+ 200: string;
7530
+ };
7531
+ type ExportActivityResponse = ExportActivityResponses[keyof ExportActivityResponses];
7532
+ type ListActorsData = {
7533
+ body?: never;
7534
+ path?: never;
7535
+ query?: {
7536
+ /**
7537
+ * Project ID (optional)
7538
+ */
7539
+ project_id?: string;
7540
+ /**
7541
+ * External ID to filter by (e.g. WhatsApp phone number)
7542
+ */
7543
+ external_id?: string;
7544
+ /**
7545
+ * Case-insensitive substring match on the actor name
7546
+ */
7547
+ name?: string;
7278
7548
  /**
7279
7549
  * Return only actors linked to this agent
7280
7550
  */
@@ -7745,6 +8015,12 @@ type GetAgentResponses = {
7745
8015
  type GetAgentResponse = GetAgentResponses[keyof GetAgentResponses];
7746
8016
  type PatchAgentData = {
7747
8017
  body: UpdateAgentRequest;
8018
+ headers?: {
8019
+ /**
8020
+ * The version the caller believes the resource holds, as an entity tag (`3` or `"3"`). Equivalent to `expected_version` in the request body; `*` states no precondition beyond the resource existing. A mismatch is `409 VERSION_CONFLICT`.
8021
+ */
8022
+ 'If-Match'?: string;
8023
+ };
7748
8024
  path: {
7749
8025
  agent_id: string;
7750
8026
  };
@@ -9606,11 +9882,9 @@ type AddConversationMessageData = {
9606
9882
  */
9607
9883
  position?: number;
9608
9884
  /**
9609
- * Optional structured metadata to attach to the message (e.g. phone number, channel). Stored as-is and injected into the AI prompt context.
9885
+ * Caller-owned annotations on the message (e.g. a phone number, a channel), stored as sent and returned verbatim. The platform does not read the bag, so nothing in it reaches the model: a value the model should see belongs in `message`.
9610
9886
  */
9611
- metadata?: {
9612
- [key: string]: unknown;
9613
- } | null;
9887
+ metadata?: NullableMetadataBag;
9614
9888
  };
9615
9889
  path: {
9616
9890
  /**
@@ -9864,11 +10138,23 @@ type ListDocumentsData = {
9864
10138
  * Only documents filed under this directory. The prefix is a path boundary, not a substring: `/reports` returns `/reports/q1.txt` and never `/reports-archive/q1.txt`, and `/` selects the whole project. A leading slash is optional and a trailing one is ignored, so `reports`, `/reports` and `/reports/` are the same filter. `%` and `_` are literal characters, not wildcards.
9865
10139
  */
9866
10140
  path_prefix?: string;
10141
+ /**
10142
+ * Include withdrawn documents. A withdrawn document leaves every default read and is not in the knowledge index at all — its chunks are dropped when it is withdrawn — so this shows it in the listing but never in a search.
10143
+ */
10144
+ include_withdrawn?: boolean;
10145
+ /**
10146
+ * Only documents related to this one, on either side of the edge: what it points at, and what points at it. An id with no relations narrows the listing to nothing.
10147
+ */
10148
+ related_to?: string;
9867
10149
  /**
9868
10150
  * Filter by tag pairs, written `key:value` (split on the first colon, so a value may contain colons). Repeat the parameter for several pairs; **all** must be present with exactly that value.
9869
10151
  *
9870
10152
  */
9871
10153
  tags?: Array<string>;
10154
+ /**
10155
+ * A `MetadataFilter` as JSON, url-encoded. It travels as JSON rather than as `key:value` pairs because the match is exact and a query string cannot otherwise say whether `3` is the number or the string.
10156
+ */
10157
+ metadata?: string;
9872
10158
  /**
9873
10159
  * Maximum number of results to return
9874
10160
  */
@@ -9922,9 +10208,7 @@ type CreateDocumentData = {
9922
10208
  /**
9923
10209
  * Arbitrary metadata object. Unlike other body fields, keys are stored and returned verbatim in the casing supplied — they are not converted between snake_case and camelCase.
9924
10210
  */
9925
- metadata?: {
9926
- [key: string]: unknown;
9927
- };
10211
+ metadata?: MetadataBag;
9928
10212
  tags?: TagBag;
9929
10213
  /**
9930
10214
  * How to split the content into embeddable chunks. `whole` (default) stores the content as a single chunk; `size` splits into fixed-size character windows with overlap. `page` is equivalent to `whole` for plain text.
@@ -10040,6 +10324,42 @@ type IngestDocumentResponses = {
10040
10324
  202: IngestedDocumentRecord;
10041
10325
  };
10042
10326
  type IngestDocumentResponse = IngestDocumentResponses[keyof IngestDocumentResponses];
10327
+ type ExportDocumentsData = {
10328
+ body?: never;
10329
+ path?: never;
10330
+ query: {
10331
+ /**
10332
+ * Project whose documents are exported
10333
+ */
10334
+ project_id: string;
10335
+ /**
10336
+ * Only documents filed under this directory. The prefix is a path boundary, not a substring, exactly as on the listing.
10337
+ */
10338
+ path_prefix?: string;
10339
+ };
10340
+ url: '/api/v1/documents/export';
10341
+ };
10342
+ type ExportDocumentsErrors = {
10343
+ /**
10344
+ * `project_id` is required
10345
+ */
10346
+ 400: unknown;
10347
+ /**
10348
+ * Unauthorized
10349
+ */
10350
+ 401: unknown;
10351
+ /**
10352
+ * Forbidden
10353
+ */
10354
+ 403: unknown;
10355
+ };
10356
+ type ExportDocumentsResponses = {
10357
+ /**
10358
+ * A newline-delimited stream of documents. Each line is a JSON object with the same fields as `Document`.
10359
+ */
10360
+ 200: string;
10361
+ };
10362
+ type ExportDocumentsResponse = ExportDocumentsResponses[keyof ExportDocumentsResponses];
10043
10363
  type DeleteDocumentData = {
10044
10364
  body?: never;
10045
10365
  path: {
@@ -10121,12 +10441,20 @@ type UpdateDocumentData = {
10121
10441
  */
10122
10442
  path?: string | null;
10123
10443
  /**
10124
- * Arbitrary metadata object. Unlike other body fields, keys are stored and returned verbatim in the casing supplied — they are not converted between snake_case and camelCase.
10444
+ * Arbitrary metadata object, replacing the stored bag; `null` clears it. Unlike other body fields, keys are stored and returned verbatim in the casing supplied — they are not converted between snake_case and camelCase.
10125
10445
  */
10126
- metadata?: {
10127
- [key: string]: unknown;
10128
- };
10446
+ metadata?: NullableMetadataBag;
10129
10447
  tags?: TagBag;
10448
+ /**
10449
+ * Refuses the write unless the document is at this version.
10450
+ */
10451
+ expected_version?: ExpectedVersion;
10452
+ };
10453
+ headers?: {
10454
+ /**
10455
+ * The version the caller believes the resource holds, as an entity tag (`3` or `"3"`). Equivalent to `expected_version` in the request body; `*` states no precondition beyond the resource existing. A mismatch is `409 VERSION_CONFLICT`.
10456
+ */
10457
+ 'If-Match'?: string;
10130
10458
  };
10131
10459
  path: {
10132
10460
  /**
@@ -10159,155 +10487,114 @@ type UpdateDocumentResponses = {
10159
10487
  200: DocumentRecord;
10160
10488
  };
10161
10489
  type UpdateDocumentResponse = UpdateDocumentResponses[keyof UpdateDocumentResponses];
10162
- type GetDocumentStatusData = {
10490
+ type ListDocumentRelationsData = {
10163
10491
  body?: never;
10164
10492
  path: {
10165
- /**
10166
- * Document ID
10167
- */
10168
10493
  document_id: string;
10169
10494
  };
10170
10495
  query?: never;
10171
- url: '/api/v1/documents/{document_id}/status';
10496
+ url: '/api/v1/documents/{document_id}/relations';
10172
10497
  };
10173
- type GetDocumentStatusErrors = {
10498
+ type ListDocumentRelationsErrors = {
10174
10499
  /**
10175
10500
  * Unauthorized
10176
10501
  */
10177
- 401: ErrorResponse;
10502
+ 401: unknown;
10178
10503
  /**
10179
10504
  * Forbidden
10180
10505
  */
10181
- 403: ErrorResponse;
10506
+ 403: unknown;
10182
10507
  /**
10183
10508
  * Document not found
10184
10509
  */
10185
- 404: ErrorResponse;
10510
+ 404: unknown;
10186
10511
  };
10187
- type GetDocumentStatusError = GetDocumentStatusErrors[keyof GetDocumentStatusErrors];
10188
- type GetDocumentStatusResponses = {
10512
+ type ListDocumentRelationsResponses = {
10189
10513
  /**
10190
- * Document ingestion status
10514
+ * The document's relations
10191
10515
  */
10192
- 200: DocumentStatusRecord;
10516
+ 200: {
10517
+ data?: Array<DocumentRelation>;
10518
+ };
10193
10519
  };
10194
- type GetDocumentStatusResponse = GetDocumentStatusResponses[keyof GetDocumentStatusResponses];
10195
- type ReingestDocumentData = {
10196
- body?: {
10197
- /**
10198
- * How to split the source into chunks. Defaults to `page`.
10199
- */
10200
- chunk_strategy?: 'page' | 'whole' | 'size';
10520
+ type ListDocumentRelationsResponse = ListDocumentRelationsResponses[keyof ListDocumentRelationsResponses];
10521
+ type CreateDocumentRelationData = {
10522
+ body: {
10201
10523
  /**
10202
- * Window size in characters when `chunk_strategy=size`. Defaults to 1000.
10524
+ * What this document claims about the other
10203
10525
  */
10204
- chunk_size?: number;
10526
+ type: 'derived_from' | 'supersedes' | 'cites';
10205
10527
  /**
10206
- * Overlap in characters between consecutive windows when `chunk_strategy=size`. Defaults to 200.
10528
+ * The document the edge points at. Must be in the same project, and visible to the caller.
10207
10529
  */
10208
- chunk_overlap?: number;
10530
+ to_document_id: string;
10209
10531
  };
10210
10532
  path: {
10211
- /**
10212
- * Document ID
10213
- */
10214
10533
  document_id: string;
10215
10534
  };
10216
- query?: {
10217
- /**
10218
- * When omitted or `false` (default), processing runs in the background and `202 Accepted` is returned immediately with `status=pending`. Pass `true` to block until processing completes and receive `201 Created` with `status=ready`.
10219
- */
10220
- wait?: boolean;
10221
- };
10222
- url: '/api/v1/documents/{document_id}/ingest';
10535
+ query?: never;
10536
+ url: '/api/v1/documents/{document_id}/relations';
10223
10537
  };
10224
- type ReingestDocumentErrors = {
10538
+ type CreateDocumentRelationErrors = {
10225
10539
  /**
10226
- * Unauthorized
10540
+ * An undeclared `type`, a `to_document_id` that is not a document id, a document relating to itself, or a target in another project
10227
10541
  */
10228
- 401: ErrorResponse;
10542
+ 400: unknown;
10229
10543
  /**
10230
- * Forbidden
10544
+ * Unauthorized
10231
10545
  */
10232
- 403: ErrorResponse;
10546
+ 401: unknown;
10233
10547
  /**
10234
- * Document not found
10548
+ * Forbidden
10235
10549
  */
10236
- 404: ErrorResponse;
10550
+ 403: unknown;
10237
10551
  /**
10238
- * The project's `storage_bytes` quota is exceeded (`QUOTA_STORAGE_EXCEEDED`). Delete stored content, or raise the quota — no window reset clears a stored total, so no `Retry-After` is sent.
10552
+ * Either document was not found
10239
10553
  */
10240
- 409: ErrorResponse;
10554
+ 404: unknown;
10241
10555
  /**
10242
- * The file is too large to re-ingest synchronously (`?wait=true`). Retry in background mode.
10556
+ * That relation is already asserted
10243
10557
  */
10244
- 413: ErrorResponse;
10558
+ 409: unknown;
10245
10559
  };
10246
- type ReingestDocumentError = ReingestDocumentErrors[keyof ReingestDocumentErrors];
10247
- type ReingestDocumentResponses = {
10248
- /**
10249
- * Re-ingestion completed synchronously (only when `?wait=true`).
10250
- */
10251
- 201: IngestedDocumentRecord;
10560
+ type CreateDocumentRelationResponses = {
10252
10561
  /**
10253
- * Re-ingestion accepted. The document was reset to `status=pending` and processing runs in the background. Poll `GET /api/v1/documents/{document_id}/status`.
10562
+ * The asserted relation
10254
10563
  */
10255
- 202: IngestedDocumentRecord;
10564
+ 201: DocumentRelation;
10256
10565
  };
10257
- type ReingestDocumentResponse = ReingestDocumentResponses[keyof ReingestDocumentResponses];
10258
- type CompleteIngestionCallbackData = {
10259
- /**
10260
- * The converter output contract, adapted for a JSON request body: a single page as `{ text }`, or `{ pages: [{ text, page_number }] }` for multiple pages.
10261
- */
10262
- body: {
10263
- text: string;
10264
- } | {
10265
- pages: Array<{
10266
- text?: string;
10267
- page_number?: number;
10268
- }>;
10269
- };
10566
+ type CreateDocumentRelationResponse = CreateDocumentRelationResponses[keyof CreateDocumentRelationResponses];
10567
+ type DeleteDocumentRelationData = {
10568
+ body?: never;
10270
10569
  path: {
10271
- /**
10272
- * Document ID
10273
- */
10274
10570
  document_id: string;
10571
+ relation_id: string;
10275
10572
  };
10276
- query: {
10277
- /**
10278
- * Single-use signed token from the original `callback.token`
10279
- */
10280
- token: string;
10281
- };
10282
- url: '/api/v1/documents/{document_id}/ingestion-callback';
10573
+ query?: never;
10574
+ url: '/api/v1/documents/{document_id}/relations/{relation_id}';
10283
10575
  };
10284
- type CompleteIngestionCallbackErrors = {
10285
- /**
10286
- * The token is missing, invalid, or does not match this document.
10287
- */
10288
- 401: ErrorResponse;
10576
+ type DeleteDocumentRelationErrors = {
10289
10577
  /**
10290
- * Document not found
10578
+ * Unauthorized
10291
10579
  */
10292
- 404: ErrorResponse;
10580
+ 401: unknown;
10293
10581
  /**
10294
- * The document is no longer awaiting this conversion attempt (already completed, timed out, or superseded by a re-ingest).
10582
+ * Forbidden
10295
10583
  */
10296
- 409: ErrorResponse;
10584
+ 403: unknown;
10297
10585
  /**
10298
- * The output shape is unrecognized.
10586
+ * Document or relation not found
10299
10587
  */
10300
- 422: ErrorResponse;
10588
+ 404: unknown;
10301
10589
  };
10302
- type CompleteIngestionCallbackError = CompleteIngestionCallbackErrors[keyof CompleteIngestionCallbackErrors];
10303
- type CompleteIngestionCallbackResponses = {
10590
+ type DeleteDocumentRelationResponses = {
10304
10591
  /**
10305
- * Conversion completed — the document was chunked and marked `ready` (or `failed` with `FILE_PARSE_FAILED` if the output produced no text).
10592
+ * Relation retracted
10306
10593
  */
10307
10594
  204: void;
10308
10595
  };
10309
- type CompleteIngestionCallbackResponse = CompleteIngestionCallbackResponses[keyof CompleteIngestionCallbackResponses];
10310
- type GetDocumentTagsData = {
10596
+ type DeleteDocumentRelationResponse = DeleteDocumentRelationResponses[keyof DeleteDocumentRelationResponses];
10597
+ type GetDocumentStatusData = {
10311
10598
  body?: never;
10312
10599
  path: {
10313
10600
  /**
@@ -10316,9 +10603,9 @@ type GetDocumentTagsData = {
10316
10603
  document_id: string;
10317
10604
  };
10318
10605
  query?: never;
10319
- url: '/api/v1/documents/{document_id}/tags';
10606
+ url: '/api/v1/documents/{document_id}/status';
10320
10607
  };
10321
- type GetDocumentTagsErrors = {
10608
+ type GetDocumentStatusErrors = {
10322
10609
  /**
10323
10610
  * Unauthorized
10324
10611
  */
@@ -10332,26 +10619,42 @@ type GetDocumentTagsErrors = {
10332
10619
  */
10333
10620
  404: ErrorResponse;
10334
10621
  };
10335
- type GetDocumentTagsError = GetDocumentTagsErrors[keyof GetDocumentTagsErrors];
10336
- type GetDocumentTagsResponses = {
10622
+ type GetDocumentStatusError = GetDocumentStatusErrors[keyof GetDocumentStatusErrors];
10623
+ type GetDocumentStatusResponses = {
10337
10624
  /**
10338
- * Document tags
10625
+ * Document ingestion status
10339
10626
  */
10340
- 200: TagBag;
10627
+ 200: DocumentStatusRecord;
10341
10628
  };
10342
- type GetDocumentTagsResponse = GetDocumentTagsResponses[keyof GetDocumentTagsResponses];
10343
- type MergeDocumentTagsData = {
10344
- body: TagBag;
10345
- path: {
10629
+ type GetDocumentStatusResponse = GetDocumentStatusResponses[keyof GetDocumentStatusResponses];
10630
+ type WithdrawDocumentData = {
10631
+ body?: {
10346
10632
  /**
10347
- * Document ID
10633
+ * Optional tag for the tombstone version this write archives.
10634
+ */
10635
+ version_label?: string | null;
10636
+ /**
10637
+ * Refuses the withdrawal unless the document is at this version.
10638
+ */
10639
+ expected_version?: ExpectedVersion;
10640
+ };
10641
+ headers?: {
10642
+ /**
10643
+ * The version the caller believes the resource holds, as an entity tag (`3` or `"3"`). Equivalent to `expected_version` in the request body; `*` states no precondition beyond the resource existing. A mismatch is `409 VERSION_CONFLICT`.
10348
10644
  */
10645
+ 'If-Match'?: string;
10646
+ };
10647
+ path: {
10349
10648
  document_id: string;
10350
10649
  };
10351
10650
  query?: never;
10352
- url: '/api/v1/documents/{document_id}/tags';
10651
+ url: '/api/v1/documents/{document_id}/withdraw';
10353
10652
  };
10354
- type MergeDocumentTagsErrors = {
10653
+ type WithdrawDocumentErrors = {
10654
+ /**
10655
+ * Bad Request — the document is filed under the reserved root
10656
+ */
10657
+ 400: ErrorResponse;
10355
10658
  /**
10356
10659
  * Unauthorized
10357
10660
  */
@@ -10364,24 +10667,328 @@ type MergeDocumentTagsErrors = {
10364
10667
  * Document not found
10365
10668
  */
10366
10669
  404: ErrorResponse;
10670
+ /**
10671
+ * Conflict — already withdrawn, or the version moved
10672
+ */
10673
+ 409: ErrorResponse;
10367
10674
  };
10368
- type MergeDocumentTagsError = MergeDocumentTagsErrors[keyof MergeDocumentTagsErrors];
10369
- type MergeDocumentTagsResponses = {
10675
+ type WithdrawDocumentError = WithdrawDocumentErrors[keyof WithdrawDocumentErrors];
10676
+ type WithdrawDocumentResponses = {
10370
10677
  /**
10371
- * Tags merged
10678
+ * The withdrawn document
10372
10679
  */
10373
- 200: TagBag;
10680
+ 200: DocumentRecord;
10374
10681
  };
10375
- type MergeDocumentTagsResponse = MergeDocumentTagsResponses[keyof MergeDocumentTagsResponses];
10376
- type ReplaceDocumentTagsData = {
10377
- body: TagBag;
10682
+ type WithdrawDocumentResponse = WithdrawDocumentResponses[keyof WithdrawDocumentResponses];
10683
+ type ListDocumentVersionsData = {
10684
+ body?: never;
10378
10685
  path: {
10379
- /**
10380
- * Document ID
10381
- */
10382
10686
  document_id: string;
10383
10687
  };
10384
- query?: never;
10688
+ query?: {
10689
+ /**
10690
+ * Maximum number of results to return
10691
+ */
10692
+ limit?: number;
10693
+ /**
10694
+ * Number of results to skip
10695
+ */
10696
+ offset?: number;
10697
+ };
10698
+ url: '/api/v1/documents/{document_id}/versions';
10699
+ };
10700
+ type ListDocumentVersionsErrors = {
10701
+ /**
10702
+ * Unauthorized
10703
+ */
10704
+ 401: ErrorResponse;
10705
+ /**
10706
+ * Forbidden
10707
+ */
10708
+ 403: ErrorResponse;
10709
+ /**
10710
+ * Document not found
10711
+ */
10712
+ 404: ErrorResponse;
10713
+ };
10714
+ type ListDocumentVersionsError = ListDocumentVersionsErrors[keyof ListDocumentVersionsErrors];
10715
+ type ListDocumentVersionsResponses = {
10716
+ /**
10717
+ * List of document versions, newest first
10718
+ */
10719
+ 200: {
10720
+ data: Array<DocumentVersion>;
10721
+ total: number;
10722
+ limit: number;
10723
+ offset: number;
10724
+ };
10725
+ };
10726
+ type ListDocumentVersionsResponse = ListDocumentVersionsResponses[keyof ListDocumentVersionsResponses];
10727
+ type GetDocumentVersionData = {
10728
+ body?: never;
10729
+ path: {
10730
+ document_id: string;
10731
+ version: number;
10732
+ };
10733
+ query?: never;
10734
+ url: '/api/v1/documents/{document_id}/versions/{version}';
10735
+ };
10736
+ type GetDocumentVersionErrors = {
10737
+ /**
10738
+ * Bad Request — version is not a positive integer
10739
+ */
10740
+ 400: ErrorResponse;
10741
+ /**
10742
+ * Unauthorized
10743
+ */
10744
+ 401: ErrorResponse;
10745
+ /**
10746
+ * Forbidden
10747
+ */
10748
+ 403: ErrorResponse;
10749
+ /**
10750
+ * Not found
10751
+ */
10752
+ 404: ErrorResponse;
10753
+ };
10754
+ type GetDocumentVersionError = GetDocumentVersionErrors[keyof GetDocumentVersionErrors];
10755
+ type GetDocumentVersionResponses = {
10756
+ /**
10757
+ * Archived document version
10758
+ */
10759
+ 200: DocumentVersion;
10760
+ };
10761
+ type GetDocumentVersionResponse = GetDocumentVersionResponses[keyof GetDocumentVersionResponses];
10762
+ type RestoreDocumentVersionData = {
10763
+ body?: {
10764
+ /**
10765
+ * Optional tag for the version this restore archives. Defaults to `restored from v<version>`.
10766
+ */
10767
+ label?: string | null;
10768
+ };
10769
+ path: {
10770
+ document_id: string;
10771
+ version: number;
10772
+ };
10773
+ query?: never;
10774
+ url: '/api/v1/documents/{document_id}/versions/{version}/restore';
10775
+ };
10776
+ type RestoreDocumentVersionErrors = {
10777
+ /**
10778
+ * Bad Request — invalid version, or the version is a withdrawal
10779
+ */
10780
+ 400: ErrorResponse;
10781
+ /**
10782
+ * Unauthorized
10783
+ */
10784
+ 401: ErrorResponse;
10785
+ /**
10786
+ * Forbidden
10787
+ */
10788
+ 403: ErrorResponse;
10789
+ /**
10790
+ * Document or version not found
10791
+ */
10792
+ 404: ErrorResponse;
10793
+ };
10794
+ type RestoreDocumentVersionError = RestoreDocumentVersionErrors[keyof RestoreDocumentVersionErrors];
10795
+ type RestoreDocumentVersionResponses = {
10796
+ /**
10797
+ * The document, at its new version
10798
+ */
10799
+ 200: DocumentRecord;
10800
+ };
10801
+ type RestoreDocumentVersionResponse = RestoreDocumentVersionResponses[keyof RestoreDocumentVersionResponses];
10802
+ type ReingestDocumentData = {
10803
+ body?: {
10804
+ /**
10805
+ * How to split the source into chunks. Defaults to `page`.
10806
+ */
10807
+ chunk_strategy?: 'page' | 'whole' | 'size';
10808
+ /**
10809
+ * Window size in characters when `chunk_strategy=size`. Defaults to 1000.
10810
+ */
10811
+ chunk_size?: number;
10812
+ /**
10813
+ * Overlap in characters between consecutive windows when `chunk_strategy=size`. Defaults to 200.
10814
+ */
10815
+ chunk_overlap?: number;
10816
+ };
10817
+ path: {
10818
+ /**
10819
+ * Document ID
10820
+ */
10821
+ document_id: string;
10822
+ };
10823
+ query?: {
10824
+ /**
10825
+ * When omitted or `false` (default), processing runs in the background and `202 Accepted` is returned immediately with `status=pending`. Pass `true` to block until processing completes and receive `201 Created` with `status=ready`.
10826
+ */
10827
+ wait?: boolean;
10828
+ };
10829
+ url: '/api/v1/documents/{document_id}/ingest';
10830
+ };
10831
+ type ReingestDocumentErrors = {
10832
+ /**
10833
+ * Unauthorized
10834
+ */
10835
+ 401: ErrorResponse;
10836
+ /**
10837
+ * Forbidden
10838
+ */
10839
+ 403: ErrorResponse;
10840
+ /**
10841
+ * Document not found
10842
+ */
10843
+ 404: ErrorResponse;
10844
+ /**
10845
+ * The project's `storage_bytes` quota is exceeded (`QUOTA_STORAGE_EXCEEDED`). Delete stored content, or raise the quota — no window reset clears a stored total, so no `Retry-After` is sent.
10846
+ */
10847
+ 409: ErrorResponse;
10848
+ /**
10849
+ * The file is too large to re-ingest synchronously (`?wait=true`). Retry in background mode.
10850
+ */
10851
+ 413: ErrorResponse;
10852
+ };
10853
+ type ReingestDocumentError = ReingestDocumentErrors[keyof ReingestDocumentErrors];
10854
+ type ReingestDocumentResponses = {
10855
+ /**
10856
+ * Re-ingestion completed synchronously (only when `?wait=true`).
10857
+ */
10858
+ 201: IngestedDocumentRecord;
10859
+ /**
10860
+ * Re-ingestion accepted. The document was reset to `status=pending` and processing runs in the background. Poll `GET /api/v1/documents/{document_id}/status`.
10861
+ */
10862
+ 202: IngestedDocumentRecord;
10863
+ };
10864
+ type ReingestDocumentResponse = ReingestDocumentResponses[keyof ReingestDocumentResponses];
10865
+ type CompleteIngestionCallbackData = {
10866
+ /**
10867
+ * The converter output contract, adapted for a JSON request body: a single page as `{ text }`, or `{ pages: [{ text, page_number }] }` for multiple pages.
10868
+ */
10869
+ body: {
10870
+ text: string;
10871
+ } | {
10872
+ pages: Array<{
10873
+ text?: string;
10874
+ page_number?: number;
10875
+ }>;
10876
+ };
10877
+ path: {
10878
+ /**
10879
+ * Document ID
10880
+ */
10881
+ document_id: string;
10882
+ };
10883
+ query: {
10884
+ /**
10885
+ * Single-use signed token from the original `callback.token`
10886
+ */
10887
+ token: string;
10888
+ };
10889
+ url: '/api/v1/documents/{document_id}/ingestion-callback';
10890
+ };
10891
+ type CompleteIngestionCallbackErrors = {
10892
+ /**
10893
+ * The token is missing, invalid, or does not match this document.
10894
+ */
10895
+ 401: ErrorResponse;
10896
+ /**
10897
+ * Document not found
10898
+ */
10899
+ 404: ErrorResponse;
10900
+ /**
10901
+ * The document is no longer awaiting this conversion attempt (already completed, timed out, or superseded by a re-ingest).
10902
+ */
10903
+ 409: ErrorResponse;
10904
+ /**
10905
+ * The output shape is unrecognized.
10906
+ */
10907
+ 422: ErrorResponse;
10908
+ };
10909
+ type CompleteIngestionCallbackError = CompleteIngestionCallbackErrors[keyof CompleteIngestionCallbackErrors];
10910
+ type CompleteIngestionCallbackResponses = {
10911
+ /**
10912
+ * Conversion completed — the document was chunked and marked `ready` (or `failed` with `FILE_PARSE_FAILED` if the output produced no text).
10913
+ */
10914
+ 204: void;
10915
+ };
10916
+ type CompleteIngestionCallbackResponse = CompleteIngestionCallbackResponses[keyof CompleteIngestionCallbackResponses];
10917
+ type GetDocumentTagsData = {
10918
+ body?: never;
10919
+ path: {
10920
+ /**
10921
+ * Document ID
10922
+ */
10923
+ document_id: string;
10924
+ };
10925
+ query?: never;
10926
+ url: '/api/v1/documents/{document_id}/tags';
10927
+ };
10928
+ type GetDocumentTagsErrors = {
10929
+ /**
10930
+ * Unauthorized
10931
+ */
10932
+ 401: ErrorResponse;
10933
+ /**
10934
+ * Forbidden
10935
+ */
10936
+ 403: ErrorResponse;
10937
+ /**
10938
+ * Document not found
10939
+ */
10940
+ 404: ErrorResponse;
10941
+ };
10942
+ type GetDocumentTagsError = GetDocumentTagsErrors[keyof GetDocumentTagsErrors];
10943
+ type GetDocumentTagsResponses = {
10944
+ /**
10945
+ * Document tags
10946
+ */
10947
+ 200: TagBag;
10948
+ };
10949
+ type GetDocumentTagsResponse = GetDocumentTagsResponses[keyof GetDocumentTagsResponses];
10950
+ type MergeDocumentTagsData = {
10951
+ body: TagBag;
10952
+ path: {
10953
+ /**
10954
+ * Document ID
10955
+ */
10956
+ document_id: string;
10957
+ };
10958
+ query?: never;
10959
+ url: '/api/v1/documents/{document_id}/tags';
10960
+ };
10961
+ type MergeDocumentTagsErrors = {
10962
+ /**
10963
+ * Unauthorized
10964
+ */
10965
+ 401: ErrorResponse;
10966
+ /**
10967
+ * Forbidden
10968
+ */
10969
+ 403: ErrorResponse;
10970
+ /**
10971
+ * Document not found
10972
+ */
10973
+ 404: ErrorResponse;
10974
+ };
10975
+ type MergeDocumentTagsError = MergeDocumentTagsErrors[keyof MergeDocumentTagsErrors];
10976
+ type MergeDocumentTagsResponses = {
10977
+ /**
10978
+ * Tags merged
10979
+ */
10980
+ 200: TagBag;
10981
+ };
10982
+ type MergeDocumentTagsResponse = MergeDocumentTagsResponses[keyof MergeDocumentTagsResponses];
10983
+ type ReplaceDocumentTagsData = {
10984
+ body: TagBag;
10985
+ path: {
10986
+ /**
10987
+ * Document ID
10988
+ */
10989
+ document_id: string;
10990
+ };
10991
+ query?: never;
10385
10992
  url: '/api/v1/documents/{document_id}/tags';
10386
10993
  };
10387
10994
  type ReplaceDocumentTagsErrors = {
@@ -10707,9 +11314,7 @@ type CreateDatasetItemData = {
10707
11314
  /**
10708
11315
  * Free-form tags, opaque to the platform
10709
11316
  */
10710
- metadata?: {
10711
- [key: string]: unknown;
10712
- } | null;
11317
+ metadata?: NullableMetadataBag;
10713
11318
  };
10714
11319
  path: {
10715
11320
  /**
@@ -10762,9 +11367,7 @@ type CreateDatasetItemFromGenerationData = {
10762
11367
  /**
10763
11368
  * Free-form tags, opaque to the platform
10764
11369
  */
10765
- metadata?: {
10766
- [key: string]: unknown;
10767
- } | null;
11370
+ metadata?: NullableMetadataBag;
10768
11371
  };
10769
11372
  path: {
10770
11373
  /**
@@ -10844,9 +11447,7 @@ type UpdateDatasetItemData = {
10844
11447
  body: {
10845
11448
  input?: DatasetItemInput;
10846
11449
  expected_output?: string | null;
10847
- metadata?: {
10848
- [key: string]: unknown;
10849
- } | null;
11450
+ metadata?: NullableMetadataBag;
10850
11451
  };
10851
11452
  path: {
10852
11453
  /**
@@ -11163,9 +11764,7 @@ type StartEvalRunData = {
11163
11764
  *
11164
11765
  * The bag is caller-owned and no key is reserved: everything the platform decides about a run (`status`, `agent_version`, `baseline_run_id`, `aggregate_scores`, `passed`, the counts) is a field of its own and cannot be written from here. Nothing in the scoring path reads it. A non-object is rejected with `400 VALIDATION_FAILED` and no run is created.
11165
11766
  */
11166
- metadata?: {
11167
- [key: string]: unknown;
11168
- };
11767
+ metadata?: MetadataBag;
11169
11768
  /**
11170
11769
  * Key/value context forwarded to every item's generation, so an agent whose tools authorize through `tool_context` is scored against the configuration it runs in production rather than with an empty bag. Each key is forwarded as one `X-Soat-Context-<key>` header and resolves any `{{context:<key>}}` token in a bound tool's headers or `preset_parameters`.
11171
11770
  *
@@ -11580,10 +12179,7 @@ type CreateFileData = {
11580
12179
  * File size in bytes
11581
12180
  */
11582
12181
  size?: number | null;
11583
- /**
11584
- * JSON string with additional metadata
11585
- */
11586
- metadata?: string;
12182
+ metadata?: MetadataBag;
11587
12183
  };
11588
12184
  path?: never;
11589
12185
  query?: never;
@@ -11625,10 +12221,7 @@ type UploadFileData = {
11625
12221
  * Original / download name. Optional; defaults to the uploaded file's name.
11626
12222
  */
11627
12223
  filename?: string;
11628
- /**
11629
- * Additional metadata as a JSON string
11630
- */
11631
- metadata?: string;
12224
+ metadata?: MetadataBagText;
11632
12225
  };
11633
12226
  path?: never;
11634
12227
  query?: never;
@@ -11864,9 +12457,9 @@ type DownloadFileResponse = DownloadFileResponses[keyof DownloadFileResponses];
11864
12457
  type UpdateFileMetadataData = {
11865
12458
  body: {
11866
12459
  /**
11867
- * New metadata as a JSON string
12460
+ * Replaces the stored bag; `null` clears it.
11868
12461
  */
11869
- metadata?: string;
12462
+ metadata?: NullableMetadataBag;
11870
12463
  /**
11871
12464
  * New directory — moves the file. The resulting path (prefix + filename) must be unique within the project.
11872
12465
  */
@@ -12200,9 +12793,7 @@ type CreateFormationData = {
12200
12793
  * Static annotations stored on the formation record. This field is NOT a substitution site: `sub`/`param`/`ref` expressions are rejected with 400 (`FORMATION_INVALID_METADATA`). For deploy-time substitution use the template's top-level `metadata` block, which is resolved into `resolved_metadata`.
12201
12794
  *
12202
12795
  */
12203
- metadata?: {
12204
- [key: string]: unknown;
12205
- } | null;
12796
+ metadata?: NullableMetadataBag;
12206
12797
  };
12207
12798
  path?: never;
12208
12799
  query?: never;
@@ -12312,9 +12903,7 @@ type UpdateFormationData = {
12312
12903
  * Static annotations stored on the formation record. This field is NOT a substitution site: `sub`/`param`/`ref` expressions are rejected with 400 (`FORMATION_INVALID_METADATA`). For deploy-time substitution use the template's top-level `metadata` block, which is resolved into `resolved_metadata`.
12313
12904
  *
12314
12905
  */
12315
- metadata?: {
12316
- [key: string]: unknown;
12317
- } | null;
12906
+ metadata?: NullableMetadataBag;
12318
12907
  };
12319
12908
  path: {
12320
12909
  formation_id: string;
@@ -12732,6 +13321,12 @@ type GetGuardrailResponses = {
12732
13321
  type GetGuardrailResponse = GetGuardrailResponses[keyof GetGuardrailResponses];
12733
13322
  type UpdateGuardrailData = {
12734
13323
  body: UpdateGuardrailRequest;
13324
+ headers?: {
13325
+ /**
13326
+ * The version the caller believes the resource holds, as an entity tag (`3` or `"3"`). Equivalent to `expected_version` in the request body; `*` states no precondition beyond the resource existing. A mismatch is `409 VERSION_CONFLICT`.
13327
+ */
13328
+ 'If-Match'?: string;
13329
+ };
12735
13330
  path: {
12736
13331
  guardrail_id: string;
12737
13332
  };
@@ -13022,9 +13617,7 @@ type CreateIngestionRuleData = {
13022
13617
  /**
13023
13618
  * Arbitrary JSON metadata
13024
13619
  */
13025
- metadata?: {
13026
- [key: string]: unknown;
13027
- };
13620
+ metadata?: MetadataBag;
13028
13621
  };
13029
13622
  path?: never;
13030
13623
  query?: never;
@@ -13143,9 +13736,7 @@ type UpdateIngestionRuleData = {
13143
13736
  chunk_strategy?: 'page' | 'whole' | 'size' | null;
13144
13737
  chunk_size?: number | null;
13145
13738
  chunk_overlap?: number | null;
13146
- metadata?: {
13147
- [key: string]: unknown;
13148
- } | null;
13739
+ metadata?: NullableMetadataBag;
13149
13740
  };
13150
13741
  path: {
13151
13742
  /**
@@ -13235,6 +13826,10 @@ type SearchKnowledgeData = {
13235
13826
  * Filter results to documents and memories whose `tags` contain every one of these key-value pairs (exact, case-sensitive match). Scopes both stores, so passing it alone searches both — as `query` does. For memories it matches at memory granularity: a memory is returned when its parent memory store's tags match or its own do.
13236
13827
  */
13237
13828
  tags?: TagBag;
13829
+ /**
13830
+ * Filter document results by their `metadata` bag. A document-store filter: a memory carries no such bag, so passing it alone searches documents, as `document_paths` does.
13831
+ */
13832
+ metadata?: MetadataFilter;
13238
13833
  };
13239
13834
  path?: never;
13240
13835
  query?: never;
@@ -13286,7 +13881,7 @@ type ListMemoriesData = {
13286
13881
  */
13287
13882
  offset?: number;
13288
13883
  /**
13289
- * Include invalidated (superseded) memories. They are excluded by default; set this to audit the supersede history.
13884
+ * Include invalidated memories — superseded or retracted. They are excluded by default; set this to audit what a store once held.
13290
13885
  */
13291
13886
  include_invalidated?: boolean;
13292
13887
  };
@@ -13347,9 +13942,7 @@ type CreateMemoryData = {
13347
13942
  /**
13348
13943
  * Arbitrary structured metadata attached to the memory
13349
13944
  */
13350
- metadata?: {
13351
- [key: string]: unknown;
13352
- };
13945
+ metadata?: MetadataBag;
13353
13946
  /**
13354
13947
  * The memory this write replaces, named outright. The declaration outranks the thresholds in both directions: the target is retired and the write returns `superseded` however similar or distant the two texts are. This is what reaches a contradiction cosine cannot see ("The office is in Lisbon" then "We closed the Lisbon office"). The target must be a still-valid memory in the same memory store, and the caller needs `memories:UpdateMemory` on it as well as `memories:CreateMemory` on the store.
13355
13948
  */
@@ -13463,37 +14056,89 @@ type GetMemoryErrors = {
13463
14056
  */
13464
14057
  500: unknown;
13465
14058
  };
13466
- type GetMemoryResponses = {
14059
+ type GetMemoryResponses = {
14060
+ /**
14061
+ * Memory found
14062
+ */
14063
+ 200: Memory;
14064
+ };
14065
+ type GetMemoryResponse = GetMemoryResponses[keyof GetMemoryResponses];
14066
+ type UpdateMemoryData = {
14067
+ body: {
14068
+ /**
14069
+ * Updated text content
14070
+ */
14071
+ content?: string;
14072
+ /**
14073
+ * Replaces the memory's tags. Pass null or an empty object to clear.
14074
+ */
14075
+ tags?: NullableTagBag;
14076
+ /**
14077
+ * Replaces the memory's metadata. Pass null to clear.
14078
+ */
14079
+ metadata?: NullableMetadataBag;
14080
+ /**
14081
+ * Refuses the write unless the memory is at this version.
14082
+ */
14083
+ expected_version?: ExpectedVersion;
14084
+ };
14085
+ headers?: {
14086
+ /**
14087
+ * The version the caller believes the resource holds, as an entity tag (`3` or `"3"`). Equivalent to `expected_version` in the request body; `*` states no precondition beyond the resource existing. A mismatch is `409 VERSION_CONFLICT`.
14088
+ */
14089
+ 'If-Match'?: string;
14090
+ };
14091
+ path: {
14092
+ memory_id: string;
14093
+ };
14094
+ query?: never;
14095
+ url: '/api/v1/memories/{memory_id}';
14096
+ };
14097
+ type UpdateMemoryErrors = {
14098
+ /**
14099
+ * Unauthorized
14100
+ */
14101
+ 401: unknown;
14102
+ /**
14103
+ * Forbidden
14104
+ */
14105
+ 403: unknown;
14106
+ /**
14107
+ * Memory store or memory not found
14108
+ */
14109
+ 404: unknown;
14110
+ /**
14111
+ * Internal server error
14112
+ */
14113
+ 500: unknown;
14114
+ };
14115
+ type UpdateMemoryResponses = {
13467
14116
  /**
13468
- * Memory found
14117
+ * Memory updated
13469
14118
  */
13470
14119
  200: Memory;
13471
14120
  };
13472
- type GetMemoryResponse = GetMemoryResponses[keyof GetMemoryResponses];
13473
- type UpdateMemoryData = {
13474
- body: {
13475
- /**
13476
- * Updated text content
13477
- */
13478
- content?: string;
14121
+ type UpdateMemoryResponse = UpdateMemoryResponses[keyof UpdateMemoryResponses];
14122
+ type RetractMemoryData = {
14123
+ body?: {
13479
14124
  /**
13480
- * Replaces the memory's tags. Pass null or an empty object to clear.
14125
+ * Refuses the retraction unless the memory is at this version.
13481
14126
  */
13482
- tags?: NullableTagBag;
14127
+ expected_version?: ExpectedVersion;
14128
+ };
14129
+ headers?: {
13483
14130
  /**
13484
- * Replaces the memory's metadata. Pass null to clear.
14131
+ * The version the caller believes the resource holds, as an entity tag (`3` or `"3"`). Equivalent to `expected_version` in the request body; `*` states no precondition beyond the resource existing. A mismatch is `409 VERSION_CONFLICT`.
13485
14132
  */
13486
- metadata?: {
13487
- [key: string]: unknown;
13488
- } | null;
14133
+ 'If-Match'?: string;
13489
14134
  };
13490
14135
  path: {
13491
14136
  memory_id: string;
13492
14137
  };
13493
14138
  query?: never;
13494
- url: '/api/v1/memories/{memory_id}';
14139
+ url: '/api/v1/memories/{memory_id}/retract';
13495
14140
  };
13496
- type UpdateMemoryErrors = {
14141
+ type RetractMemoryErrors = {
13497
14142
  /**
13498
14143
  * Unauthorized
13499
14144
  */
@@ -13506,18 +14151,22 @@ type UpdateMemoryErrors = {
13506
14151
  * Memory store or memory not found
13507
14152
  */
13508
14153
  404: unknown;
14154
+ /**
14155
+ * Conflict — the memory is already invalidated, or the version moved
14156
+ */
14157
+ 409: unknown;
13509
14158
  /**
13510
14159
  * Internal server error
13511
14160
  */
13512
14161
  500: unknown;
13513
14162
  };
13514
- type UpdateMemoryResponses = {
14163
+ type RetractMemoryResponses = {
13515
14164
  /**
13516
- * Memory updated
14165
+ * The retracted memory
13517
14166
  */
13518
14167
  200: Memory;
13519
14168
  };
13520
- type UpdateMemoryResponse = UpdateMemoryResponses[keyof UpdateMemoryResponses];
14169
+ type RetractMemoryResponse = RetractMemoryResponses[keyof RetractMemoryResponses];
13521
14170
  type ListMemoryAssertionsData = {
13522
14171
  body?: never;
13523
14172
  path: {
@@ -13865,32 +14514,258 @@ type UpdateMemoryRuleData = {
13865
14514
  body: {
13866
14515
  on?: MemoryRuleEvent;
13867
14516
  /**
13868
- * Send `null` to widen the rule to every agent in the project
14517
+ * Send `null` to widen the rule to every agent in the project
14518
+ */
14519
+ source_agent_ids?: Array<string> | null;
14520
+ agent_id?: string | null;
14521
+ tool_id?: string | null;
14522
+ action?: string | null;
14523
+ preset_parameters?: {
14524
+ [key: string]: unknown;
14525
+ } | null;
14526
+ prompt?: string | null;
14527
+ ai_provider_id?: string | null;
14528
+ model?: string | null;
14529
+ enabled?: boolean;
14530
+ };
14531
+ path: {
14532
+ /**
14533
+ * Memory rule ID
14534
+ */
14535
+ memory_rule_id: string;
14536
+ };
14537
+ query?: never;
14538
+ url: '/api/v1/memory-rules/{memory_rule_id}';
14539
+ };
14540
+ type UpdateMemoryRuleErrors = {
14541
+ /**
14542
+ * Validation failed
14543
+ */
14544
+ 400: unknown;
14545
+ /**
14546
+ * Unauthorized
14547
+ */
14548
+ 401: unknown;
14549
+ /**
14550
+ * Forbidden
14551
+ */
14552
+ 403: unknown;
14553
+ /**
14554
+ * Memory rule not found
14555
+ */
14556
+ 404: unknown;
14557
+ };
14558
+ type UpdateMemoryRuleResponses = {
14559
+ /**
14560
+ * Memory rule updated
14561
+ */
14562
+ 200: MemoryRule;
14563
+ };
14564
+ type UpdateMemoryRuleResponse = UpdateMemoryRuleResponses[keyof UpdateMemoryRuleResponses];
14565
+ type ListMemoryStoresData = {
14566
+ body?: never;
14567
+ path?: never;
14568
+ query?: {
14569
+ /**
14570
+ * Project ID (required if not using project key auth)
14571
+ */
14572
+ project_id?: string;
14573
+ /**
14574
+ * Filter by tag pairs, written `key:value` (split on the first colon, so a value may contain colons). Repeat the parameter for several pairs; **all** must be present with exactly that value.
14575
+ *
14576
+ */
14577
+ tags?: Array<string>;
14578
+ /**
14579
+ * Maximum number of results to return
14580
+ */
14581
+ limit?: number;
14582
+ /**
14583
+ * Number of results to skip
14584
+ */
14585
+ offset?: number;
14586
+ };
14587
+ url: '/api/v1/memory-stores';
14588
+ };
14589
+ type ListMemoryStoresErrors = {
14590
+ /**
14591
+ * Unauthorized
14592
+ */
14593
+ 401: unknown;
14594
+ /**
14595
+ * Forbidden
14596
+ */
14597
+ 403: unknown;
14598
+ /**
14599
+ * Internal server error
14600
+ */
14601
+ 500: unknown;
14602
+ };
14603
+ type ListMemoryStoresResponses = {
14604
+ /**
14605
+ * List of memory stores
14606
+ */
14607
+ 200: {
14608
+ data: Array<MemoryStore>;
14609
+ total: number;
14610
+ limit: number;
14611
+ offset: number;
14612
+ };
14613
+ };
14614
+ type ListMemoryStoresResponse = ListMemoryStoresResponses[keyof ListMemoryStoresResponses];
14615
+ type CreateMemoryStoreData = {
14616
+ body: {
14617
+ /**
14618
+ * Project ID (required if not using project key auth)
14619
+ */
14620
+ project_id?: string;
14621
+ /**
14622
+ * Memory store name
14623
+ */
14624
+ name: string;
14625
+ /**
14626
+ * Optional description
14627
+ */
14628
+ description?: string;
14629
+ /**
14630
+ * Optional key-value tags. Scopes the memory store in knowledge search, where every requested pair must match exactly.
14631
+ */
14632
+ tags?: TagBag;
14633
+ /**
14634
+ * The store's dedup policy: cosine similarity at or above which an incoming fact is already known and the write is skipped. `null` (the default) uses the algorithm constant `0.95`. A single `POST /api/v1/memories` call may override it; the agent tool and the post-turn rule never can.
14635
+ */
14636
+ duplicate_threshold?: number | null;
14637
+ /**
14638
+ * Cosine similarity at or above which an incoming fact restates a known one that has changed: the matched memory is invalidated and replaced. `null` (the default) uses the algorithm constant `0.90`. Must be lower than the effective `duplicate_threshold`, or the write is rejected with `400 VALIDATION_FAILED` — equal makes `superseded` unreachable and inverted swallows `skipped`.
14639
+ */
14640
+ supersede_threshold?: number | null;
14641
+ };
14642
+ path?: never;
14643
+ query?: never;
14644
+ url: '/api/v1/memory-stores';
14645
+ };
14646
+ type CreateMemoryStoreErrors = {
14647
+ /**
14648
+ * Bad request — a missing required field, a threshold outside `[0, 1]`, or a pair that is not `supersede_threshold < duplicate_threshold`.
14649
+ */
14650
+ 400: unknown;
14651
+ /**
14652
+ * Unauthorized
14653
+ */
14654
+ 401: unknown;
14655
+ /**
14656
+ * Forbidden
14657
+ */
14658
+ 403: unknown;
14659
+ /**
14660
+ * Internal server error
14661
+ */
14662
+ 500: unknown;
14663
+ };
14664
+ type CreateMemoryStoreResponses = {
14665
+ /**
14666
+ * Memory store created
14667
+ */
14668
+ 201: MemoryStore;
14669
+ };
14670
+ type CreateMemoryStoreResponse = CreateMemoryStoreResponses[keyof CreateMemoryStoreResponses];
14671
+ type DeleteMemoryStoreData = {
14672
+ body?: never;
14673
+ path: {
14674
+ memory_store_id: string;
14675
+ };
14676
+ query?: never;
14677
+ url: '/api/v1/memory-stores/{memory_store_id}';
14678
+ };
14679
+ type DeleteMemoryStoreErrors = {
14680
+ /**
14681
+ * Unauthorized
14682
+ */
14683
+ 401: unknown;
14684
+ /**
14685
+ * Forbidden
14686
+ */
14687
+ 403: unknown;
14688
+ /**
14689
+ * Memory store not found
14690
+ */
14691
+ 404: unknown;
14692
+ /**
14693
+ * Internal server error
14694
+ */
14695
+ 500: unknown;
14696
+ };
14697
+ type DeleteMemoryStoreResponses = {
14698
+ /**
14699
+ * Memory store deleted
14700
+ */
14701
+ 204: void;
14702
+ };
14703
+ type DeleteMemoryStoreResponse = DeleteMemoryStoreResponses[keyof DeleteMemoryStoreResponses];
14704
+ type GetMemoryStoreData = {
14705
+ body?: never;
14706
+ path: {
14707
+ memory_store_id: string;
14708
+ };
14709
+ query?: never;
14710
+ url: '/api/v1/memory-stores/{memory_store_id}';
14711
+ };
14712
+ type GetMemoryStoreErrors = {
14713
+ /**
14714
+ * Unauthorized
14715
+ */
14716
+ 401: unknown;
14717
+ /**
14718
+ * Forbidden
14719
+ */
14720
+ 403: unknown;
14721
+ /**
14722
+ * Memory store not found
14723
+ */
14724
+ 404: unknown;
14725
+ /**
14726
+ * Internal server error
14727
+ */
14728
+ 500: unknown;
14729
+ };
14730
+ type GetMemoryStoreResponses = {
14731
+ /**
14732
+ * Memory store found
14733
+ */
14734
+ 200: MemoryStore;
14735
+ };
14736
+ type GetMemoryStoreResponse = GetMemoryStoreResponses[keyof GetMemoryStoreResponses];
14737
+ type UpdateMemoryStoreData = {
14738
+ body: {
14739
+ /**
14740
+ * Memory store name
14741
+ */
14742
+ name?: string;
14743
+ /**
14744
+ * Optional description
14745
+ */
14746
+ description?: string | null;
14747
+ /**
14748
+ * Optional key-value tags. Replaces the stored bag; `null` clears it.
13869
14749
  */
13870
- source_agent_ids?: Array<string> | null;
13871
- agent_id?: string | null;
13872
- tool_id?: string | null;
13873
- action?: string | null;
13874
- preset_parameters?: {
13875
- [key: string]: unknown;
13876
- } | null;
13877
- prompt?: string | null;
13878
- ai_provider_id?: string | null;
13879
- model?: string | null;
13880
- enabled?: boolean;
13881
- };
13882
- path: {
14750
+ tags?: NullableTagBag;
13883
14751
  /**
13884
- * Memory rule ID
14752
+ * The store's dedup policy: cosine similarity at or above which an incoming fact is already known and the write is skipped. `null` (the default) uses the algorithm constant `0.95`. A single `POST /api/v1/memories` call may override it; the agent tool and the post-turn rule never can.
13885
14753
  */
13886
- memory_rule_id: string;
14754
+ duplicate_threshold?: number | null;
14755
+ /**
14756
+ * Cosine similarity at or above which an incoming fact restates a known one that has changed: the matched memory is invalidated and replaced. `null` (the default) uses the algorithm constant `0.90`. Must be lower than the effective `duplicate_threshold`, or the write is rejected with `400 VALIDATION_FAILED` — equal makes `superseded` unreachable and inverted swallows `skipped`.
14757
+ */
14758
+ supersede_threshold?: number | null;
14759
+ };
14760
+ path: {
14761
+ memory_store_id: string;
13887
14762
  };
13888
14763
  query?: never;
13889
- url: '/api/v1/memory-rules/{memory_rule_id}';
14764
+ url: '/api/v1/memory-stores/{memory_store_id}';
13890
14765
  };
13891
- type UpdateMemoryRuleErrors = {
14766
+ type UpdateMemoryStoreErrors = {
13892
14767
  /**
13893
- * Validation failed
14768
+ * Bad request — a threshold outside `[0, 1]`, or a pair that is not `supersede_threshold < duplicate_threshold` once the stored values this request does not replace are applied.
13894
14769
  */
13895
14770
  400: unknown;
13896
14771
  /**
@@ -13902,30 +14777,43 @@ type UpdateMemoryRuleErrors = {
13902
14777
  */
13903
14778
  403: unknown;
13904
14779
  /**
13905
- * Memory rule not found
14780
+ * Memory store not found
13906
14781
  */
13907
14782
  404: unknown;
14783
+ /**
14784
+ * Internal server error
14785
+ */
14786
+ 500: unknown;
13908
14787
  };
13909
- type UpdateMemoryRuleResponses = {
14788
+ type UpdateMemoryStoreResponses = {
13910
14789
  /**
13911
- * Memory rule updated
14790
+ * Memory store updated
13912
14791
  */
13913
- 200: MemoryRule;
14792
+ 200: MemoryStore;
13914
14793
  };
13915
- type UpdateMemoryRuleResponse = UpdateMemoryRuleResponses[keyof UpdateMemoryRuleResponses];
13916
- type ListMemoryStoresData = {
14794
+ type UpdateMemoryStoreResponse = UpdateMemoryStoreResponses[keyof UpdateMemoryStoreResponses];
14795
+ type ListMemoryStoreAssertionsData = {
13917
14796
  body?: never;
13918
- path?: never;
14797
+ path: {
14798
+ memory_store_id: string;
14799
+ };
13919
14800
  query?: {
13920
14801
  /**
13921
- * Project ID (required if not using project key auth)
14802
+ * Only assertions that came through this door.
13922
14803
  */
13923
- project_id?: string;
14804
+ mechanism?: 'tool' | 'rule' | 'api' | 'formation';
13924
14805
  /**
13925
- * Filter by tag pairs, written `key:value` (split on the first colon, so a value may contain colons). Repeat the parameter for several pairs; **all** must be present with exactly that value.
13926
- *
14806
+ * Only assertions that resolved this way.
13927
14807
  */
13928
- tags?: Array<string>;
14808
+ outcome?: 'created' | 'superseded' | 'skipped';
14809
+ /**
14810
+ * Only assertions made during this generation. A generation that does not exist matches nothing rather than widening to the whole store.
14811
+ */
14812
+ generation_id?: string;
14813
+ /**
14814
+ * Only assertions recorded at or after this instant.
14815
+ */
14816
+ since?: Date;
13929
14817
  /**
13930
14818
  * Maximum number of results to return
13931
14819
  */
@@ -13935,9 +14823,13 @@ type ListMemoryStoresData = {
13935
14823
  */
13936
14824
  offset?: number;
13937
14825
  };
13938
- url: '/api/v1/memory-stores';
14826
+ url: '/api/v1/memory-stores/{memory_store_id}/assertions';
13939
14827
  };
13940
- type ListMemoryStoresErrors = {
14828
+ type ListMemoryStoreAssertionsErrors = {
14829
+ /**
14830
+ * An unknown `mechanism` or `outcome`, or a `since` that is not a timestamp
14831
+ */
14832
+ 400: unknown;
13941
14833
  /**
13942
14834
  * Unauthorized
13943
14835
  */
@@ -13946,59 +14838,49 @@ type ListMemoryStoresErrors = {
13946
14838
  * Forbidden
13947
14839
  */
13948
14840
  403: unknown;
14841
+ /**
14842
+ * Memory store not found
14843
+ */
14844
+ 404: unknown;
13949
14845
  /**
13950
14846
  * Internal server error
13951
14847
  */
13952
14848
  500: unknown;
13953
14849
  };
13954
- type ListMemoryStoresResponses = {
14850
+ type ListMemoryStoreAssertionsResponses = {
13955
14851
  /**
13956
- * List of memory stores
14852
+ * List of assertions
13957
14853
  */
13958
14854
  200: {
13959
- data: Array<MemoryStore>;
14855
+ data: Array<MemoryAssertion>;
13960
14856
  total: number;
13961
14857
  limit: number;
13962
14858
  offset: number;
13963
14859
  };
13964
14860
  };
13965
- type ListMemoryStoresResponse = ListMemoryStoresResponses[keyof ListMemoryStoresResponses];
13966
- type CreateMemoryStoreData = {
13967
- body: {
13968
- /**
13969
- * Project ID (required if not using project key auth)
13970
- */
13971
- project_id?: string;
13972
- /**
13973
- * Memory store name
13974
- */
13975
- name: string;
13976
- /**
13977
- * Optional description
13978
- */
13979
- description?: string;
14861
+ type ListMemoryStoreAssertionsResponse = ListMemoryStoreAssertionsResponses[keyof ListMemoryStoreAssertionsResponses];
14862
+ type ExportMemoriesData = {
14863
+ body?: never;
14864
+ path: {
13980
14865
  /**
13981
- * Optional key-value tags. Scopes the memory store in knowledge search, where every requested pair must match exactly.
14866
+ * Memory store whose memories are exported
13982
14867
  */
13983
- tags?: TagBag;
14868
+ memory_store_id: string;
14869
+ };
14870
+ query?: {
13984
14871
  /**
13985
- * The store's dedup policy: cosine similarity at or above which an incoming fact is already known and the write is skipped. `null` (the default) uses the algorithm constant `0.95`. A single `POST /api/v1/memories` call may override it; the agent tool and the post-turn rule never can.
14872
+ * Include memories that were retracted or superseded
13986
14873
  */
13987
- duplicate_threshold?: number | null;
14874
+ include_invalidated?: boolean;
13988
14875
  /**
13989
- * Cosine similarity at or above which an incoming fact restates a known one that has changed: the matched memory is invalidated and replaced. `null` (the default) uses the algorithm constant `0.90`. Must be lower than the effective `duplicate_threshold`, or the write is rejected with `400 VALIDATION_FAILED` — equal makes `superseded` unreachable and inverted swallows `skipped`.
14876
+ * Filter by tag pairs, written `key:value` (split on the first colon, so a value may contain colons). Repeat the parameter for several pairs; **all** must be present with exactly that value.
14877
+ *
13990
14878
  */
13991
- supersede_threshold?: number | null;
14879
+ tags?: Array<string>;
13992
14880
  };
13993
- path?: never;
13994
- query?: never;
13995
- url: '/api/v1/memory-stores';
14881
+ url: '/api/v1/memory-stores/{memory_store_id}/export';
13996
14882
  };
13997
- type CreateMemoryStoreErrors = {
13998
- /**
13999
- * Bad request — a missing required field, a threshold outside `[0, 1]`, or a pair that is not `supersede_threshold < duplicate_threshold`.
14000
- */
14001
- 400: unknown;
14883
+ type ExportMemoriesErrors = {
14002
14884
  /**
14003
14885
  * Unauthorized
14004
14886
  */
@@ -14008,26 +14890,29 @@ type CreateMemoryStoreErrors = {
14008
14890
  */
14009
14891
  403: unknown;
14010
14892
  /**
14011
- * Internal server error
14893
+ * Memory store not found
14012
14894
  */
14013
- 500: unknown;
14895
+ 404: unknown;
14014
14896
  };
14015
- type CreateMemoryStoreResponses = {
14897
+ type ExportMemoriesResponses = {
14016
14898
  /**
14017
- * Memory store created
14899
+ * A newline-delimited stream of memories. Each line is a JSON object with the same fields as `Memory`.
14018
14900
  */
14019
- 201: MemoryStore;
14901
+ 200: string;
14020
14902
  };
14021
- type CreateMemoryStoreResponse = CreateMemoryStoreResponses[keyof CreateMemoryStoreResponses];
14022
- type DeleteMemoryStoreData = {
14903
+ type ExportMemoriesResponse = ExportMemoriesResponses[keyof ExportMemoriesResponses];
14904
+ type GetMemoryStoreTagsData = {
14023
14905
  body?: never;
14024
14906
  path: {
14907
+ /**
14908
+ * Memory store ID
14909
+ */
14025
14910
  memory_store_id: string;
14026
14911
  };
14027
14912
  query?: never;
14028
- url: '/api/v1/memory-stores/{memory_store_id}';
14913
+ url: '/api/v1/memory-stores/{memory_store_id}/tags';
14029
14914
  };
14030
- type DeleteMemoryStoreErrors = {
14915
+ type GetMemoryStoreTagsErrors = {
14031
14916
  /**
14032
14917
  * Unauthorized
14033
14918
  */
@@ -14040,27 +14925,66 @@ type DeleteMemoryStoreErrors = {
14040
14925
  * Memory store not found
14041
14926
  */
14042
14927
  404: unknown;
14928
+ };
14929
+ type GetMemoryStoreTagsResponses = {
14043
14930
  /**
14044
- * Internal server error
14931
+ * Memory store tags
14045
14932
  */
14046
- 500: unknown;
14933
+ 200: TagBag;
14047
14934
  };
14048
- type DeleteMemoryStoreResponses = {
14935
+ type GetMemoryStoreTagsResponse = GetMemoryStoreTagsResponses[keyof GetMemoryStoreTagsResponses];
14936
+ type MergeMemoryStoreTagsData = {
14937
+ body: TagBag;
14938
+ path: {
14939
+ /**
14940
+ * Memory store ID
14941
+ */
14942
+ memory_store_id: string;
14943
+ };
14944
+ query?: never;
14945
+ url: '/api/v1/memory-stores/{memory_store_id}/tags';
14946
+ };
14947
+ type MergeMemoryStoreTagsErrors = {
14049
14948
  /**
14050
- * Memory store deleted
14949
+ * Body is not an object of string values
14051
14950
  */
14052
- 204: void;
14951
+ 400: unknown;
14952
+ /**
14953
+ * Unauthorized
14954
+ */
14955
+ 401: unknown;
14956
+ /**
14957
+ * Forbidden
14958
+ */
14959
+ 403: unknown;
14960
+ /**
14961
+ * Memory store not found
14962
+ */
14963
+ 404: unknown;
14053
14964
  };
14054
- type DeleteMemoryStoreResponse = DeleteMemoryStoreResponses[keyof DeleteMemoryStoreResponses];
14055
- type GetMemoryStoreData = {
14056
- body?: never;
14965
+ type MergeMemoryStoreTagsResponses = {
14966
+ /**
14967
+ * Tags merged
14968
+ */
14969
+ 200: TagBag;
14970
+ };
14971
+ type MergeMemoryStoreTagsResponse = MergeMemoryStoreTagsResponses[keyof MergeMemoryStoreTagsResponses];
14972
+ type ReplaceMemoryStoreTagsData = {
14973
+ body: TagBag;
14057
14974
  path: {
14975
+ /**
14976
+ * Memory store ID
14977
+ */
14058
14978
  memory_store_id: string;
14059
14979
  };
14060
14980
  query?: never;
14061
- url: '/api/v1/memory-stores/{memory_store_id}';
14981
+ url: '/api/v1/memory-stores/{memory_store_id}/tags';
14062
14982
  };
14063
- type GetMemoryStoreErrors = {
14983
+ type ReplaceMemoryStoreTagsErrors = {
14984
+ /**
14985
+ * Body is not an object of string values
14986
+ */
14987
+ 400: unknown;
14064
14988
  /**
14065
14989
  * Unauthorized
14066
14990
  */
@@ -14073,247 +14997,272 @@ type GetMemoryStoreErrors = {
14073
14997
  * Memory store not found
14074
14998
  */
14075
14999
  404: unknown;
15000
+ };
15001
+ type ReplaceMemoryStoreTagsResponses = {
14076
15002
  /**
14077
- * Internal server error
15003
+ * Tags replaced
14078
15004
  */
14079
- 500: unknown;
15005
+ 200: TagBag;
14080
15006
  };
14081
- type GetMemoryStoreResponses = {
15007
+ type ReplaceMemoryStoreTagsResponse = ReplaceMemoryStoreTagsResponses[keyof ReplaceMemoryStoreTagsResponses];
15008
+ type ListMetadataSchemasData = {
15009
+ body?: never;
15010
+ path?: never;
15011
+ query?: {
15012
+ /**
15013
+ * Project public ID (proj_ prefix)
15014
+ */
15015
+ project_id?: string;
15016
+ /**
15017
+ * Return only the declarations governing this resource.
15018
+ */
15019
+ resource_type?: 'document';
15020
+ /**
15021
+ * Maximum number of results to return
15022
+ */
15023
+ limit?: number;
15024
+ /**
15025
+ * Number of results to skip
15026
+ */
15027
+ offset?: number;
15028
+ };
15029
+ url: '/api/v1/metadata-schemas';
15030
+ };
15031
+ type ListMetadataSchemasErrors = {
14082
15032
  /**
14083
- * Memory store found
15033
+ * Unauthorized
14084
15034
  */
14085
- 200: MemoryStore;
15035
+ 401: ErrorResponse;
15036
+ /**
15037
+ * Forbidden
15038
+ */
15039
+ 403: ErrorResponse;
14086
15040
  };
14087
- type GetMemoryStoreResponse = GetMemoryStoreResponses[keyof GetMemoryStoreResponses];
14088
- type UpdateMemoryStoreData = {
15041
+ type ListMetadataSchemasError = ListMetadataSchemasErrors[keyof ListMetadataSchemasErrors];
15042
+ type ListMetadataSchemasResponses = {
15043
+ /**
15044
+ * The declarations in scope
15045
+ */
15046
+ 200: {
15047
+ data: Array<MetadataSchemaRecord>;
15048
+ total: number;
15049
+ limit: number;
15050
+ offset: number;
15051
+ };
15052
+ };
15053
+ type ListMetadataSchemasResponse = ListMetadataSchemasResponses[keyof ListMetadataSchemasResponses];
15054
+ type CreateMetadataSchemaData = {
14089
15055
  body: {
14090
15056
  /**
14091
- * Memory store name
14092
- */
14093
- name?: string;
14094
- /**
14095
- * Optional description
15057
+ * Project the declaration governs. Optional for a project-scoped API key, which supplies it.
14096
15058
  */
14097
- description?: string | null;
15059
+ project_id?: string;
14098
15060
  /**
14099
- * Optional key-value tags. Replaces the stored bag; `null` clears it.
15061
+ * The resource whose metadata this declaration governs. A type appears here once its write path reads the registry, so a declaration always has a door that enforces it.
14100
15062
  */
14101
- tags?: NullableTagBag;
15063
+ resource_type: 'document';
14102
15064
  /**
14103
- * The store's dedup policy: cosine similarity at or above which an incoming fact is already known and the write is skipped. `null` (the default) uses the algorithm constant `0.95`. A single `POST /api/v1/memories` call may override it; the agent tool and the post-turn rule never can.
15065
+ * The selector a `document` declaration must carry: the directory it governs.
14104
15066
  */
14105
- duplicate_threshold?: number | null;
15067
+ path_prefix?: string;
14106
15068
  /**
14107
- * Cosine similarity at or above which an incoming fact restates a known one that has changed: the matched memory is invalidated and replaced. `null` (the default) uses the algorithm constant `0.90`. Must be lower than the effective `duplicate_threshold`, or the write is rejected with `400 VALIDATION_FAILED` — equal makes `superseded` unreachable and inverted swallows `skipped`.
15069
+ * A JSON Schema. Its keywords are its own vocabulary and are stored as written.
14108
15070
  */
14109
- supersede_threshold?: number | null;
14110
- };
14111
- path: {
14112
- memory_store_id: string;
15071
+ schema: {
15072
+ [key: string]: unknown;
15073
+ };
14113
15074
  };
15075
+ path?: never;
14114
15076
  query?: never;
14115
- url: '/api/v1/memory-stores/{memory_store_id}';
15077
+ url: '/api/v1/metadata-schemas';
14116
15078
  };
14117
- type UpdateMemoryStoreErrors = {
15079
+ type CreateMetadataSchemaErrors = {
14118
15080
  /**
14119
- * Bad request — a threshold outside `[0, 1]`, or a pair that is not `supersede_threshold < duplicate_threshold` once the stored values this request does not replace are applied.
15081
+ * Bad Request — unknown `resource_type`, a missing or unusable selector, the reserved root, or a schema that is not valid JSON Schema
14120
15082
  */
14121
- 400: unknown;
15083
+ 400: ErrorResponse;
14122
15084
  /**
14123
15085
  * Unauthorized
14124
15086
  */
14125
- 401: unknown;
15087
+ 401: ErrorResponse;
14126
15088
  /**
14127
15089
  * Forbidden
14128
15090
  */
14129
- 403: unknown;
14130
- /**
14131
- * Memory store not found
14132
- */
14133
- 404: unknown;
15091
+ 403: ErrorResponse;
14134
15092
  /**
14135
- * Internal server error
15093
+ * Conflict — this selector is already declared for this type
14136
15094
  */
14137
- 500: unknown;
15095
+ 409: ErrorResponse;
14138
15096
  };
14139
- type UpdateMemoryStoreResponses = {
15097
+ type CreateMetadataSchemaError = CreateMetadataSchemaErrors[keyof CreateMetadataSchemaErrors];
15098
+ type CreateMetadataSchemaResponses = {
14140
15099
  /**
14141
- * Memory store updated
15100
+ * The declaration
14142
15101
  */
14143
- 200: MemoryStore;
15102
+ 201: MetadataSchemaRecord;
14144
15103
  };
14145
- type UpdateMemoryStoreResponse = UpdateMemoryStoreResponses[keyof UpdateMemoryStoreResponses];
14146
- type ListMemoryStoreAssertionsData = {
14147
- body?: never;
14148
- path: {
14149
- memory_store_id: string;
14150
- };
14151
- query?: {
14152
- /**
14153
- * Only assertions that came through this door.
14154
- */
14155
- mechanism?: 'tool' | 'rule' | 'api' | 'formation';
14156
- /**
14157
- * Only assertions that resolved this way.
14158
- */
14159
- outcome?: 'created' | 'superseded' | 'skipped';
14160
- /**
14161
- * Only assertions made during this generation. A generation that does not exist matches nothing rather than widening to the whole store.
14162
- */
14163
- generation_id?: string;
14164
- /**
14165
- * Only assertions recorded at or after this instant.
14166
- */
14167
- since?: Date;
15104
+ type CreateMetadataSchemaResponse = CreateMetadataSchemaResponses[keyof CreateMetadataSchemaResponses];
15105
+ type ValidateMetadataData = {
15106
+ body: {
15107
+ project_id?: string;
14168
15108
  /**
14169
- * Maximum number of results to return
15109
+ * The path the document would be filed at, which decides which declaration governs it.
14170
15110
  */
14171
- limit?: number;
15111
+ path: string;
14172
15112
  /**
14173
- * Number of results to skip
15113
+ * The bag to judge. Absent or `null` is judged as an empty bag.
14174
15114
  */
14175
- offset?: number;
15115
+ metadata?: NullableMetadataBag;
14176
15116
  };
14177
- url: '/api/v1/memory-stores/{memory_store_id}/assertions';
15117
+ path?: never;
15118
+ query?: never;
15119
+ url: '/api/v1/metadata-schemas/validate';
14178
15120
  };
14179
- type ListMemoryStoreAssertionsErrors = {
14180
- /**
14181
- * An unknown `mechanism` or `outcome`, or a `since` that is not a timestamp
14182
- */
14183
- 400: unknown;
15121
+ type ValidateMetadataErrors = {
14184
15122
  /**
14185
15123
  * Unauthorized
14186
15124
  */
14187
- 401: unknown;
15125
+ 401: ErrorResponse;
14188
15126
  /**
14189
15127
  * Forbidden
14190
15128
  */
14191
- 403: unknown;
14192
- /**
14193
- * Memory store not found
14194
- */
14195
- 404: unknown;
14196
- /**
14197
- * Internal server error
14198
- */
14199
- 500: unknown;
15129
+ 403: ErrorResponse;
14200
15130
  };
14201
- type ListMemoryStoreAssertionsResponses = {
15131
+ type ValidateMetadataError = ValidateMetadataErrors[keyof ValidateMetadataErrors];
15132
+ type ValidateMetadataResponses = {
14202
15133
  /**
14203
- * List of assertions
15134
+ * The verdict
14204
15135
  */
14205
15136
  200: {
14206
- data: Array<MemoryAssertion>;
14207
- total: number;
14208
- limit: number;
14209
- offset: number;
15137
+ /**
15138
+ * Whether a write of this metadata at this path would be accepted.
15139
+ */
15140
+ valid: boolean;
15141
+ resource_type: 'document';
15142
+ /**
15143
+ * The declaration that would refuse it; `null` when the metadata is accepted or nothing governs the path.
15144
+ */
15145
+ metadata_schema_id: string | null;
15146
+ /**
15147
+ * The refusing declaration's selector.
15148
+ */
15149
+ path_prefix: string | null;
15150
+ /**
15151
+ * What the metadata violates, field by field.
15152
+ */
15153
+ error: string | null;
14210
15154
  };
14211
15155
  };
14212
- type ListMemoryStoreAssertionsResponse = ListMemoryStoreAssertionsResponses[keyof ListMemoryStoreAssertionsResponses];
14213
- type GetMemoryStoreTagsData = {
15156
+ type ValidateMetadataResponse = ValidateMetadataResponses[keyof ValidateMetadataResponses];
15157
+ type DeleteMetadataSchemaData = {
14214
15158
  body?: never;
14215
15159
  path: {
14216
- /**
14217
- * Memory store ID
14218
- */
14219
- memory_store_id: string;
15160
+ metadata_schema_id: string;
14220
15161
  };
14221
15162
  query?: never;
14222
- url: '/api/v1/memory-stores/{memory_store_id}/tags';
15163
+ url: '/api/v1/metadata-schemas/{metadata_schema_id}';
14223
15164
  };
14224
- type GetMemoryStoreTagsErrors = {
15165
+ type DeleteMetadataSchemaErrors = {
14225
15166
  /**
14226
15167
  * Unauthorized
14227
15168
  */
14228
- 401: unknown;
15169
+ 401: ErrorResponse;
14229
15170
  /**
14230
15171
  * Forbidden
14231
15172
  */
14232
- 403: unknown;
15173
+ 403: ErrorResponse;
14233
15174
  /**
14234
- * Memory store not found
15175
+ * Not found
14235
15176
  */
14236
- 404: unknown;
15177
+ 404: ErrorResponse;
14237
15178
  };
14238
- type GetMemoryStoreTagsResponses = {
15179
+ type DeleteMetadataSchemaError = DeleteMetadataSchemaErrors[keyof DeleteMetadataSchemaErrors];
15180
+ type DeleteMetadataSchemaResponses = {
14239
15181
  /**
14240
- * Memory store tags
15182
+ * Deleted
14241
15183
  */
14242
- 200: TagBag;
15184
+ 204: void;
14243
15185
  };
14244
- type GetMemoryStoreTagsResponse = GetMemoryStoreTagsResponses[keyof GetMemoryStoreTagsResponses];
14245
- type MergeMemoryStoreTagsData = {
14246
- body: TagBag;
15186
+ type DeleteMetadataSchemaResponse = DeleteMetadataSchemaResponses[keyof DeleteMetadataSchemaResponses];
15187
+ type GetMetadataSchemaData = {
15188
+ body?: never;
14247
15189
  path: {
14248
- /**
14249
- * Memory store ID
14250
- */
14251
- memory_store_id: string;
15190
+ metadata_schema_id: string;
14252
15191
  };
14253
15192
  query?: never;
14254
- url: '/api/v1/memory-stores/{memory_store_id}/tags';
15193
+ url: '/api/v1/metadata-schemas/{metadata_schema_id}';
14255
15194
  };
14256
- type MergeMemoryStoreTagsErrors = {
14257
- /**
14258
- * Body is not an object of string values
14259
- */
14260
- 400: unknown;
15195
+ type GetMetadataSchemaErrors = {
14261
15196
  /**
14262
15197
  * Unauthorized
14263
15198
  */
14264
- 401: unknown;
15199
+ 401: ErrorResponse;
14265
15200
  /**
14266
15201
  * Forbidden
14267
15202
  */
14268
- 403: unknown;
15203
+ 403: ErrorResponse;
14269
15204
  /**
14270
- * Memory store not found
15205
+ * Not found
14271
15206
  */
14272
- 404: unknown;
15207
+ 404: ErrorResponse;
14273
15208
  };
14274
- type MergeMemoryStoreTagsResponses = {
15209
+ type GetMetadataSchemaError = GetMetadataSchemaErrors[keyof GetMetadataSchemaErrors];
15210
+ type GetMetadataSchemaResponses = {
14275
15211
  /**
14276
- * Tags merged
15212
+ * The declaration
14277
15213
  */
14278
- 200: TagBag;
15214
+ 200: MetadataSchemaRecord;
14279
15215
  };
14280
- type MergeMemoryStoreTagsResponse = MergeMemoryStoreTagsResponses[keyof MergeMemoryStoreTagsResponses];
14281
- type ReplaceMemoryStoreTagsData = {
14282
- body: TagBag;
14283
- path: {
15216
+ type GetMetadataSchemaResponse = GetMetadataSchemaResponses[keyof GetMetadataSchemaResponses];
15217
+ type UpdateMetadataSchemaData = {
15218
+ body: {
14284
15219
  /**
14285
- * Memory store ID
15220
+ * The declaration's new selector.
14286
15221
  */
14287
- memory_store_id: string;
15222
+ path_prefix?: string;
15223
+ /**
15224
+ * Replaces the declared JSON Schema.
15225
+ */
15226
+ schema?: {
15227
+ [key: string]: unknown;
15228
+ };
15229
+ };
15230
+ path: {
15231
+ metadata_schema_id: string;
14288
15232
  };
14289
15233
  query?: never;
14290
- url: '/api/v1/memory-stores/{memory_store_id}/tags';
15234
+ url: '/api/v1/metadata-schemas/{metadata_schema_id}';
14291
15235
  };
14292
- type ReplaceMemoryStoreTagsErrors = {
15236
+ type UpdateMetadataSchemaErrors = {
14293
15237
  /**
14294
- * Body is not an object of string values
15238
+ * Bad Request — an unusable selector, or a schema that is not valid JSON Schema
14295
15239
  */
14296
- 400: unknown;
15240
+ 400: ErrorResponse;
14297
15241
  /**
14298
15242
  * Unauthorized
14299
15243
  */
14300
- 401: unknown;
15244
+ 401: ErrorResponse;
14301
15245
  /**
14302
15246
  * Forbidden
14303
15247
  */
14304
- 403: unknown;
15248
+ 403: ErrorResponse;
14305
15249
  /**
14306
- * Memory store not found
15250
+ * Not found
14307
15251
  */
14308
- 404: unknown;
15252
+ 404: ErrorResponse;
15253
+ /**
15254
+ * Conflict — this selector is already declared for this type
15255
+ */
15256
+ 409: ErrorResponse;
14309
15257
  };
14310
- type ReplaceMemoryStoreTagsResponses = {
15258
+ type UpdateMetadataSchemaError = UpdateMetadataSchemaErrors[keyof UpdateMetadataSchemaErrors];
15259
+ type UpdateMetadataSchemaResponses = {
14311
15260
  /**
14312
- * Tags replaced
15261
+ * The declaration
14313
15262
  */
14314
- 200: TagBag;
15263
+ 200: MetadataSchemaRecord;
14315
15264
  };
14316
- type ReplaceMemoryStoreTagsResponse = ReplaceMemoryStoreTagsResponses[keyof ReplaceMemoryStoreTagsResponses];
15265
+ type UpdateMetadataSchemaResponse = UpdateMetadataSchemaResponses[keyof UpdateMetadataSchemaResponses];
14317
15266
  type ListModelRoutesData = {
14318
15267
  body?: never;
14319
15268
  path?: never;
@@ -14623,7 +15572,7 @@ type ValidateOrchestrationResponses = {
14623
15572
  /**
14624
15573
  * Validation result
14625
15574
  */
14626
- 200: ValidationResult;
15575
+ 200: OrchestrationValidationResult;
14627
15576
  };
14628
15577
  type ValidateOrchestrationResponse = ValidateOrchestrationResponses[keyof ValidateOrchestrationResponses];
14629
15578
  type GetQueueStatsData = {
@@ -14715,6 +15664,12 @@ type GetOrchestrationResponses = {
14715
15664
  type GetOrchestrationResponse = GetOrchestrationResponses[keyof GetOrchestrationResponses];
14716
15665
  type UpdateOrchestrationData = {
14717
15666
  body: UpdateOrchestrationRequest;
15667
+ headers?: {
15668
+ /**
15669
+ * The version the caller believes the resource holds, as an entity tag (`3` or `"3"`). Equivalent to `expected_version` in the request body; `*` states no precondition beyond the resource existing. A mismatch is `409 VERSION_CONFLICT`.
15670
+ */
15671
+ 'If-Match'?: string;
15672
+ };
14718
15673
  path: {
14719
15674
  /**
14720
15675
  * Public ID of the orchestration (orch_...)
@@ -15497,6 +16452,10 @@ type UpdateProjectData = {
15497
16452
  * Opt the project into read auditing. When true, `GET` requests that name this project are recorded in the audit log alongside mutations. Defaults to `false`.
15498
16453
  */
15499
16454
  audit_reads_enabled?: boolean;
16455
+ /**
16456
+ * Refuse a generation whose model carries no price row for every billable token component, with `409 MODEL_NOT_PRICED`. Defaults to `false`, where an unpriced model runs and meters at `cost_usd: null`. The check runs before the provider is called, so a refused turn spends nothing, and covers every target of a model route the turn may fail over to.
16457
+ */
16458
+ require_priced_model?: boolean;
15500
16459
  /**
15501
16460
  * What a conversation that names no `retrieval` of its own does. `none` by default: a turn is embedded because someone asked for the conversation to be retrievable, never merely because it was said. Turns are stored and chunked on both settings.
15502
16461
  */
@@ -18632,6 +19591,12 @@ type GetWorkflowResponses = {
18632
19591
  type GetWorkflowResponse = GetWorkflowResponses[keyof GetWorkflowResponses];
18633
19592
  type UpdateWorkflowData = {
18634
19593
  body: UpdateWorkflowRequest;
19594
+ headers?: {
19595
+ /**
19596
+ * The version the caller believes the resource holds, as an entity tag (`3` or `"3"`). Equivalent to `expected_version` in the request body; `*` states no precondition beyond the resource existing. A mismatch is `409 VERSION_CONFLICT`.
19597
+ */
19598
+ 'If-Match'?: string;
19599
+ };
18635
19600
  path: {
18636
19601
  workflow_id: string;
18637
19602
  };
@@ -18802,6 +19767,12 @@ export declare class Activity {
18802
19767
  * Returns activity entries for a project, newest first, filterable by kind, severity, agent, generation and orchestration run — every filter composable with the rest. Paginated with an opaque cursor rather than offset/limit — pass the previous page's `next_cursor` to fetch the next one; a `null` `next_cursor` means there is no more data.
18803
19768
  */
18804
19769
  static listActivity<ThrowOnError extends boolean = false>(options?: Options<ListActivityData, ThrowOnError>): RequestResult<ListActivityResponses, ListActivityErrors, ThrowOnError>;
19770
+ /**
19771
+ * Export the activity feed as NDJSON
19772
+ *
19773
+ * Streams a project's activity entries as newline-delimited JSON — one entry object per line, **oldest first**, where the feed itself reads newest first: a feed answers what just happened, and a file is read start to end. `project_id` is required: the export is per-project by design. Filters behave exactly as they do on the list endpoint.
19774
+ */
19775
+ static exportActivity<ThrowOnError extends boolean = false>(options: Options<ExportActivityData, ThrowOnError>): RequestResult<ExportActivityResponses, ExportActivityErrors, ThrowOnError>;
18805
19776
  }
18806
19777
  export declare class Actors {
18807
19778
  /**
@@ -19282,6 +20253,12 @@ export declare class Documents {
19282
20253
  *
19283
20254
  */
19284
20255
  static ingestDocument<ThrowOnError extends boolean = false>(options: Options<IngestDocumentData, ThrowOnError>): RequestResult<IngestDocumentResponses, IngestDocumentErrors, ThrowOnError>;
20256
+ /**
20257
+ * Export documents as NDJSON
20258
+ *
20259
+ * Streams a project's documents as newline-delimited JSON — one document object per line, oldest first — for archiving the corpus or shipping it into another system. `project_id` is required: the export is per-project by design. The rows are the rows the listing returns for the same caller, so a policy that hides a document hides it here too, and withdrawn documents and the reserved `/.system/` root are left out.
20260
+ */
20261
+ static exportDocuments<ThrowOnError extends boolean = false>(options: Options<ExportDocumentsData, ThrowOnError>): RequestResult<ExportDocumentsResponses, ExportDocumentsErrors, ThrowOnError>;
19285
20262
  /**
19286
20263
  * Delete a document
19287
20264
  *
@@ -19300,6 +20277,26 @@ export declare class Documents {
19300
20277
  * Updates document content, title, path, metadata, or tags. Supplying `path` moves the document to a new logical path within the project.
19301
20278
  */
19302
20279
  static updateDocument<ThrowOnError extends boolean = false>(options: Options<UpdateDocumentData, ThrowOnError>): RequestResult<UpdateDocumentResponses, UpdateDocumentErrors, ThrowOnError>;
20280
+ /**
20281
+ * List a document's relations
20282
+ *
20283
+ * Returns the typed edges this document asserts about others, oldest first. An edge is owned by the document it leaves, so this is what the document claims — use `?related_to=` on the listing to find what claims something about it.
20284
+ */
20285
+ static listDocumentRelations<ThrowOnError extends boolean = false>(options: Options<ListDocumentRelationsData, ThrowOnError>): RequestResult<ListDocumentRelationsResponses, ListDocumentRelationsErrors, ThrowOnError>;
20286
+ /**
20287
+ * Assert a relation
20288
+ *
20289
+ * Asserts a typed edge from this document to another in the same project. Asserting the same edge twice is `409`: an edge is a fact, and the second assertion is the same fact.
20290
+ *
20291
+ * Writing an edge is a write of the asserting document (`documents:UpdateDocument`); the document it points at is unchanged, which is what lets an agent record what its own report derives from without being able to make another report claim anything.
20292
+ */
20293
+ static createDocumentRelation<ThrowOnError extends boolean = false>(options: Options<CreateDocumentRelationData, ThrowOnError>): RequestResult<CreateDocumentRelationResponses, CreateDocumentRelationErrors, ThrowOnError>;
20294
+ /**
20295
+ * Retract a relation
20296
+ *
20297
+ * Removes an edge this document asserts. Both documents are left as they are — retracting a claim is not a change to what it was about.
20298
+ */
20299
+ static deleteDocumentRelation<ThrowOnError extends boolean = false>(options: Options<DeleteDocumentRelationData, ThrowOnError>): RequestResult<DeleteDocumentRelationResponses, DeleteDocumentRelationErrors, ThrowOnError>;
19303
20300
  /**
19304
20301
  * Get document ingestion status
19305
20302
  *
@@ -19312,6 +20309,42 @@ export declare class Documents {
19312
20309
  *
19313
20310
  */
19314
20311
  static getDocumentStatus<ThrowOnError extends boolean = false>(options: Options<GetDocumentStatusData, ThrowOnError>): RequestResult<GetDocumentStatusResponses, GetDocumentStatusErrors, ThrowOnError>;
20312
+ /**
20313
+ * Withdraw a document
20314
+ *
20315
+ * Takes a document out of every default read while keeping its history. The withdrawal is archived as a **tombstone version**, so one mechanism answers what a document holds now and there is no second lifecycle flag for a reader to miss.
20316
+ *
20317
+ * Its chunks are dropped from the knowledge index, so a withdrawn document costs a live search nothing. The content is not lost with them: it is in the version before the tombstone, which [`POST /api/v1/documents/{document_id}/versions/{version}/restore`](/docs/api/documents/restore-document-version) re-chunks from.
20318
+ *
20319
+ * `DELETE` stays what it is — permanent, and it removes the backing file. Withdrawal is the reversible act. It does not apply under `/.system/`: a platform-written document keeps the owning module's lifecycle.
20320
+ *
20321
+ */
20322
+ static withdrawDocument<ThrowOnError extends boolean = false>(options: Options<WithdrawDocumentData, ThrowOnError>): RequestResult<WithdrawDocumentResponses, WithdrawDocumentErrors, ThrowOnError>;
20323
+ /**
20324
+ * List a document's content versions
20325
+ *
20326
+ * Returns the document's archived states, newest first. A version is written on create and on every subsequent write that changes the content or its annotations, and a withdrawal is archived as a version carrying no content.
20327
+ *
20328
+ */
20329
+ static listDocumentVersions<ThrowOnError extends boolean = false>(options: Options<ListDocumentVersionsData, ThrowOnError>): RequestResult<ListDocumentVersionsResponses, ListDocumentVersionsErrors, ThrowOnError>;
20330
+ /**
20331
+ * Fetch an archived document version
20332
+ *
20333
+ * Returns the exact content and annotations the document held at a given version, which is what lets a run that cited a version read what it read.
20334
+ *
20335
+ */
20336
+ static getDocumentVersion<ThrowOnError extends boolean = false>(options: Options<GetDocumentVersionData, ThrowOnError>): RequestResult<GetDocumentVersionResponses, GetDocumentVersionErrors, ThrowOnError>;
20337
+ /**
20338
+ * Restore an archived document version
20339
+ *
20340
+ * Writes an archived version's content and annotations back as the document's live state, which archives them again as a **new** version rather than rewinding the counter — so a run citing any version in between still resolves.
20341
+ *
20342
+ * The restore runs through the ordinary update path, so the content is re-chunked and re-embedded; restoring the state the document already holds is a no-op and archives nothing. Restoring any content version of a withdrawn document brings it back into listings and search.
20343
+ *
20344
+ * A tombstone version has no content, so naming one is `400 VALIDATION_FAILED`: restore the version before it instead.
20345
+ *
20346
+ */
20347
+ static restoreDocumentVersion<ThrowOnError extends boolean = false>(options: Options<RestoreDocumentVersionData, ThrowOnError>): RequestResult<RestoreDocumentVersionResponses, RestoreDocumentVersionErrors, ThrowOnError>;
19315
20348
  /**
19316
20349
  * Re-ingest an existing document
19317
20350
  *
@@ -19880,6 +20913,17 @@ export declare class Memories {
19880
20913
  * Updates an existing memory. Regenerates the embedding if content changes.
19881
20914
  */
19882
20915
  static updateMemory<ThrowOnError extends boolean = false>(options: Options<UpdateMemoryData, ThrowOnError>): RequestResult<UpdateMemoryResponses, UpdateMemoryErrors, ThrowOnError>;
20916
+ /**
20917
+ * Retract a memory
20918
+ *
20919
+ * Retires a fact that stopped holding with nothing replacing it. The memory leaves the default listing, [knowledge search](/docs/api/knowledge/search-knowledge) and write deduplication, so restating the fact later lands as a new memory.
20920
+ *
20921
+ * It is an invalidation with no successor, which is what tells it apart from a supersede: `invalidated_at` is set and `superseded_by_memory_id` stays null. The retraction is appended to the assertion ledger with outcome `retracted`, so who withdrew the fact is part of the record.
20922
+ *
20923
+ * The memory stays readable by id, with its text and its assertions. `DELETE` remains the way to remove it outright.
20924
+ *
20925
+ */
20926
+ static retractMemory<ThrowOnError extends boolean = false>(options: Options<RetractMemoryData, ThrowOnError>): RequestResult<RetractMemoryResponses, RetractMemoryErrors, ThrowOnError>;
19883
20927
  /**
19884
20928
  * List a memory's assertions
19885
20929
  *
@@ -19974,6 +21018,12 @@ export declare class MemoryStores {
19974
21018
  * Returns the store's write ledger, newest first: one row per write attempt, skips included. This is how "which write path is filling this store?" is asked — a question no column on a memory row could answer, because a skipped write produced no memory at all.
19975
21019
  */
19976
21020
  static listMemoryStoreAssertions<ThrowOnError extends boolean = false>(options: Options<ListMemoryStoreAssertionsData, ThrowOnError>): RequestResult<ListMemoryStoreAssertionsResponses, ListMemoryStoreAssertionsErrors, ThrowOnError>;
21021
+ /**
21022
+ * Export a memory store's memories as NDJSON
21023
+ *
21024
+ * Streams one store's memories as newline-delimited JSON — one memory object per line, oldest first. Invalidated memories (retracted or superseded) are left out unless `include_invalidated` asks for them, so the file holds what the store currently asserts. The rows are the rows the listing returns for the same caller.
21025
+ */
21026
+ static exportMemories<ThrowOnError extends boolean = false>(options: Options<ExportMemoriesData, ThrowOnError>): RequestResult<ExportMemoriesResponses, ExportMemoriesErrors, ThrowOnError>;
19977
21027
  /**
19978
21028
  * Get memory store tags
19979
21029
  *
@@ -19993,6 +21043,48 @@ export declare class MemoryStores {
19993
21043
  */
19994
21044
  static replaceMemoryStoreTags<ThrowOnError extends boolean = false>(options: Options<ReplaceMemoryStoreTagsData, ThrowOnError>): RequestResult<ReplaceMemoryStoreTagsResponses, ReplaceMemoryStoreTagsErrors, ThrowOnError>;
19995
21045
  }
21046
+ export declare class MetadataSchemas {
21047
+ /**
21048
+ * List metadata schemas
21049
+ *
21050
+ * Returns the declarations in scope, oldest first. `resource_type` narrows them to one governed resource.
21051
+ */
21052
+ static listMetadataSchemas<ThrowOnError extends boolean = false>(options?: Options<ListMetadataSchemasData, ThrowOnError>): RequestResult<ListMetadataSchemasResponses, ListMetadataSchemasErrors, ThrowOnError>;
21053
+ /**
21054
+ * Declare a metadata schema
21055
+ *
21056
+ * Declares what `metadata` must satisfy for one resource type under one selector. A document is selected by `path_prefix`, matched on a path boundary: `/reports` covers `/reports/q1.txt` and never `/reports-archive/q1.txt`.
21057
+ *
21058
+ * The schema is compiled here, so one JSON Schema cannot parse is refused rather than stored — a stored one would be a rule that silently governs nothing. One selector has one schema per resource type; a second declaration of the same one is `409 NAME_CONFLICT`. The reserved root `/.system` cannot be governed: a platform-written document carries no caller metadata.
21059
+ *
21060
+ */
21061
+ static createMetadataSchema<ThrowOnError extends boolean = false>(options: Options<CreateMetadataSchemaData, ThrowOnError>): RequestResult<CreateMetadataSchemaResponses, CreateMetadataSchemaErrors, ThrowOnError>;
21062
+ /**
21063
+ * Check metadata against what is declared
21064
+ *
21065
+ * Answers what a write would be told, without writing: a caller preparing a batch learns which declaration would refuse it, and why, before it sends anything.
21066
+ *
21067
+ * It reports; it does not enforce. The refusal itself lives in each resource's own write path, because a check a writer has to call is advisory and the writer who skips it is the one the rule exists for.
21068
+ *
21069
+ */
21070
+ static validateMetadata<ThrowOnError extends boolean = false>(options: Options<ValidateMetadataData, ThrowOnError>): RequestResult<ValidateMetadataResponses, ValidateMetadataErrors, ThrowOnError>;
21071
+ /**
21072
+ * Delete a metadata schema
21073
+ *
21074
+ * Removes the declaration. Documents already stored keep the metadata they hold — the rule governed writes, not rows.
21075
+ */
21076
+ static deleteMetadataSchema<ThrowOnError extends boolean = false>(options: Options<DeleteMetadataSchemaData, ThrowOnError>): RequestResult<DeleteMetadataSchemaResponses, DeleteMetadataSchemaErrors, ThrowOnError>;
21077
+ /**
21078
+ * Get a metadata schema
21079
+ */
21080
+ static getMetadataSchema<ThrowOnError extends boolean = false>(options: Options<GetMetadataSchemaData, ThrowOnError>): RequestResult<GetMetadataSchemaResponses, GetMetadataSchemaErrors, ThrowOnError>;
21081
+ /**
21082
+ * Update a metadata schema
21083
+ *
21084
+ * Changes the schema, the selector, or both. `resource_type` is fixed at creation: it decides the selector's spelling and which write path reads the row, so changing it would silently repoint the declaration at a different door — delete it and declare again instead.
21085
+ */
21086
+ static updateMetadataSchema<ThrowOnError extends boolean = false>(options: Options<UpdateMetadataSchemaData, ThrowOnError>): RequestResult<UpdateMetadataSchemaResponses, UpdateMetadataSchemaErrors, ThrowOnError>;
21087
+ }
19996
21088
  export declare class ModelRoutes {
19997
21089
  /**
19998
21090
  * List model routes
@@ -20208,7 +21300,7 @@ export declare class Projects {
20208
21300
  /**
20209
21301
  * Update a project
20210
21302
  *
20211
- * Updates a project's name, its attached guardrails (`guardrail_ids` — the project-scope baseline governing every tool call by every agent in the project), its orchestration concurrency limit (`max_concurrent_runs`), its continuation-chain ceiling (`max_chain_generations`), its orchestration nesting bound (`max_orchestration_run_depth`), its inherited model route (`default_model_route_id`), its read-auditing opt-in (`audit_reads_enabled`), its trace-content retention window (`trace_content_retention_days`), and/or its zero-retention setting (`trace_content_mode`). At least one field is required. Requires admin role. Detaching a guardrail (removing an id) additionally requires guardrails:DetachGuardrail.
21303
+ * Updates a project's name, its attached guardrails (`guardrail_ids` — the project-scope baseline governing every tool call by every agent in the project), its orchestration concurrency limit (`max_concurrent_runs`), its continuation-chain ceiling (`max_chain_generations`), its orchestration nesting bound (`max_orchestration_run_depth`), its inherited model route (`default_model_route_id`), its read-auditing opt-in (`audit_reads_enabled`), its priced-model requirement (`require_priced_model`), its trace-content retention window (`trace_content_retention_days`), and/or its zero-retention setting (`trace_content_mode`). At least one field is required. Requires admin role. Detaching a guardrail (removing an id) additionally requires guardrails:DetachGuardrail.
20212
21304
  */
20213
21305
  static updateProject<ThrowOnError extends boolean = false>(options: Options<UpdateProjectData, ThrowOnError>): RequestResult<UpdateProjectResponses, UpdateProjectErrors, ThrowOnError>;
20214
21306
  /**
@@ -20884,6 +21976,7 @@ export declare class SoatClient {
20884
21976
  readonly memories: typeof Memories;
20885
21977
  readonly memoryRules: typeof MemoryRules;
20886
21978
  readonly memoryStores: typeof MemoryStores;
21979
+ readonly metadataSchemas: typeof MetadataSchemas;
20887
21980
  readonly modelRoutes: typeof ModelRoutes;
20888
21981
  readonly orchestrations: typeof Orchestrations;
20889
21982
  readonly policies: typeof Policies;
@@ -20902,4 +21995,4 @@ export declare class SoatClient {
20902
21995
  constructor({ baseUrl, token, headers }?: SoatClientOptions);
20903
21996
  }
20904
21997
  //#endregion
20905
- export type { AbortAgentReleaseData, AbortAgentReleaseError, AbortAgentReleaseErrors, AbortAgentReleaseResponse, AbortAgentReleaseResponses, AcceptedGenerationResponse, AcknowledgeExceptionData, AcknowledgeExceptionErrors, AcknowledgeExceptionResponse, AcknowledgeExceptionResponses, ActivityEntry, ActorRecord, ActorResourceProperties, AddConversationMessageData, AddConversationMessageError, AddConversationMessageErrors, AddConversationMessageResponse, AddConversationMessageResponses, AddSessionMessageData, AddSessionMessageError, AddSessionMessageErrors, AddSessionMessageRequest, AddSessionMessageResponse, AddSessionMessageResponse2, AddSessionMessageResponses, AddSessionMessageSaved, Agent, AgentBoundaryPolicy, AgentBoundaryPolicyStatement, AgentGenerationResponse, AgentRelease, AgentResourceProperties, AgentStepRule, AgentStopCondition, AgentVersion, AggregateScores, AiProviderResourceProperties, ApiKeyCreated, ApiKeyRecord, ApiKeyResourceProperties, ApprovalId, ApprovalItem, ApprovalRecurrenceGroup, ApproveApprovalData, ApproveApprovalErrors, ApproveApprovalResponse, ApproveApprovalResponses, AttachUserPoliciesData, AttachUserPoliciesError, AttachUserPoliciesErrors, AttachUserPoliciesResponse, AttachUserPoliciesResponses, AuditEntry, BaselineComparison, BootstrapUserData, BootstrapUserError, BootstrapUserErrors, BootstrapUserResponse, BootstrapUserResponses, CallToolData, CallToolError, CallToolErrors, CallToolRequest, CallToolResponses, CancelEvalRunData, CancelEvalRunErrors, CancelEvalRunResponse, CancelEvalRunResponses, CancelOrchestrationRunData, CancelOrchestrationRunErrors, CancelOrchestrationRunResponse, CancelOrchestrationRunResponses, Chain, ChainId, Chat, ChatCompletionChoice, ChatCompletionRequest, ChatCompletionResponse, ChatCompletionResponseMessage, ChatMessageInput, ChatResourceProperties, ClientOptions, CompleteIngestionCallbackData, CompleteIngestionCallbackError, CompleteIngestionCallbackErrors, CompleteIngestionCallbackResponse, CompleteIngestionCallbackResponses, ContainsScorer, ConversationMessageRecord, ConversationRecord, ConversationResourceProperties, CreateActorData, CreateActorError, CreateActorErrors, CreateActorResponse, CreateActorResponses, CreateAgentData, CreateAgentError, CreateAgentErrors, CreateAgentGenerationData, CreateAgentGenerationError, CreateAgentGenerationErrors, CreateAgentGenerationRequest, CreateAgentGenerationResponse, CreateAgentGenerationResponses, CreateAgentRequest, CreateAgentResponse, CreateAgentResponses, CreateAiProviderData, CreateAiProviderErrors, CreateAiProviderResponse, CreateAiProviderResponses, CreateApiKeyData, CreateApiKeyError, CreateApiKeyErrors, CreateApiKeyResponse, CreateApiKeyResponses, CreateChatCompletionData, CreateChatCompletionError, CreateChatCompletionErrors, CreateChatCompletionResponse, CreateChatCompletionResponses, CreateChatData, CreateChatError, CreateChatErrors, CreateChatRequest, CreateChatResponse, CreateChatResponses, CreateConversationData, CreateConversationError, CreateConversationErrors, CreateConversationResponse, CreateConversationResponses, CreateDatasetData, CreateDatasetErrors, CreateDatasetItemData, CreateDatasetItemErrors, CreateDatasetItemFromGenerationData, CreateDatasetItemFromGenerationErrors, CreateDatasetItemFromGenerationResponse, CreateDatasetItemFromGenerationResponses, CreateDatasetItemResponse, CreateDatasetItemResponses, CreateDatasetResponse, CreateDatasetResponses, CreateDocumentData, CreateDocumentError, CreateDocumentErrors, CreateDocumentResponse, CreateDocumentResponses, CreateEmbeddingsData, CreateEmbeddingsError, CreateEmbeddingsErrors, CreateEmbeddingsResponse, CreateEmbeddingsResponses, CreateEvalData, CreateEvalErrors, CreateEvalResponse, CreateEvalResponses, CreateFileData, CreateFileError, CreateFileErrors, CreateFileResponse, CreateFileResponses, CreateFormationData, CreateFormationErrors, CreateFormationResponse, CreateFormationResponses, CreateGuardrailData, CreateGuardrailError, CreateGuardrailErrors, CreateGuardrailRequest, CreateGuardrailResponse, CreateGuardrailResponses, CreateIngestionRuleData, CreateIngestionRuleErrors, CreateIngestionRuleResponse, CreateIngestionRuleResponses, CreateMemoryData, CreateMemoryErrors, CreateMemoryResponse, CreateMemoryResponses, CreateMemoryRuleData, CreateMemoryRuleErrors, CreateMemoryRuleResponse, CreateMemoryRuleResponses, CreateMemoryStoreData, CreateMemoryStoreErrors, CreateMemoryStoreResponse, CreateMemoryStoreResponses, CreateModelRouteData, CreateModelRouteErrors, CreateModelRouteResponse, CreateModelRouteResponses, CreateOrchestrationData, CreateOrchestrationErrors, CreateOrchestrationRequest, CreateOrchestrationResponse, CreateOrchestrationResponses, CreatePolicyData, CreatePolicyError, CreatePolicyErrors, CreatePolicyResponse, CreatePolicyResponses, CreatePresignedUrlData, CreatePresignedUrlError, CreatePresignedUrlErrors, CreatePresignedUrlResponse, CreatePresignedUrlResponses, CreateProjectData, CreateProjectErrors, CreateProjectResponse, CreateProjectResponses, CreateQuotaData, CreateQuotaErrors, CreateQuotaResponse, CreateQuotaResponses, CreateSecretData, CreateSecretErrors, CreateSecretResponse, CreateSecretResponses, CreateSessionData, CreateSessionError, CreateSessionErrors, CreateSessionRequest, CreateSessionResponse, CreateSessionResponses, CreateTaskData, CreateTaskErrors, CreateTaskRequest, CreateTaskResponse, CreateTaskResponses, CreateToolData, CreateToolError, CreateToolErrors, CreateToolRequest, CreateToolResponse, CreateToolResponses, CreateTriggerData, CreateTriggerErrors, CreateTriggerRequest, CreateTriggerResponse, CreateTriggerResponses, CreateUsageThresholdData, CreateUsageThresholdError, CreateUsageThresholdErrors, CreateUsageThresholdRequest, CreateUsageThresholdResponse, CreateUsageThresholdResponses, CreateUserData, CreateUserError, CreateUserErrors, CreateUserResponse, CreateUserResponses, CreateWebhookData, CreateWebhookErrors, CreateWebhookRequest, CreateWebhookResponse, CreateWebhookResponses, CreateWorkflowData, CreateWorkflowErrors, CreateWorkflowRequest, CreateWorkflowResponse, CreateWorkflowResponses, Dataset, DatasetItem, DatasetItemInput, DatasetItemResourceProperties, DatasetResourceProperties, DeleteActorData, DeleteActorError, DeleteActorErrors, DeleteActorResponse, DeleteActorResponses, DeleteAgentData, DeleteAgentError, DeleteAgentErrors, DeleteAgentResponse, DeleteAgentResponses, DeleteAiProviderData, DeleteAiProviderErrors, DeleteAiProviderResponse, DeleteAiProviderResponses, DeleteApiKeyData, DeleteApiKeyErrors, DeleteApiKeyResponse, DeleteApiKeyResponses, DeleteChatData, DeleteChatError, DeleteChatErrors, DeleteChatResponse, DeleteChatResponses, DeleteConversationData, DeleteConversationError, DeleteConversationErrors, DeleteConversationResponse, DeleteConversationResponses, DeleteDatasetData, DeleteDatasetErrors, DeleteDatasetItemData, DeleteDatasetItemErrors, DeleteDatasetItemResponse, DeleteDatasetItemResponses, DeleteDatasetResponse, DeleteDatasetResponses, DeleteDocumentData, DeleteDocumentError, DeleteDocumentErrors, DeleteDocumentResponse, DeleteDocumentResponses, DeleteEvalData, DeleteEvalErrors, DeleteEvalResponse, DeleteEvalResponses, DeleteFileData, DeleteFileError, DeleteFileErrors, DeleteFileResponse, DeleteFileResponses, DeleteFormationData, DeleteFormationErrors, DeleteFormationResponse, DeleteFormationResponses, DeleteGuardrailData, DeleteGuardrailError, DeleteGuardrailErrors, DeleteGuardrailResponse, DeleteGuardrailResponses, DeleteIngestionRuleData, DeleteIngestionRuleErrors, DeleteIngestionRuleResponse, DeleteIngestionRuleResponses, DeleteMemoryData, DeleteMemoryErrors, DeleteMemoryResponse, DeleteMemoryResponses, DeleteMemoryRuleData, DeleteMemoryRuleErrors, DeleteMemoryRuleResponse, DeleteMemoryRuleResponses, DeleteMemoryStoreData, DeleteMemoryStoreErrors, DeleteMemoryStoreResponse, DeleteMemoryStoreResponses, DeleteModelRouteData, DeleteModelRouteErrors, DeleteModelRouteResponse, DeleteModelRouteResponses, DeleteOrchestrationData, DeleteOrchestrationErrors, DeleteOrchestrationResponse, DeleteOrchestrationResponses, DeletePolicyData, DeletePolicyErrors, DeletePolicyResponse, DeletePolicyResponses, DeleteProjectData, DeleteProjectError, DeleteProjectErrors, DeleteProjectResponse, DeleteProjectResponses, DeleteQuotaData, DeleteQuotaErrors, DeleteQuotaResponse, DeleteQuotaResponses, DeleteSecretData, DeleteSecretErrors, DeleteSecretResponses, DeleteSessionData, DeleteSessionError, DeleteSessionErrors, DeleteSessionResponse, DeleteSessionResponses, DeleteTaskData, DeleteTaskErrors, DeleteTaskResponse, DeleteTaskResponses, DeleteToolData, DeleteToolError, DeleteToolErrors, DeleteToolResponse, DeleteToolResponses, DeleteTriggerData, DeleteTriggerErrors, DeleteTriggerResponse, DeleteTriggerResponses, DeleteUsageThresholdData, DeleteUsageThresholdError, DeleteUsageThresholdErrors, DeleteUsageThresholdResponse, DeleteUsageThresholdResponses, DeleteUserData, DeleteUserError, DeleteUserErrors, DeleteUserResponse, DeleteUserResponses, DeleteWebhookData, DeleteWebhookErrors, DeleteWebhookResponse, DeleteWebhookResponses, DeleteWorkflowData, DeleteWorkflowErrors, DeleteWorkflowResponse, DeleteWorkflowResponses, Delivery, DeliveryListResponse, DocumentKnowledgeResult, DocumentMessageContent, DocumentRecord, DocumentResourceProperties, DocumentStatusRecord, DownloadFileBase64Data, DownloadFileBase64Error, DownloadFileBase64Errors, DownloadFileBase64Response, DownloadFileBase64Responses, DownloadFileData, DownloadFileError, DownloadFileErrors, DownloadFileResponse, DownloadFileResponses, EmbeddingSimilarityScorer, EmbeddingsResponse, ErrorResponse, Eval, EvalResourceProperties, EvalResult, EvalRun, EvaluateGuardrailData, EvaluateGuardrailError, EvaluateGuardrailErrors, EvaluateGuardrailResponse, EvaluateGuardrailResponses, ExactMatchScorer, ExceptionId, ExceptionItem, ExportAuditEntriesData, ExportAuditEntriesErrors, ExportAuditEntriesResponse, ExportAuditEntriesResponses, FileRecord, FileRecordWritable, FileResourceProperties, FireTriggerData, FireTriggerErrors, FireTriggerRequest, FireTriggerResponse, FireTriggerResponses, ForkSessionData, ForkSessionError, ForkSessionErrors, ForkSessionRequest, ForkSessionResponse, ForkSessionResponses, Formation, FormationError, FormationEvent, FormationOperation, FormationResource, FormationTemplate, FormationTemplateInput, GenerateConversationMessageCompleted, GenerateConversationMessageData, GenerateConversationMessageError, GenerateConversationMessageErrors, GenerateConversationMessageRequiresAction, GenerateConversationMessageResponse, GenerateConversationMessageResponse2, GenerateConversationMessageResponses, GenerateSessionRequest, GenerateSessionResponse, GenerateSessionResponseData, GenerateSessionResponseError, GenerateSessionResponseErrors, GenerateSessionResponseResponse, GenerateSessionResponseResponses, Generation, GenerationTranscript, GetActorData, GetActorError, GetActorErrors, GetActorResponse, GetActorResponses, GetActorTagsData, GetActorTagsError, GetActorTagsErrors, GetActorTagsResponse, GetActorTagsResponses, GetAgentData, GetAgentError, GetAgentErrors, GetAgentResponse, GetAgentResponses, GetAgentVersionData, GetAgentVersionError, GetAgentVersionErrors, GetAgentVersionResponse, GetAgentVersionResponses, GetAiProviderData, GetAiProviderErrors, GetAiProviderPricesData, GetAiProviderPricesErrors, GetAiProviderPricesResponse, GetAiProviderPricesResponses, GetAiProviderResponse, GetAiProviderResponses, GetApiKeyData, GetApiKeyErrors, GetApiKeyResponse, GetApiKeyResponses, GetApprovalData, GetApprovalErrors, GetApprovalResponse, GetApprovalResponses, GetAuditEntryData, GetAuditEntryErrors, GetAuditEntryResponse, GetAuditEntryResponses, GetChainData, GetChainErrors, GetChainResponse, GetChainResponses, GetChatData, GetChatError, GetChatErrors, GetChatResponse, GetChatResponses, GetConversationData, GetConversationError, GetConversationErrors, GetConversationResponse, GetConversationResponses, GetConversationTagsData, GetConversationTagsError, GetConversationTagsErrors, GetConversationTagsResponse, GetConversationTagsResponses, GetCurrentUserData, GetCurrentUserError, GetCurrentUserErrors, GetCurrentUserResponse, GetCurrentUserResponses, GetDatasetData, GetDatasetErrors, GetDatasetResponse, GetDatasetResponses, GetDocumentData, GetDocumentError, GetDocumentErrors, GetDocumentResponse, GetDocumentResponses, GetDocumentStatusData, GetDocumentStatusError, GetDocumentStatusErrors, GetDocumentStatusResponse, GetDocumentStatusResponses, GetDocumentTagsData, GetDocumentTagsError, GetDocumentTagsErrors, GetDocumentTagsResponse, GetDocumentTagsResponses, GetEvalData, GetEvalErrors, GetEvalResponse, GetEvalResponses, GetEvalRunData, GetEvalRunErrors, GetEvalRunResponse, GetEvalRunResponses, GetExceptionData, GetExceptionErrors, GetExceptionResponse, GetExceptionResponses, GetFileData, GetFileError, GetFileErrors, GetFileResponse, GetFileResponses, GetFileTagsData, GetFileTagsError, GetFileTagsErrors, GetFileTagsResponse, GetFileTagsResponses, GetFormationData, GetFormationErrors, GetFormationResponse, GetFormationResponses, GetGenerationData, GetGenerationError, GetGenerationErrors, GetGenerationResponse, GetGenerationResponses, GetGenerationTranscriptData, GetGenerationTranscriptError, GetGenerationTranscriptErrors, GetGenerationTranscriptResponse, GetGenerationTranscriptResponses, GetGuardrailData, GetGuardrailError, GetGuardrailErrors, GetGuardrailResponse, GetGuardrailResponses, GetGuardrailVersionData, GetGuardrailVersionError, GetGuardrailVersionErrors, GetGuardrailVersionResponse, GetGuardrailVersionResponses, GetIngestionRuleData, GetIngestionRuleErrors, GetIngestionRuleResponse, GetIngestionRuleResponses, GetMemoryData, GetMemoryErrors, GetMemoryResponse, GetMemoryResponses, GetMemoryRuleData, GetMemoryRuleErrors, GetMemoryRuleResponse, GetMemoryRuleResponses, GetMemoryStoreData, GetMemoryStoreErrors, GetMemoryStoreResponse, GetMemoryStoreResponses, GetMemoryStoreTagsData, GetMemoryStoreTagsErrors, GetMemoryStoreTagsResponse, GetMemoryStoreTagsResponses, GetMemoryTagsData, GetMemoryTagsErrors, GetMemoryTagsResponse, GetMemoryTagsResponses, GetModelRouteData, GetModelRouteErrors, GetModelRouteResponse, GetModelRouteResponses, GetOrchestrationData, GetOrchestrationErrors, GetOrchestrationResponse, GetOrchestrationResponses, GetOrchestrationRunData, GetOrchestrationRunErrors, GetOrchestrationRunResponse, GetOrchestrationRunResponses, GetOrchestrationVersionData, GetOrchestrationVersionErrors, GetOrchestrationVersionResponse, GetOrchestrationVersionResponses, GetPolicyData, GetPolicyErrors, GetPolicyResponse, GetPolicyResponses, GetPriceBookData, GetPriceBookError, GetPriceBookErrors, GetPriceBookResponse, GetPriceBookResponses, GetProjectData, GetProjectErrors, GetProjectPricesData, GetProjectPricesErrors, GetProjectPricesResponse, GetProjectPricesResponses, GetProjectResponse, GetProjectResponses, GetQueueStatsData, GetQueueStatsErrors, GetQueueStatsResponse, GetQueueStatsResponses, GetQuotaData, GetQuotaErrors, GetQuotaResponse, GetQuotaResponses, GetSecretData, GetSecretErrors, GetSecretResponse, GetSecretResponses, GetSessionData, GetSessionError, GetSessionErrors, GetSessionResponse, GetSessionResponses, GetSessionTagsData, GetSessionTagsError, GetSessionTagsErrors, GetSessionTagsResponse, GetSessionTagsResponses, GetTaskData, GetTaskErrors, GetTaskHistoryData, GetTaskHistoryErrors, GetTaskHistoryResponse, GetTaskHistoryResponses, GetTaskResponse, GetTaskResponses, GetToolData, GetToolError, GetToolErrors, GetToolResponse, GetToolResponses, GetTraceData, GetTraceError, GetTraceErrors, GetTraceResponse, GetTraceResponses, GetTraceTreeData, GetTraceTreeError, GetTraceTreeErrors, GetTraceTreeResponse, GetTraceTreeResponses, GetTriggerData, GetTriggerErrors, GetTriggerFiringData, GetTriggerFiringErrors, GetTriggerFiringResponse, GetTriggerFiringResponses, GetTriggerResponse, GetTriggerResponses, GetTriggerSecretData, GetTriggerSecretErrors, GetTriggerSecretResponse, GetTriggerSecretResponses, GetUsageAggregateData, GetUsageAggregateError, GetUsageAggregateErrors, GetUsageAggregateResponse, GetUsageAggregateResponses, GetUsageReceiptData, GetUsageReceiptError, GetUsageReceiptErrors, GetUsageReceiptResponse, GetUsageReceiptResponses, GetUserData, GetUserError, GetUserErrors, GetUserResponse, GetUserResponses, GetWebhookData, GetWebhookDeliveryData, GetWebhookDeliveryErrors, GetWebhookDeliveryResponse, GetWebhookDeliveryResponses, GetWebhookErrors, GetWebhookResponse, GetWebhookResponses, GetWebhookSecretData, GetWebhookSecretErrors, GetWebhookSecretResponse, GetWebhookSecretResponses, GetWorkflowData, GetWorkflowErrors, GetWorkflowResponse, GetWorkflowResponses, GetWorkflowVersionData, GetWorkflowVersionErrors, GetWorkflowVersionResponse, GetWorkflowVersionResponses, Guardrail, GuardrailDocument, GuardrailEvaluation, GuardrailResourceProperties, GuardrailVersion, HumanInputRequest, IngestDocumentData, IngestDocumentError, IngestDocumentErrors, IngestDocumentResponse, IngestDocumentResponses, IngestedDocumentRecord, IngestionRule, IngestionRuleResourceProperties, JsonLogicScorer, KnowledgeResult, ListActivityData, ListActivityErrors, ListActivityResponse, ListActivityResponses, ListActorsData, ListActorsError, ListActorsErrors, ListActorsResponse, ListActorsResponses, ListAgentVersionsData, ListAgentVersionsError, ListAgentVersionsErrors, ListAgentVersionsResponse, ListAgentVersionsResponses, ListAgentsData, ListAgentsError, ListAgentsErrors, ListAgentsResponse, ListAgentsResponses, ListAiProviderModelsData, ListAiProviderModelsErrors, ListAiProviderModelsResponse, ListAiProviderModelsResponses, ListAiProvidersData, ListAiProvidersErrors, ListAiProvidersResponse, ListAiProvidersResponses, ListApiKeysData, ListApiKeysErrors, ListApiKeysResponse, ListApiKeysResponses, ListApprovalRecurrencesData, ListApprovalRecurrencesErrors, ListApprovalRecurrencesResponse, ListApprovalRecurrencesResponses, ListApprovalsData, ListApprovalsErrors, ListApprovalsResponse, ListApprovalsResponses, ListAuditEntriesData, ListAuditEntriesErrors, ListAuditEntriesResponse, ListAuditEntriesResponses, ListChainsData, ListChainsErrors, ListChainsResponse, ListChainsResponses, ListChatsData, ListChatsError, ListChatsErrors, ListChatsResponse, ListChatsResponses, ListConversationMessagesData, ListConversationMessagesError, ListConversationMessagesErrors, ListConversationMessagesResponse, ListConversationMessagesResponses, ListConversationsData, ListConversationsError, ListConversationsErrors, ListConversationsResponse, ListConversationsResponses, ListDatasetItemsData, ListDatasetItemsErrors, ListDatasetItemsResponse, ListDatasetItemsResponses, ListDatasetsData, ListDatasetsErrors, ListDatasetsResponse, ListDatasetsResponses, ListDocumentsData, ListDocumentsError, ListDocumentsErrors, ListDocumentsResponse, ListDocumentsResponses, ListEvalResultsData, ListEvalResultsErrors, ListEvalResultsResponse, ListEvalResultsResponses, ListEvalRunsData, ListEvalRunsErrors, ListEvalRunsResponse, ListEvalRunsResponses, ListEvalsData, ListEvalsErrors, ListEvalsResponse, ListEvalsResponses, ListExceptionsData, ListExceptionsErrors, ListExceptionsResponse, ListExceptionsResponses, ListFilesData, ListFilesError, ListFilesErrors, ListFilesResponse, ListFilesResponses, ListFormationEventsData, ListFormationEventsErrors, ListFormationEventsResponse, ListFormationEventsResponses, ListFormationsData, ListFormationsErrors, ListFormationsResponse, ListFormationsResponses, ListGenerationsData, ListGenerationsError, ListGenerationsErrors, ListGenerationsResponse, ListGenerationsResponses, ListGuardrailVersionsData, ListGuardrailVersionsError, ListGuardrailVersionsErrors, ListGuardrailVersionsResponse, ListGuardrailVersionsResponses, ListGuardrailsData, ListGuardrailsError, ListGuardrailsErrors, ListGuardrailsResponse, ListGuardrailsResponses, ListIngestionRulesData, ListIngestionRulesErrors, ListIngestionRulesResponse, ListIngestionRulesResponses, ListMemoriesData, ListMemoriesErrors, ListMemoriesResponse, ListMemoriesResponses, ListMemoryAssertionsData, ListMemoryAssertionsErrors, ListMemoryAssertionsResponse, ListMemoryAssertionsResponses, ListMemoryRulesData, ListMemoryRulesErrors, ListMemoryRulesResponse, ListMemoryRulesResponses, ListMemoryStoreAssertionsData, ListMemoryStoreAssertionsErrors, ListMemoryStoreAssertionsResponse, ListMemoryStoreAssertionsResponses, ListMemoryStoresData, ListMemoryStoresErrors, ListMemoryStoresResponse, ListMemoryStoresResponses, ListModelRoutesData, ListModelRoutesErrors, ListModelRoutesResponse, ListModelRoutesResponses, ListOrchestrationRunsData, ListOrchestrationRunsErrors, ListOrchestrationRunsResponse, ListOrchestrationRunsResponses, ListOrchestrationVersionsData, ListOrchestrationVersionsErrors, ListOrchestrationVersionsResponse, ListOrchestrationVersionsResponses, ListOrchestrationsData, ListOrchestrationsErrors, ListOrchestrationsResponse, ListOrchestrationsResponses, ListPoliciesData, ListPoliciesErrors, ListPoliciesResponse, ListPoliciesResponses, ListProjectsData, ListProjectsErrors, ListProjectsResponse, ListProjectsResponses, ListQuotasData, ListQuotasErrors, ListQuotasResponse, ListQuotasResponses, ListSecretsData, ListSecretsErrors, ListSecretsResponse, ListSecretsResponses, ListSessionForksData, ListSessionForksError, ListSessionForksErrors, ListSessionForksResponse, ListSessionForksResponses, ListSessionsData, ListSessionsError, ListSessionsErrors, ListSessionsResponse, ListSessionsResponses, ListTasksData, ListTasksErrors, ListTasksResponse, ListTasksResponses, ListToolsData, ListToolsError, ListToolsErrors, ListToolsResponse, ListToolsResponses, ListTracesData, ListTracesError, ListTracesErrors, ListTracesResponse, ListTracesResponses, ListTriggerFiringsData, ListTriggerFiringsErrors, ListTriggerFiringsResponse, ListTriggerFiringsResponses, ListTriggersData, ListTriggersErrors, ListTriggersResponse, ListTriggersResponses, ListUsageEventsData, ListUsageEventsError, ListUsageEventsErrors, ListUsageEventsResponse, ListUsageEventsResponses, ListUsageThresholdsData, ListUsageThresholdsError, ListUsageThresholdsErrors, ListUsageThresholdsResponse, ListUsageThresholdsResponses, ListUsersData, ListUsersError, ListUsersErrors, ListUsersResponse, ListUsersResponses, ListWebhookDeliveriesData, ListWebhookDeliveriesErrors, ListWebhookDeliveriesResponse, ListWebhookDeliveriesResponses, ListWebhooksData, ListWebhooksErrors, ListWebhooksResponse, ListWebhooksResponses, ListWorkflowVersionsData, ListWorkflowVersionsErrors, ListWorkflowVersionsResponse, ListWorkflowVersionsResponses, ListWorkflowsData, ListWorkflowsErrors, ListWorkflowsResponse, ListWorkflowsResponses, LlmJudgeScorer, LoginResponse, LoginUserData, LoginUserError, LoginUserErrors, LoginUserResponse, LoginUserResponses, Memory, MemoryAssertion, MemoryKnowledgeResult, MemoryResourceProperties, MemoryRule, MemoryRuleEvent, MemoryRuleResourceProperties, MemoryStore, MemoryStoreResourceProperties, MemoryWriteResult, MergeActorTagsData, MergeActorTagsError, MergeActorTagsErrors, MergeActorTagsResponse, MergeActorTagsResponses, MergeConversationTagsData, MergeConversationTagsError, MergeConversationTagsErrors, MergeConversationTagsResponse, MergeConversationTagsResponses, MergeDocumentTagsData, MergeDocumentTagsError, MergeDocumentTagsErrors, MergeDocumentTagsResponse, MergeDocumentTagsResponses, MergeFileTagsData, MergeFileTagsError, MergeFileTagsErrors, MergeFileTagsResponse, MergeFileTagsResponses, MergeMemoryStoreTagsData, MergeMemoryStoreTagsErrors, MergeMemoryStoreTagsResponse, MergeMemoryStoreTagsResponses, MergeMemoryTagsData, MergeMemoryTagsErrors, MergeMemoryTagsResponse, MergeMemoryTagsResponses, MergeSessionTagsData, MergeSessionTagsError, MergeSessionTagsErrors, MergeSessionTagsResponse, MergeSessionTagsResponses, ModelRoute, ModelRouteResourceProperties, ModelRouteTarget, NodeExecution, NullableTagBag, OauthAuthorizationServerMetadata, OauthClientRegistrationRequest, OauthClientRegistrationResponse, OauthErrorResponse, OauthProtectedResourceMetadata, OauthTokenRequest, OauthTokenResponse, Options, Orchestration, OrchestrationEdge, OrchestrationId, OrchestrationNode, OrchestrationResourceProperties, OrchestrationRun, OrchestrationRunId, OrchestrationVersion, OutputSchemaScorer, ParameterDeclaration, PatchAgentData, PatchAgentError, PatchAgentErrors, PatchAgentResponse, PatchAgentResponses, PauseOrchestrationRunData, PauseOrchestrationRunErrors, PauseOrchestrationRunRequest, PauseOrchestrationRunResponse, PauseOrchestrationRunResponses, PauseTaskData, PauseTaskErrors, PauseTaskRequest, PauseTaskResponse, PauseTaskResponses, PlanChange, PlanFormationData, PlanFormationErrors, PlanFormationResponse, PlanFormationResponses, PlanResult, PolicyDocument, PolicyRecord, PolicyResourceProperties, PolicyStatement, PresignedUrlRequest, PresignedUrlResponse, Price, PriceBookResponse, ProjectPrice, ProjectPriceResourceProperties, ProjectPricesResponse, ProjectRecord, PromoteAgentReleaseData, PromoteAgentReleaseError, PromoteAgentReleaseErrors, PromoteAgentReleaseResponse, PromoteAgentReleaseResponses, ProviderModelsResponse, ProviderPrice, ProviderPricesResponse, PurgeGenerationContentData, PurgeGenerationContentError, PurgeGenerationContentErrors, PurgeGenerationContentResponse, PurgeGenerationContentResponses, PurgeTraceContentData, PurgeTraceContentError, PurgeTraceContentErrors, PurgeTraceContentResponse, PurgeTraceContentResponses, QueueStats, Quota, QuotaResourceProperties, RedeliverWebhookDeliveryData, RedeliverWebhookDeliveryErrors, RedeliverWebhookDeliveryResponse, RedeliverWebhookDeliveryResponses, ReingestDocumentData, ReingestDocumentError, ReingestDocumentErrors, ReingestDocumentResponse, ReingestDocumentResponses, RejectApprovalData, RejectApprovalErrors, RejectApprovalResponse, RejectApprovalResponses, RemoveConversationMessageData, RemoveConversationMessageError, RemoveConversationMessageErrors, RemoveConversationMessageResponse, RemoveConversationMessageResponses, ReplaceActorTagsData, ReplaceActorTagsError, ReplaceActorTagsErrors, ReplaceActorTagsResponse, ReplaceActorTagsResponses, ReplaceConversationTagsData, ReplaceConversationTagsError, ReplaceConversationTagsErrors, ReplaceConversationTagsResponse, ReplaceConversationTagsResponses, ReplaceDocumentTagsData, ReplaceDocumentTagsError, ReplaceDocumentTagsErrors, ReplaceDocumentTagsResponse, ReplaceDocumentTagsResponses, ReplaceFileTagsData, ReplaceFileTagsError, ReplaceFileTagsErrors, ReplaceFileTagsResponse, ReplaceFileTagsResponses, ReplaceMemoryStoreTagsData, ReplaceMemoryStoreTagsErrors, ReplaceMemoryStoreTagsResponse, ReplaceMemoryStoreTagsResponses, ReplaceMemoryTagsData, ReplaceMemoryTagsErrors, ReplaceMemoryTagsResponse, ReplaceMemoryTagsResponses, ReplaceSessionTagsData, ReplaceSessionTagsError, ReplaceSessionTagsErrors, ReplaceSessionTagsResponse, ReplaceSessionTagsResponses, RequiredAction, ResolveExceptionData, ResolveExceptionErrors, ResolveExceptionResponse, ResolveExceptionResponses, ResourceDeclaration, RestoreAgentVersionData, RestoreAgentVersionError, RestoreAgentVersionErrors, RestoreAgentVersionRequest, RestoreAgentVersionResponse, RestoreAgentVersionResponses, RestoreGuardrailVersionData, RestoreGuardrailVersionError, RestoreGuardrailVersionErrors, RestoreGuardrailVersionRequest, RestoreGuardrailVersionResponse, RestoreGuardrailVersionResponses, RestoreOrchestrationVersionData, RestoreOrchestrationVersionErrors, RestoreOrchestrationVersionRequest, RestoreOrchestrationVersionResponse, RestoreOrchestrationVersionResponses, RestoreWorkflowVersionData, RestoreWorkflowVersionErrors, RestoreWorkflowVersionRequest, RestoreWorkflowVersionResponse, RestoreWorkflowVersionResponses, ResumeOrchestrationRunData, ResumeOrchestrationRunErrors, ResumeOrchestrationRunResponse, ResumeOrchestrationRunResponses, ResumeTaskData, ResumeTaskErrors, ResumeTaskResponse, ResumeTaskResponses, RotateTriggerSecretData, RotateTriggerSecretErrors, RotateTriggerSecretResponse, RotateTriggerSecretResponses, RotateWebhookSecretData, RotateWebhookSecretErrors, RotateWebhookSecretResponse, RotateWebhookSecretResponses, ScorerResult, Scorers, SearchKnowledgeData, SearchKnowledgeError, SearchKnowledgeErrors, SearchKnowledgeResponse, SearchKnowledgeResponses, SecretResourceProperties, SendSessionMessageResponse, SessionId, SessionRecord, SessionResourceProperties, SetAgentReleaseData, SetAgentReleaseError, SetAgentReleaseErrors, SetAgentReleaseRequest, SetAgentReleaseResponse, SetAgentReleaseResponses, SoatClientOptions, StartEvalRunData, StartEvalRunErrors, StartEvalRunResponse, StartEvalRunResponses, StartOrchestrationRunData, StartOrchestrationRunErrors, StartOrchestrationRunRequest, StartOrchestrationRunResponse, StartOrchestrationRunResponses, SubmitAgentToolOutputsData, SubmitAgentToolOutputsError, SubmitAgentToolOutputsErrors, SubmitAgentToolOutputsResponse, SubmitAgentToolOutputsResponses, SubmitHumanInputData, SubmitHumanInputErrors, SubmitHumanInputResponse, SubmitHumanInputResponses, SubmitSessionToolOutputsData, SubmitSessionToolOutputsError, SubmitSessionToolOutputsErrors, SubmitSessionToolOutputsRequest, SubmitSessionToolOutputsResponse, SubmitSessionToolOutputsResponses, SubmitToolOutputsRequest, TagBag, TagsQuery, Task, TaskTransition, Tool, ToolBinding, ToolExecuteAuthConfig, ToolExecuteConfig, ToolMcpConfig, ToolOutputMessageContent, ToolResourceProperties, ToolScorer, Trace, TraceTreeNode, TranscriptStep, TranscriptToolCall, TranscriptToolResult, TransitionTaskData, TransitionTaskErrors, TransitionTaskRequest, TransitionTaskResponse, TransitionTaskResponses, Trigger, TriggerFiring, TriggerFiringListResponse, TriggerResourceProperties, TriggerSecretResponse, TriggerWithSecret, UnauthorizedFormationAction, UpdateActorData, UpdateActorError, UpdateActorErrors, UpdateActorResponse, UpdateActorResponses, UpdateAgentData, UpdateAgentError, UpdateAgentErrors, UpdateAgentRequest, UpdateAgentResponse, UpdateAgentResponses, UpdateAiProviderData, UpdateAiProviderErrors, UpdateAiProviderPricesData, UpdateAiProviderPricesErrors, UpdateAiProviderPricesResponse, UpdateAiProviderPricesResponses, UpdateAiProviderResponses, UpdateApiKeyData, UpdateApiKeyError, UpdateApiKeyErrors, UpdateApiKeyResponse, UpdateApiKeyResponses, UpdateConversationData, UpdateConversationError, UpdateConversationErrors, UpdateConversationResponse, UpdateConversationResponses, UpdateDatasetData, UpdateDatasetErrors, UpdateDatasetItemData, UpdateDatasetItemErrors, UpdateDatasetItemResponse, UpdateDatasetItemResponses, UpdateDatasetResponse, UpdateDatasetResponses, UpdateDocumentData, UpdateDocumentError, UpdateDocumentErrors, UpdateDocumentResponse, UpdateDocumentResponses, UpdateEvalData, UpdateEvalErrors, UpdateEvalResponse, UpdateEvalResponses, UpdateFileMetadataData, UpdateFileMetadataError, UpdateFileMetadataErrors, UpdateFileMetadataResponse, UpdateFileMetadataResponses, UpdateFormationData, UpdateFormationErrors, UpdateFormationResponse, UpdateFormationResponses, UpdateGenerationData, UpdateGenerationError, UpdateGenerationErrors, UpdateGenerationRequest, UpdateGenerationResponse, UpdateGenerationResponses, UpdateGuardrailData, UpdateGuardrailError, UpdateGuardrailErrors, UpdateGuardrailRequest, UpdateGuardrailResponse, UpdateGuardrailResponses, UpdateIngestionRuleData, UpdateIngestionRuleErrors, UpdateIngestionRuleResponse, UpdateIngestionRuleResponses, UpdateMemoryData, UpdateMemoryErrors, UpdateMemoryResponse, UpdateMemoryResponses, UpdateMemoryRuleData, UpdateMemoryRuleErrors, UpdateMemoryRuleResponse, UpdateMemoryRuleResponses, UpdateMemoryStoreData, UpdateMemoryStoreErrors, UpdateMemoryStoreResponse, UpdateMemoryStoreResponses, UpdateModelRouteData, UpdateModelRouteErrors, UpdateModelRouteResponse, UpdateModelRouteResponses, UpdateOrchestrationData, UpdateOrchestrationErrors, UpdateOrchestrationRequest, UpdateOrchestrationResponse, UpdateOrchestrationResponses, UpdatePolicyData, UpdatePolicyError, UpdatePolicyErrors, UpdatePolicyResponse, UpdatePolicyResponses, UpdateProjectData, UpdateProjectErrors, UpdateProjectPricesData, UpdateProjectPricesErrors, UpdateProjectPricesResponse, UpdateProjectPricesResponses, UpdateProjectResponse, UpdateProjectResponses, UpdateQuotaData, UpdateQuotaErrors, UpdateQuotaResponse, UpdateQuotaResponses, UpdateSecretData, UpdateSecretErrors, UpdateSecretResponses, UpdateSessionData, UpdateSessionError, UpdateSessionErrors, UpdateSessionRequest, UpdateSessionResponse, UpdateSessionResponses, UpdateTaskData, UpdateTaskErrors, UpdateTaskRequest, UpdateTaskResponse, UpdateTaskResponses, UpdateToolData, UpdateToolError, UpdateToolErrors, UpdateToolRequest, UpdateToolResponse, UpdateToolResponses, UpdateTriggerData, UpdateTriggerErrors, UpdateTriggerRequest, UpdateTriggerResponse, UpdateTriggerResponses, UpdateWebhookData, UpdateWebhookErrors, UpdateWebhookRequest, UpdateWebhookResponse, UpdateWebhookResponses, UpdateWorkflowData, UpdateWorkflowErrors, UpdateWorkflowRequest, UpdateWorkflowResponse, UpdateWorkflowResponses, UploadFileBase64Data, UploadFileBase64Error, UploadFileBase64Errors, UploadFileBase64Request, UploadFileBase64Response, UploadFileBase64Responses, UploadFileData, UploadFileError, UploadFileErrors, UploadFileResponse, UploadFileResponses, UploadFileWithTokenData, UploadFileWithTokenError, UploadFileWithTokenErrors, UploadFileWithTokenRequest, UploadFileWithTokenResponse, UploadFileWithTokenResponses, UpsertPriceBookData, UpsertPriceBookError, UpsertPriceBookErrors, UpsertPriceBookResponse, UpsertPriceBookResponses, UpsertPricesRequest, UpsertProjectPricesRequest, UpsertProviderPricesRequest, UsageAggregate, UsageAggregateBucket, UsageAggregateComponent, UsageAggregateFilters, UsageAggregateGroup, UsageAggregateTotals, UsageComponent, UsageDistinct, UsageEvent, UsageGroupBy, UsageReceipt, UsageThreshold, UsageTotals, UserRecord, ValidateFormationData, ValidateFormationErrors, ValidateFormationResponse, ValidateFormationResponses, ValidateOrchestrationData, ValidateOrchestrationErrors, ValidateOrchestrationRequest, ValidateOrchestrationResponse, ValidateOrchestrationResponses, ValidationError, ValidationResult, Webhook, WebhookResourceProperties, WebhookSecretResponse, WebhookWithSecret, Workflow, WorkflowResourceProperties, WorkflowState, WorkflowTransition, WorkflowVersion };
21998
+ export type { AbortAgentReleaseData, AbortAgentReleaseError, AbortAgentReleaseErrors, AbortAgentReleaseResponse, AbortAgentReleaseResponses, AcceptedGenerationResponse, AcknowledgeExceptionData, AcknowledgeExceptionErrors, AcknowledgeExceptionResponse, AcknowledgeExceptionResponses, ActivityEntry, ActorRecord, ActorResourceProperties, AddConversationMessageData, AddConversationMessageError, AddConversationMessageErrors, AddConversationMessageResponse, AddConversationMessageResponses, AddSessionMessageData, AddSessionMessageError, AddSessionMessageErrors, AddSessionMessageRequest, AddSessionMessageResponse, AddSessionMessageResponse2, AddSessionMessageResponses, AddSessionMessageSaved, Agent, AgentBoundaryPolicy, AgentBoundaryPolicyStatement, AgentGenerationResponse, AgentRelease, AgentResourceProperties, AgentStepRule, AgentStopCondition, AgentVersion, AggregateScores, AiProviderResourceProperties, ApiKeyCreated, ApiKeyRecord, ApiKeyResourceProperties, ApprovalId, ApprovalItem, ApprovalRecurrenceGroup, ApproveApprovalData, ApproveApprovalErrors, ApproveApprovalResponse, ApproveApprovalResponses, AttachUserPoliciesData, AttachUserPoliciesError, AttachUserPoliciesErrors, AttachUserPoliciesResponse, AttachUserPoliciesResponses, AuditEntry, BaselineComparison, BootstrapUserData, BootstrapUserError, BootstrapUserErrors, BootstrapUserResponse, BootstrapUserResponses, CallToolData, CallToolError, CallToolErrors, CallToolRequest, CallToolResponses, CancelEvalRunData, CancelEvalRunErrors, CancelEvalRunResponse, CancelEvalRunResponses, CancelOrchestrationRunData, CancelOrchestrationRunErrors, CancelOrchestrationRunResponse, CancelOrchestrationRunResponses, Chain, ChainId, Chat, ChatCompletionChoice, ChatCompletionRequest, ChatCompletionResponse, ChatCompletionResponseMessage, ChatMessageInput, ChatResourceProperties, ClientOptions, CompleteIngestionCallbackData, CompleteIngestionCallbackError, CompleteIngestionCallbackErrors, CompleteIngestionCallbackResponse, CompleteIngestionCallbackResponses, ContainsScorer, ConversationMessageRecord, ConversationRecord, ConversationResourceProperties, CreateActorData, CreateActorError, CreateActorErrors, CreateActorResponse, CreateActorResponses, CreateAgentData, CreateAgentError, CreateAgentErrors, CreateAgentGenerationData, CreateAgentGenerationError, CreateAgentGenerationErrors, CreateAgentGenerationRequest, CreateAgentGenerationResponse, CreateAgentGenerationResponses, CreateAgentRequest, CreateAgentResponse, CreateAgentResponses, CreateAiProviderData, CreateAiProviderErrors, CreateAiProviderResponse, CreateAiProviderResponses, CreateApiKeyData, CreateApiKeyError, CreateApiKeyErrors, CreateApiKeyResponse, CreateApiKeyResponses, CreateChatCompletionData, CreateChatCompletionError, CreateChatCompletionErrors, CreateChatCompletionResponse, CreateChatCompletionResponses, CreateChatData, CreateChatError, CreateChatErrors, CreateChatRequest, CreateChatResponse, CreateChatResponses, CreateConversationData, CreateConversationError, CreateConversationErrors, CreateConversationResponse, CreateConversationResponses, CreateDatasetData, CreateDatasetErrors, CreateDatasetItemData, CreateDatasetItemErrors, CreateDatasetItemFromGenerationData, CreateDatasetItemFromGenerationErrors, CreateDatasetItemFromGenerationResponse, CreateDatasetItemFromGenerationResponses, CreateDatasetItemResponse, CreateDatasetItemResponses, CreateDatasetResponse, CreateDatasetResponses, CreateDocumentData, CreateDocumentError, CreateDocumentErrors, CreateDocumentRelationData, CreateDocumentRelationErrors, CreateDocumentRelationResponse, CreateDocumentRelationResponses, CreateDocumentResponse, CreateDocumentResponses, CreateEmbeddingsData, CreateEmbeddingsError, CreateEmbeddingsErrors, CreateEmbeddingsResponse, CreateEmbeddingsResponses, CreateEvalData, CreateEvalErrors, CreateEvalResponse, CreateEvalResponses, CreateFileData, CreateFileError, CreateFileErrors, CreateFileResponse, CreateFileResponses, CreateFormationData, CreateFormationErrors, CreateFormationResponse, CreateFormationResponses, CreateGuardrailData, CreateGuardrailError, CreateGuardrailErrors, CreateGuardrailRequest, CreateGuardrailResponse, CreateGuardrailResponses, CreateIngestionRuleData, CreateIngestionRuleErrors, CreateIngestionRuleResponse, CreateIngestionRuleResponses, CreateMemoryData, CreateMemoryErrors, CreateMemoryResponse, CreateMemoryResponses, CreateMemoryRuleData, CreateMemoryRuleErrors, CreateMemoryRuleResponse, CreateMemoryRuleResponses, CreateMemoryStoreData, CreateMemoryStoreErrors, CreateMemoryStoreResponse, CreateMemoryStoreResponses, CreateMetadataSchemaData, CreateMetadataSchemaError, CreateMetadataSchemaErrors, CreateMetadataSchemaResponse, CreateMetadataSchemaResponses, CreateModelRouteData, CreateModelRouteErrors, CreateModelRouteResponse, CreateModelRouteResponses, CreateOrchestrationData, CreateOrchestrationErrors, CreateOrchestrationRequest, CreateOrchestrationResponse, CreateOrchestrationResponses, CreatePolicyData, CreatePolicyError, CreatePolicyErrors, CreatePolicyResponse, CreatePolicyResponses, CreatePresignedUrlData, CreatePresignedUrlError, CreatePresignedUrlErrors, CreatePresignedUrlResponse, CreatePresignedUrlResponses, CreateProjectData, CreateProjectErrors, CreateProjectResponse, CreateProjectResponses, CreateQuotaData, CreateQuotaErrors, CreateQuotaResponse, CreateQuotaResponses, CreateSecretData, CreateSecretErrors, CreateSecretResponse, CreateSecretResponses, CreateSessionData, CreateSessionError, CreateSessionErrors, CreateSessionRequest, CreateSessionResponse, CreateSessionResponses, CreateTaskData, CreateTaskErrors, CreateTaskRequest, CreateTaskResponse, CreateTaskResponses, CreateToolData, CreateToolError, CreateToolErrors, CreateToolRequest, CreateToolResponse, CreateToolResponses, CreateTriggerData, CreateTriggerErrors, CreateTriggerRequest, CreateTriggerResponse, CreateTriggerResponses, CreateUsageThresholdData, CreateUsageThresholdError, CreateUsageThresholdErrors, CreateUsageThresholdRequest, CreateUsageThresholdResponse, CreateUsageThresholdResponses, CreateUserData, CreateUserError, CreateUserErrors, CreateUserResponse, CreateUserResponses, CreateWebhookData, CreateWebhookErrors, CreateWebhookRequest, CreateWebhookResponse, CreateWebhookResponses, CreateWorkflowData, CreateWorkflowErrors, CreateWorkflowRequest, CreateWorkflowResponse, CreateWorkflowResponses, Dataset, DatasetItem, DatasetItemInput, DatasetItemResourceProperties, DatasetResourceProperties, DeleteActorData, DeleteActorError, DeleteActorErrors, DeleteActorResponse, DeleteActorResponses, DeleteAgentData, DeleteAgentError, DeleteAgentErrors, DeleteAgentResponse, DeleteAgentResponses, DeleteAiProviderData, DeleteAiProviderErrors, DeleteAiProviderResponse, DeleteAiProviderResponses, DeleteApiKeyData, DeleteApiKeyErrors, DeleteApiKeyResponse, DeleteApiKeyResponses, DeleteChatData, DeleteChatError, DeleteChatErrors, DeleteChatResponse, DeleteChatResponses, DeleteConversationData, DeleteConversationError, DeleteConversationErrors, DeleteConversationResponse, DeleteConversationResponses, DeleteDatasetData, DeleteDatasetErrors, DeleteDatasetItemData, DeleteDatasetItemErrors, DeleteDatasetItemResponse, DeleteDatasetItemResponses, DeleteDatasetResponse, DeleteDatasetResponses, DeleteDocumentData, DeleteDocumentError, DeleteDocumentErrors, DeleteDocumentRelationData, DeleteDocumentRelationErrors, DeleteDocumentRelationResponse, DeleteDocumentRelationResponses, DeleteDocumentResponse, DeleteDocumentResponses, DeleteEvalData, DeleteEvalErrors, DeleteEvalResponse, DeleteEvalResponses, DeleteFileData, DeleteFileError, DeleteFileErrors, DeleteFileResponse, DeleteFileResponses, DeleteFormationData, DeleteFormationErrors, DeleteFormationResponse, DeleteFormationResponses, DeleteGuardrailData, DeleteGuardrailError, DeleteGuardrailErrors, DeleteGuardrailResponse, DeleteGuardrailResponses, DeleteIngestionRuleData, DeleteIngestionRuleErrors, DeleteIngestionRuleResponse, DeleteIngestionRuleResponses, DeleteMemoryData, DeleteMemoryErrors, DeleteMemoryResponse, DeleteMemoryResponses, DeleteMemoryRuleData, DeleteMemoryRuleErrors, DeleteMemoryRuleResponse, DeleteMemoryRuleResponses, DeleteMemoryStoreData, DeleteMemoryStoreErrors, DeleteMemoryStoreResponse, DeleteMemoryStoreResponses, DeleteMetadataSchemaData, DeleteMetadataSchemaError, DeleteMetadataSchemaErrors, DeleteMetadataSchemaResponse, DeleteMetadataSchemaResponses, DeleteModelRouteData, DeleteModelRouteErrors, DeleteModelRouteResponse, DeleteModelRouteResponses, DeleteOrchestrationData, DeleteOrchestrationErrors, DeleteOrchestrationResponse, DeleteOrchestrationResponses, DeletePolicyData, DeletePolicyErrors, DeletePolicyResponse, DeletePolicyResponses, DeleteProjectData, DeleteProjectError, DeleteProjectErrors, DeleteProjectResponse, DeleteProjectResponses, DeleteQuotaData, DeleteQuotaErrors, DeleteQuotaResponse, DeleteQuotaResponses, DeleteSecretData, DeleteSecretErrors, DeleteSecretResponses, DeleteSessionData, DeleteSessionError, DeleteSessionErrors, DeleteSessionResponse, DeleteSessionResponses, DeleteTaskData, DeleteTaskErrors, DeleteTaskResponse, DeleteTaskResponses, DeleteToolData, DeleteToolError, DeleteToolErrors, DeleteToolResponse, DeleteToolResponses, DeleteTriggerData, DeleteTriggerErrors, DeleteTriggerResponse, DeleteTriggerResponses, DeleteUsageThresholdData, DeleteUsageThresholdError, DeleteUsageThresholdErrors, DeleteUsageThresholdResponse, DeleteUsageThresholdResponses, DeleteUserData, DeleteUserError, DeleteUserErrors, DeleteUserResponse, DeleteUserResponses, DeleteWebhookData, DeleteWebhookErrors, DeleteWebhookResponse, DeleteWebhookResponses, DeleteWorkflowData, DeleteWorkflowErrors, DeleteWorkflowResponse, DeleteWorkflowResponses, Delivery, DeliveryListResponse, DocumentKnowledgeResult, DocumentMessageContent, DocumentRecord, DocumentRelation, DocumentResourceProperties, DocumentStatusRecord, DocumentVersion, DownloadFileBase64Data, DownloadFileBase64Error, DownloadFileBase64Errors, DownloadFileBase64Response, DownloadFileBase64Responses, DownloadFileData, DownloadFileError, DownloadFileErrors, DownloadFileResponse, DownloadFileResponses, EmbeddingSimilarityScorer, EmbeddingsResponse, ErrorResponse, Eval, EvalResourceProperties, EvalResult, EvalRun, EvaluateGuardrailData, EvaluateGuardrailError, EvaluateGuardrailErrors, EvaluateGuardrailResponse, EvaluateGuardrailResponses, ExactMatchScorer, ExceptionId, ExceptionItem, ExpectedVersion, ExportActivityData, ExportActivityErrors, ExportActivityResponse, ExportActivityResponses, ExportAuditEntriesData, ExportAuditEntriesErrors, ExportAuditEntriesResponse, ExportAuditEntriesResponses, ExportDocumentsData, ExportDocumentsErrors, ExportDocumentsResponse, ExportDocumentsResponses, ExportMemoriesData, ExportMemoriesErrors, ExportMemoriesResponse, ExportMemoriesResponses, FileRecord, FileRecordWritable, FileResourceProperties, FireTriggerData, FireTriggerErrors, FireTriggerRequest, FireTriggerResponse, FireTriggerResponses, ForkSessionData, ForkSessionError, ForkSessionErrors, ForkSessionRequest, ForkSessionResponse, ForkSessionResponses, Formation, FormationError, FormationEvent, FormationOperation, FormationResource, FormationTemplate, FormationTemplateInput, GenerateConversationMessageCompleted, GenerateConversationMessageData, GenerateConversationMessageError, GenerateConversationMessageErrors, GenerateConversationMessageRequiresAction, GenerateConversationMessageResponse, GenerateConversationMessageResponse2, GenerateConversationMessageResponses, GenerateSessionRequest, GenerateSessionResponse, GenerateSessionResponseData, GenerateSessionResponseError, GenerateSessionResponseErrors, GenerateSessionResponseResponse, GenerateSessionResponseResponses, Generation, GenerationTranscript, GetActorData, GetActorError, GetActorErrors, GetActorResponse, GetActorResponses, GetActorTagsData, GetActorTagsError, GetActorTagsErrors, GetActorTagsResponse, GetActorTagsResponses, GetAgentData, GetAgentError, GetAgentErrors, GetAgentResponse, GetAgentResponses, GetAgentVersionData, GetAgentVersionError, GetAgentVersionErrors, GetAgentVersionResponse, GetAgentVersionResponses, GetAiProviderData, GetAiProviderErrors, GetAiProviderPricesData, GetAiProviderPricesErrors, GetAiProviderPricesResponse, GetAiProviderPricesResponses, GetAiProviderResponse, GetAiProviderResponses, GetApiKeyData, GetApiKeyErrors, GetApiKeyResponse, GetApiKeyResponses, GetApprovalData, GetApprovalErrors, GetApprovalResponse, GetApprovalResponses, GetAuditEntryData, GetAuditEntryErrors, GetAuditEntryResponse, GetAuditEntryResponses, GetChainData, GetChainErrors, GetChainResponse, GetChainResponses, GetChatData, GetChatError, GetChatErrors, GetChatResponse, GetChatResponses, GetConversationData, GetConversationError, GetConversationErrors, GetConversationResponse, GetConversationResponses, GetConversationTagsData, GetConversationTagsError, GetConversationTagsErrors, GetConversationTagsResponse, GetConversationTagsResponses, GetCurrentUserData, GetCurrentUserError, GetCurrentUserErrors, GetCurrentUserResponse, GetCurrentUserResponses, GetDatasetData, GetDatasetErrors, GetDatasetResponse, GetDatasetResponses, GetDocumentData, GetDocumentError, GetDocumentErrors, GetDocumentResponse, GetDocumentResponses, GetDocumentStatusData, GetDocumentStatusError, GetDocumentStatusErrors, GetDocumentStatusResponse, GetDocumentStatusResponses, GetDocumentTagsData, GetDocumentTagsError, GetDocumentTagsErrors, GetDocumentTagsResponse, GetDocumentTagsResponses, GetDocumentVersionData, GetDocumentVersionError, GetDocumentVersionErrors, GetDocumentVersionResponse, GetDocumentVersionResponses, GetEvalData, GetEvalErrors, GetEvalResponse, GetEvalResponses, GetEvalRunData, GetEvalRunErrors, GetEvalRunResponse, GetEvalRunResponses, GetExceptionData, GetExceptionErrors, GetExceptionResponse, GetExceptionResponses, GetFileData, GetFileError, GetFileErrors, GetFileResponse, GetFileResponses, GetFileTagsData, GetFileTagsError, GetFileTagsErrors, GetFileTagsResponse, GetFileTagsResponses, GetFormationData, GetFormationErrors, GetFormationResponse, GetFormationResponses, GetGenerationData, GetGenerationError, GetGenerationErrors, GetGenerationResponse, GetGenerationResponses, GetGenerationTranscriptData, GetGenerationTranscriptError, GetGenerationTranscriptErrors, GetGenerationTranscriptResponse, GetGenerationTranscriptResponses, GetGuardrailData, GetGuardrailError, GetGuardrailErrors, GetGuardrailResponse, GetGuardrailResponses, GetGuardrailVersionData, GetGuardrailVersionError, GetGuardrailVersionErrors, GetGuardrailVersionResponse, GetGuardrailVersionResponses, GetIngestionRuleData, GetIngestionRuleErrors, GetIngestionRuleResponse, GetIngestionRuleResponses, GetMemoryData, GetMemoryErrors, GetMemoryResponse, GetMemoryResponses, GetMemoryRuleData, GetMemoryRuleErrors, GetMemoryRuleResponse, GetMemoryRuleResponses, GetMemoryStoreData, GetMemoryStoreErrors, GetMemoryStoreResponse, GetMemoryStoreResponses, GetMemoryStoreTagsData, GetMemoryStoreTagsErrors, GetMemoryStoreTagsResponse, GetMemoryStoreTagsResponses, GetMemoryTagsData, GetMemoryTagsErrors, GetMemoryTagsResponse, GetMemoryTagsResponses, GetMetadataSchemaData, GetMetadataSchemaError, GetMetadataSchemaErrors, GetMetadataSchemaResponse, GetMetadataSchemaResponses, GetModelRouteData, GetModelRouteErrors, GetModelRouteResponse, GetModelRouteResponses, GetOrchestrationData, GetOrchestrationErrors, GetOrchestrationResponse, GetOrchestrationResponses, GetOrchestrationRunData, GetOrchestrationRunErrors, GetOrchestrationRunResponse, GetOrchestrationRunResponses, GetOrchestrationVersionData, GetOrchestrationVersionErrors, GetOrchestrationVersionResponse, GetOrchestrationVersionResponses, GetPolicyData, GetPolicyErrors, GetPolicyResponse, GetPolicyResponses, GetPriceBookData, GetPriceBookError, GetPriceBookErrors, GetPriceBookResponse, GetPriceBookResponses, GetProjectData, GetProjectErrors, GetProjectPricesData, GetProjectPricesErrors, GetProjectPricesResponse, GetProjectPricesResponses, GetProjectResponse, GetProjectResponses, GetQueueStatsData, GetQueueStatsErrors, GetQueueStatsResponse, GetQueueStatsResponses, GetQuotaData, GetQuotaErrors, GetQuotaResponse, GetQuotaResponses, GetSecretData, GetSecretErrors, GetSecretResponse, GetSecretResponses, GetSessionData, GetSessionError, GetSessionErrors, GetSessionResponse, GetSessionResponses, GetSessionTagsData, GetSessionTagsError, GetSessionTagsErrors, GetSessionTagsResponse, GetSessionTagsResponses, GetTaskData, GetTaskErrors, GetTaskHistoryData, GetTaskHistoryErrors, GetTaskHistoryResponse, GetTaskHistoryResponses, GetTaskResponse, GetTaskResponses, GetToolData, GetToolError, GetToolErrors, GetToolResponse, GetToolResponses, GetTraceData, GetTraceError, GetTraceErrors, GetTraceResponse, GetTraceResponses, GetTraceTreeData, GetTraceTreeError, GetTraceTreeErrors, GetTraceTreeResponse, GetTraceTreeResponses, GetTriggerData, GetTriggerErrors, GetTriggerFiringData, GetTriggerFiringErrors, GetTriggerFiringResponse, GetTriggerFiringResponses, GetTriggerResponse, GetTriggerResponses, GetTriggerSecretData, GetTriggerSecretErrors, GetTriggerSecretResponse, GetTriggerSecretResponses, GetUsageAggregateData, GetUsageAggregateError, GetUsageAggregateErrors, GetUsageAggregateResponse, GetUsageAggregateResponses, GetUsageReceiptData, GetUsageReceiptError, GetUsageReceiptErrors, GetUsageReceiptResponse, GetUsageReceiptResponses, GetUserData, GetUserError, GetUserErrors, GetUserResponse, GetUserResponses, GetWebhookData, GetWebhookDeliveryData, GetWebhookDeliveryErrors, GetWebhookDeliveryResponse, GetWebhookDeliveryResponses, GetWebhookErrors, GetWebhookResponse, GetWebhookResponses, GetWebhookSecretData, GetWebhookSecretErrors, GetWebhookSecretResponse, GetWebhookSecretResponses, GetWorkflowData, GetWorkflowErrors, GetWorkflowResponse, GetWorkflowResponses, GetWorkflowVersionData, GetWorkflowVersionErrors, GetWorkflowVersionResponse, GetWorkflowVersionResponses, Guardrail, GuardrailDocument, GuardrailEvaluation, GuardrailResourceProperties, GuardrailVersion, HumanInputRequest, IfMatchVersion, IngestDocumentData, IngestDocumentError, IngestDocumentErrors, IngestDocumentResponse, IngestDocumentResponses, IngestedDocumentRecord, IngestionRule, IngestionRuleResourceProperties, JsonLogicScorer, KnowledgeResult, ListActivityData, ListActivityErrors, ListActivityResponse, ListActivityResponses, ListActorsData, ListActorsError, ListActorsErrors, ListActorsResponse, ListActorsResponses, ListAgentVersionsData, ListAgentVersionsError, ListAgentVersionsErrors, ListAgentVersionsResponse, ListAgentVersionsResponses, ListAgentsData, ListAgentsError, ListAgentsErrors, ListAgentsResponse, ListAgentsResponses, ListAiProviderModelsData, ListAiProviderModelsErrors, ListAiProviderModelsResponse, ListAiProviderModelsResponses, ListAiProvidersData, ListAiProvidersErrors, ListAiProvidersResponse, ListAiProvidersResponses, ListApiKeysData, ListApiKeysErrors, ListApiKeysResponse, ListApiKeysResponses, ListApprovalRecurrencesData, ListApprovalRecurrencesErrors, ListApprovalRecurrencesResponse, ListApprovalRecurrencesResponses, ListApprovalsData, ListApprovalsErrors, ListApprovalsResponse, ListApprovalsResponses, ListAuditEntriesData, ListAuditEntriesErrors, ListAuditEntriesResponse, ListAuditEntriesResponses, ListChainsData, ListChainsErrors, ListChainsResponse, ListChainsResponses, ListChatsData, ListChatsError, ListChatsErrors, ListChatsResponse, ListChatsResponses, ListConversationMessagesData, ListConversationMessagesError, ListConversationMessagesErrors, ListConversationMessagesResponse, ListConversationMessagesResponses, ListConversationsData, ListConversationsError, ListConversationsErrors, ListConversationsResponse, ListConversationsResponses, ListDatasetItemsData, ListDatasetItemsErrors, ListDatasetItemsResponse, ListDatasetItemsResponses, ListDatasetsData, ListDatasetsErrors, ListDatasetsResponse, ListDatasetsResponses, ListDocumentRelationsData, ListDocumentRelationsErrors, ListDocumentRelationsResponse, ListDocumentRelationsResponses, ListDocumentVersionsData, ListDocumentVersionsError, ListDocumentVersionsErrors, ListDocumentVersionsResponse, ListDocumentVersionsResponses, ListDocumentsData, ListDocumentsError, ListDocumentsErrors, ListDocumentsResponse, ListDocumentsResponses, ListEvalResultsData, ListEvalResultsErrors, ListEvalResultsResponse, ListEvalResultsResponses, ListEvalRunsData, ListEvalRunsErrors, ListEvalRunsResponse, ListEvalRunsResponses, ListEvalsData, ListEvalsErrors, ListEvalsResponse, ListEvalsResponses, ListExceptionsData, ListExceptionsErrors, ListExceptionsResponse, ListExceptionsResponses, ListFilesData, ListFilesError, ListFilesErrors, ListFilesResponse, ListFilesResponses, ListFormationEventsData, ListFormationEventsErrors, ListFormationEventsResponse, ListFormationEventsResponses, ListFormationsData, ListFormationsErrors, ListFormationsResponse, ListFormationsResponses, ListGenerationsData, ListGenerationsError, ListGenerationsErrors, ListGenerationsResponse, ListGenerationsResponses, ListGuardrailVersionsData, ListGuardrailVersionsError, ListGuardrailVersionsErrors, ListGuardrailVersionsResponse, ListGuardrailVersionsResponses, ListGuardrailsData, ListGuardrailsError, ListGuardrailsErrors, ListGuardrailsResponse, ListGuardrailsResponses, ListIngestionRulesData, ListIngestionRulesErrors, ListIngestionRulesResponse, ListIngestionRulesResponses, ListMemoriesData, ListMemoriesErrors, ListMemoriesResponse, ListMemoriesResponses, ListMemoryAssertionsData, ListMemoryAssertionsErrors, ListMemoryAssertionsResponse, ListMemoryAssertionsResponses, ListMemoryRulesData, ListMemoryRulesErrors, ListMemoryRulesResponse, ListMemoryRulesResponses, ListMemoryStoreAssertionsData, ListMemoryStoreAssertionsErrors, ListMemoryStoreAssertionsResponse, ListMemoryStoreAssertionsResponses, ListMemoryStoresData, ListMemoryStoresErrors, ListMemoryStoresResponse, ListMemoryStoresResponses, ListMetadataSchemasData, ListMetadataSchemasError, ListMetadataSchemasErrors, ListMetadataSchemasResponse, ListMetadataSchemasResponses, ListModelRoutesData, ListModelRoutesErrors, ListModelRoutesResponse, ListModelRoutesResponses, ListOrchestrationRunsData, ListOrchestrationRunsErrors, ListOrchestrationRunsResponse, ListOrchestrationRunsResponses, ListOrchestrationVersionsData, ListOrchestrationVersionsErrors, ListOrchestrationVersionsResponse, ListOrchestrationVersionsResponses, ListOrchestrationsData, ListOrchestrationsErrors, ListOrchestrationsResponse, ListOrchestrationsResponses, ListPoliciesData, ListPoliciesErrors, ListPoliciesResponse, ListPoliciesResponses, ListProjectsData, ListProjectsErrors, ListProjectsResponse, ListProjectsResponses, ListQuotasData, ListQuotasErrors, ListQuotasResponse, ListQuotasResponses, ListSecretsData, ListSecretsErrors, ListSecretsResponse, ListSecretsResponses, ListSessionForksData, ListSessionForksError, ListSessionForksErrors, ListSessionForksResponse, ListSessionForksResponses, ListSessionsData, ListSessionsError, ListSessionsErrors, ListSessionsResponse, ListSessionsResponses, ListTasksData, ListTasksErrors, ListTasksResponse, ListTasksResponses, ListToolsData, ListToolsError, ListToolsErrors, ListToolsResponse, ListToolsResponses, ListTracesData, ListTracesError, ListTracesErrors, ListTracesResponse, ListTracesResponses, ListTriggerFiringsData, ListTriggerFiringsErrors, ListTriggerFiringsResponse, ListTriggerFiringsResponses, ListTriggersData, ListTriggersErrors, ListTriggersResponse, ListTriggersResponses, ListUsageEventsData, ListUsageEventsError, ListUsageEventsErrors, ListUsageEventsResponse, ListUsageEventsResponses, ListUsageThresholdsData, ListUsageThresholdsError, ListUsageThresholdsErrors, ListUsageThresholdsResponse, ListUsageThresholdsResponses, ListUsersData, ListUsersError, ListUsersErrors, ListUsersResponse, ListUsersResponses, ListWebhookDeliveriesData, ListWebhookDeliveriesErrors, ListWebhookDeliveriesResponse, ListWebhookDeliveriesResponses, ListWebhooksData, ListWebhooksErrors, ListWebhooksResponse, ListWebhooksResponses, ListWorkflowVersionsData, ListWorkflowVersionsErrors, ListWorkflowVersionsResponse, ListWorkflowVersionsResponses, ListWorkflowsData, ListWorkflowsErrors, ListWorkflowsResponse, ListWorkflowsResponses, LlmJudgeScorer, LoginResponse, LoginUserData, LoginUserError, LoginUserErrors, LoginUserResponse, LoginUserResponses, Memory, MemoryAssertion, MemoryKnowledgeResult, MemoryResourceProperties, MemoryRule, MemoryRuleEvent, MemoryRuleResourceProperties, MemoryStore, MemoryStoreResourceProperties, MemoryWriteResult, MergeActorTagsData, MergeActorTagsError, MergeActorTagsErrors, MergeActorTagsResponse, MergeActorTagsResponses, MergeConversationTagsData, MergeConversationTagsError, MergeConversationTagsErrors, MergeConversationTagsResponse, MergeConversationTagsResponses, MergeDocumentTagsData, MergeDocumentTagsError, MergeDocumentTagsErrors, MergeDocumentTagsResponse, MergeDocumentTagsResponses, MergeFileTagsData, MergeFileTagsError, MergeFileTagsErrors, MergeFileTagsResponse, MergeFileTagsResponses, MergeMemoryStoreTagsData, MergeMemoryStoreTagsErrors, MergeMemoryStoreTagsResponse, MergeMemoryStoreTagsResponses, MergeMemoryTagsData, MergeMemoryTagsErrors, MergeMemoryTagsResponse, MergeMemoryTagsResponses, MergeSessionTagsData, MergeSessionTagsError, MergeSessionTagsErrors, MergeSessionTagsResponse, MergeSessionTagsResponses, MetadataBag, MetadataBagText, MetadataFilter, MetadataQuery, MetadataSchemaRecord, MetadataSchemaResourceProperties, ModelRoute, ModelRouteResourceProperties, ModelRouteTarget, NodeExecution, NullableMetadataBag, NullableTagBag, OauthAuthorizationServerMetadata, OauthClientRegistrationRequest, OauthClientRegistrationResponse, OauthErrorResponse, OauthProtectedResourceMetadata, OauthTokenRequest, OauthTokenResponse, Options, Orchestration, OrchestrationEdge, OrchestrationId, OrchestrationNode, OrchestrationResourceProperties, OrchestrationRun, OrchestrationRunId, OrchestrationValidationError, OrchestrationValidationResult, OrchestrationVersion, OutputSchemaScorer, ParameterDeclaration, PatchAgentData, PatchAgentError, PatchAgentErrors, PatchAgentResponse, PatchAgentResponses, PauseOrchestrationRunData, PauseOrchestrationRunErrors, PauseOrchestrationRunRequest, PauseOrchestrationRunResponse, PauseOrchestrationRunResponses, PauseTaskData, PauseTaskErrors, PauseTaskRequest, PauseTaskResponse, PauseTaskResponses, PlanChange, PlanFormationData, PlanFormationErrors, PlanFormationResponse, PlanFormationResponses, PlanResult, PolicyDocument, PolicyRecord, PolicyResourceProperties, PolicyStatement, PresignedUrlRequest, PresignedUrlResponse, Price, PriceBookResponse, ProjectPrice, ProjectPriceResourceProperties, ProjectPricesResponse, ProjectRecord, PromoteAgentReleaseData, PromoteAgentReleaseError, PromoteAgentReleaseErrors, PromoteAgentReleaseResponse, PromoteAgentReleaseResponses, ProviderModelsResponse, ProviderPrice, ProviderPricesResponse, PurgeGenerationContentData, PurgeGenerationContentError, PurgeGenerationContentErrors, PurgeGenerationContentResponse, PurgeGenerationContentResponses, PurgeTraceContentData, PurgeTraceContentError, PurgeTraceContentErrors, PurgeTraceContentResponse, PurgeTraceContentResponses, QueueStats, Quota, QuotaResourceProperties, RedeliverWebhookDeliveryData, RedeliverWebhookDeliveryErrors, RedeliverWebhookDeliveryResponse, RedeliverWebhookDeliveryResponses, ReingestDocumentData, ReingestDocumentError, ReingestDocumentErrors, ReingestDocumentResponse, ReingestDocumentResponses, RejectApprovalData, RejectApprovalErrors, RejectApprovalResponse, RejectApprovalResponses, RemoveConversationMessageData, RemoveConversationMessageError, RemoveConversationMessageErrors, RemoveConversationMessageResponse, RemoveConversationMessageResponses, ReplaceActorTagsData, ReplaceActorTagsError, ReplaceActorTagsErrors, ReplaceActorTagsResponse, ReplaceActorTagsResponses, ReplaceConversationTagsData, ReplaceConversationTagsError, ReplaceConversationTagsErrors, ReplaceConversationTagsResponse, ReplaceConversationTagsResponses, ReplaceDocumentTagsData, ReplaceDocumentTagsError, ReplaceDocumentTagsErrors, ReplaceDocumentTagsResponse, ReplaceDocumentTagsResponses, ReplaceFileTagsData, ReplaceFileTagsError, ReplaceFileTagsErrors, ReplaceFileTagsResponse, ReplaceFileTagsResponses, ReplaceMemoryStoreTagsData, ReplaceMemoryStoreTagsErrors, ReplaceMemoryStoreTagsResponse, ReplaceMemoryStoreTagsResponses, ReplaceMemoryTagsData, ReplaceMemoryTagsErrors, ReplaceMemoryTagsResponse, ReplaceMemoryTagsResponses, ReplaceSessionTagsData, ReplaceSessionTagsError, ReplaceSessionTagsErrors, ReplaceSessionTagsResponse, ReplaceSessionTagsResponses, RequiredAction, ResolveExceptionData, ResolveExceptionErrors, ResolveExceptionResponse, ResolveExceptionResponses, ResourceDeclaration, RestoreAgentVersionData, RestoreAgentVersionError, RestoreAgentVersionErrors, RestoreAgentVersionRequest, RestoreAgentVersionResponse, RestoreAgentVersionResponses, RestoreDocumentVersionData, RestoreDocumentVersionError, RestoreDocumentVersionErrors, RestoreDocumentVersionResponse, RestoreDocumentVersionResponses, RestoreGuardrailVersionData, RestoreGuardrailVersionError, RestoreGuardrailVersionErrors, RestoreGuardrailVersionRequest, RestoreGuardrailVersionResponse, RestoreGuardrailVersionResponses, RestoreOrchestrationVersionData, RestoreOrchestrationVersionErrors, RestoreOrchestrationVersionRequest, RestoreOrchestrationVersionResponse, RestoreOrchestrationVersionResponses, RestoreWorkflowVersionData, RestoreWorkflowVersionErrors, RestoreWorkflowVersionRequest, RestoreWorkflowVersionResponse, RestoreWorkflowVersionResponses, ResumeOrchestrationRunData, ResumeOrchestrationRunErrors, ResumeOrchestrationRunResponse, ResumeOrchestrationRunResponses, ResumeTaskData, ResumeTaskErrors, ResumeTaskResponse, ResumeTaskResponses, RetractMemoryData, RetractMemoryErrors, RetractMemoryResponse, RetractMemoryResponses, RotateTriggerSecretData, RotateTriggerSecretErrors, RotateTriggerSecretResponse, RotateTriggerSecretResponses, RotateWebhookSecretData, RotateWebhookSecretErrors, RotateWebhookSecretResponse, RotateWebhookSecretResponses, ScorerResult, Scorers, SearchKnowledgeData, SearchKnowledgeError, SearchKnowledgeErrors, SearchKnowledgeResponse, SearchKnowledgeResponses, SecretResourceProperties, SendSessionMessageResponse, SessionId, SessionRecord, SessionResourceProperties, SetAgentReleaseData, SetAgentReleaseError, SetAgentReleaseErrors, SetAgentReleaseRequest, SetAgentReleaseResponse, SetAgentReleaseResponses, SoatClientOptions, StartEvalRunData, StartEvalRunErrors, StartEvalRunResponse, StartEvalRunResponses, StartOrchestrationRunData, StartOrchestrationRunErrors, StartOrchestrationRunRequest, StartOrchestrationRunResponse, StartOrchestrationRunResponses, SubmitAgentToolOutputsData, SubmitAgentToolOutputsError, SubmitAgentToolOutputsErrors, SubmitAgentToolOutputsResponse, SubmitAgentToolOutputsResponses, SubmitHumanInputData, SubmitHumanInputErrors, SubmitHumanInputResponse, SubmitHumanInputResponses, SubmitSessionToolOutputsData, SubmitSessionToolOutputsError, SubmitSessionToolOutputsErrors, SubmitSessionToolOutputsRequest, SubmitSessionToolOutputsResponse, SubmitSessionToolOutputsResponses, SubmitToolOutputsRequest, TagBag, TagsQuery, Task, TaskTransition, Tool, ToolBinding, ToolExecuteAuthConfig, ToolExecuteConfig, ToolMcpConfig, ToolOutputMessageContent, ToolResourceProperties, ToolScorer, Trace, TraceTreeNode, TranscriptStep, TranscriptToolCall, TranscriptToolResult, TransitionTaskData, TransitionTaskErrors, TransitionTaskRequest, TransitionTaskResponse, TransitionTaskResponses, Trigger, TriggerFiring, TriggerFiringListResponse, TriggerResourceProperties, TriggerSecretResponse, TriggerWithSecret, UnauthorizedFormationAction, UpdateActorData, UpdateActorError, UpdateActorErrors, UpdateActorResponse, UpdateActorResponses, UpdateAgentData, UpdateAgentError, UpdateAgentErrors, UpdateAgentRequest, UpdateAgentResponse, UpdateAgentResponses, UpdateAiProviderData, UpdateAiProviderErrors, UpdateAiProviderPricesData, UpdateAiProviderPricesErrors, UpdateAiProviderPricesResponse, UpdateAiProviderPricesResponses, UpdateAiProviderResponses, UpdateApiKeyData, UpdateApiKeyError, UpdateApiKeyErrors, UpdateApiKeyResponse, UpdateApiKeyResponses, UpdateConversationData, UpdateConversationError, UpdateConversationErrors, UpdateConversationResponse, UpdateConversationResponses, UpdateDatasetData, UpdateDatasetErrors, UpdateDatasetItemData, UpdateDatasetItemErrors, UpdateDatasetItemResponse, UpdateDatasetItemResponses, UpdateDatasetResponse, UpdateDatasetResponses, UpdateDocumentData, UpdateDocumentError, UpdateDocumentErrors, UpdateDocumentResponse, UpdateDocumentResponses, UpdateEvalData, UpdateEvalErrors, UpdateEvalResponse, UpdateEvalResponses, UpdateFileMetadataData, UpdateFileMetadataError, UpdateFileMetadataErrors, UpdateFileMetadataResponse, UpdateFileMetadataResponses, UpdateFormationData, UpdateFormationErrors, UpdateFormationResponse, UpdateFormationResponses, UpdateGenerationData, UpdateGenerationError, UpdateGenerationErrors, UpdateGenerationRequest, UpdateGenerationResponse, UpdateGenerationResponses, UpdateGuardrailData, UpdateGuardrailError, UpdateGuardrailErrors, UpdateGuardrailRequest, UpdateGuardrailResponse, UpdateGuardrailResponses, UpdateIngestionRuleData, UpdateIngestionRuleErrors, UpdateIngestionRuleResponse, UpdateIngestionRuleResponses, UpdateMemoryData, UpdateMemoryErrors, UpdateMemoryResponse, UpdateMemoryResponses, UpdateMemoryRuleData, UpdateMemoryRuleErrors, UpdateMemoryRuleResponse, UpdateMemoryRuleResponses, UpdateMemoryStoreData, UpdateMemoryStoreErrors, UpdateMemoryStoreResponse, UpdateMemoryStoreResponses, UpdateMetadataSchemaData, UpdateMetadataSchemaError, UpdateMetadataSchemaErrors, UpdateMetadataSchemaResponse, UpdateMetadataSchemaResponses, UpdateModelRouteData, UpdateModelRouteErrors, UpdateModelRouteResponse, UpdateModelRouteResponses, UpdateOrchestrationData, UpdateOrchestrationErrors, UpdateOrchestrationRequest, UpdateOrchestrationResponse, UpdateOrchestrationResponses, UpdatePolicyData, UpdatePolicyError, UpdatePolicyErrors, UpdatePolicyResponse, UpdatePolicyResponses, UpdateProjectData, UpdateProjectErrors, UpdateProjectPricesData, UpdateProjectPricesErrors, UpdateProjectPricesResponse, UpdateProjectPricesResponses, UpdateProjectResponse, UpdateProjectResponses, UpdateQuotaData, UpdateQuotaErrors, UpdateQuotaResponse, UpdateQuotaResponses, UpdateSecretData, UpdateSecretErrors, UpdateSecretResponses, UpdateSessionData, UpdateSessionError, UpdateSessionErrors, UpdateSessionRequest, UpdateSessionResponse, UpdateSessionResponses, UpdateTaskData, UpdateTaskErrors, UpdateTaskRequest, UpdateTaskResponse, UpdateTaskResponses, UpdateToolData, UpdateToolError, UpdateToolErrors, UpdateToolRequest, UpdateToolResponse, UpdateToolResponses, UpdateTriggerData, UpdateTriggerErrors, UpdateTriggerRequest, UpdateTriggerResponse, UpdateTriggerResponses, UpdateWebhookData, UpdateWebhookErrors, UpdateWebhookRequest, UpdateWebhookResponse, UpdateWebhookResponses, UpdateWorkflowData, UpdateWorkflowErrors, UpdateWorkflowRequest, UpdateWorkflowResponse, UpdateWorkflowResponses, UploadFileBase64Data, UploadFileBase64Error, UploadFileBase64Errors, UploadFileBase64Request, UploadFileBase64Response, UploadFileBase64Responses, UploadFileData, UploadFileError, UploadFileErrors, UploadFileResponse, UploadFileResponses, UploadFileWithTokenData, UploadFileWithTokenError, UploadFileWithTokenErrors, UploadFileWithTokenRequest, UploadFileWithTokenResponse, UploadFileWithTokenResponses, UpsertPriceBookData, UpsertPriceBookError, UpsertPriceBookErrors, UpsertPriceBookResponse, UpsertPriceBookResponses, UpsertPricesRequest, UpsertProjectPricesRequest, UpsertProviderPricesRequest, UsageAggregate, UsageAggregateBucket, UsageAggregateComponent, UsageAggregateFilters, UsageAggregateGroup, UsageAggregateTotals, UsageComponent, UsageDistinct, UsageEvent, UsageGroupBy, UsageReceipt, UsageThreshold, UsageTotals, UserRecord, ValidateFormationData, ValidateFormationErrors, ValidateFormationResponse, ValidateFormationResponses, ValidateMetadataData, ValidateMetadataError, ValidateMetadataErrors, ValidateMetadataResponse, ValidateMetadataResponses, ValidateOrchestrationData, ValidateOrchestrationErrors, ValidateOrchestrationRequest, ValidateOrchestrationResponse, ValidateOrchestrationResponses, ValidationError, ValidationResult, Webhook, WebhookResourceProperties, WebhookSecretResponse, WebhookWithSecret, WithdrawDocumentData, WithdrawDocumentError, WithdrawDocumentErrors, WithdrawDocumentResponse, WithdrawDocumentResponses, Workflow, WorkflowResourceProperties, WorkflowState, WorkflowTransition, WorkflowVersion };