@soat/sdk 0.16.3 → 0.17.0

package/dist/index.cjs

@@ -2474,7 +2474,7 @@ var Orchestrations = class {
 	/**
 	* Start an orchestration run
 	*
-	* Creates a new run for the orchestration named by orchestration_id. By default the run executes durably in the background: the response returns immediately with status "running" and progress is observed via get-orchestration-run or run lifecycle webhook events (orchestration_runs.started/awaiting_input/succeeded/failed). Delay and poll waits park the run as "sleeping" and are woken by a background scheduler, surviving restarts. Pass wait=true to block until the run reaches a terminal or awaiting_input state (the legacy synchronous behaviour).
+	* Creates a new run for the orchestration named by orchestration_id. By default the run executes durably in the background: the response returns immediately with status "queued" (a worker then claims it and moves it to "running") and progress is observed via get-orchestration-run or run lifecycle webhook events (orchestration_runs.started/awaiting_input/succeeded/failed). Delay and poll waits park the run as "sleeping" and are woken by a background scheduler, surviving restarts. Pass wait=true to block until the run reaches a terminal or awaiting_input state (the legacy synchronous behaviour).
 	*/
 	static startOrchestrationRun(options) {
 		return (options.client ?? client).post({
@@ -2515,7 +2515,7 @@ var Orchestrations = class {
 	/**
 	* Resume an orchestration run
 	*
-	* Resumes an awaiting_input orchestration run from its last checkpoint.
+	* Re-drives an awaiting_input orchestration run from its last checkpoint. This does not satisfy the pause itself — it carries no node_id or payload, so a run parked on a human or webhook-receive node re-parks on the same node. Use submit-human-input to supply the awaited payload and advance the run.
 	*/
 	static resumeOrchestrationRun(options) {
 		return (options.client ?? client).post({
@@ -2845,7 +2845,7 @@ var Sessions = class {
 	/**
 	* Create a session
 	*
-	* Creates a new session for the specified agent. Internally creates a conversation and two actors (agent + user) so the caller only needs this single call to start interacting with the agent.
+	* Creates a new session for the specified agent, along with the underlying conversation, so the caller only needs this single call to start interacting with the agent. No actor is created: pass `actor_id` to attach an existing actor as the session's end user. When it is omitted the session has no actor, and generations in it carry no end-user attribution — they are not billed to an actor in the usage meter and they match no `actor`-scoped quota.
 	*
 	*/
 	static createSession(options) {

package/dist/index.d.cts

@@ -726,7 +726,7 @@ type CreateAgentGenerationRequest = {
    */
   max_call_depth?: number;
   /**
-   * Key-value pairs injected as context headers into all tool call requests made during this generation.
+   * Key-value pairs forwarded as `X-Soat-Context-<Key>` headers on every `http`, `mcp` and `soat` tool call in this generation. Each key's first character is uppercased and the rest is used verbatim. Keys are never case-converted — they round-trip exactly as sent. An invalid or colliding key is rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
    */
   tool_context?: {
     [key: string]: string;
@@ -3721,7 +3721,7 @@ type StartRunRequest = {
     [key: string]: unknown;
   };
   /**
-   * When true, block until the run reaches a terminal (succeeded/failed) or awaiting_input state and return the settled run. When false (default), return immediately with status "running" and execute the run in the background.
+   * When true, block until the run reaches a terminal (succeeded/failed) or awaiting_input state and return the settled run. When false (default), return immediately with status "queued" and execute the run in the background.
    */
   wait?: boolean;
 };
@@ -3740,7 +3740,7 @@ type PolicyStatement = {
   action: Array<string>;
   resource?: Array<string>;
   /**
-   * Optional condition block. Keys are condition operators (e.g. StringEquals) mapping to context-key/value maps; evaluated by the policy compiler. Free-form — keys are dynamic, not validated.
+   * Optional condition block. Keys are condition operators (e.g. StringEquals) mapping to context-key/value maps; evaluated by the policy compiler. Free-form — keys are dynamic, not validated. Operator and context keys are matched by exact string and are never case-converted, so they round-trip exactly as written: `soat:ResourceTag/cost_center` selects the tag `cost_center`, not `costCenter`.
    *
    */
   condition?: {
@@ -3880,7 +3880,8 @@ type SessionRecord = {
   status?: 'open' | 'closed' | 'expired';
   name?: string | null;
   /**
-   * Public ID of the user actor
+   * Public ID of the user actor, or null when the session was created without one
+   *
    */
   actor_id?: string | null;
   tags?: {
@@ -3897,7 +3898,7 @@ type SessionRecord = {
   created_at?: Date;
   updated_at?: Date;
   /**
-   * Key-value pairs injected as context headers into all tool call requests made during this session.
+   * Key-value pairs forwarded as `X-Soat-Context-<Key>` headers on every `http`, `mcp` and `soat` tool call in this session. Each key's first character is uppercased and the rest is used verbatim. 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`.
    */
   tool_context?: {
     [key: string]: string;
@@ -3926,7 +3927,8 @@ type CreateSessionRequest = {
    */
   name?: string;
   /**
-   * Optional public ID of an existing actor to use as the user actor
+   * Optional public ID of an existing actor to use as the user actor. Actors are created separately (POST /actors); this field only links one. Omit it and the session has no end user, so its generations match no actor-scoped quota.
+   *
    */
   actor_id?: string;
   /**
@@ -3934,7 +3936,7 @@ type CreateSessionRequest = {
    */
   auto_generate?: boolean;
   /**
-   * Key-value pairs injected as context headers into all tool call requests made during this session.
+   * Key-value pairs forwarded as `X-Soat-Context-<Key>` headers on every `http`, `mcp` and `soat` tool call in this session. Each key's first character is uppercased and the rest is used verbatim. 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`.
    */
   tool_context?: {
     [key: string]: string;
@@ -3963,7 +3965,7 @@ type UpdateSessionRequest = {
    */
   auto_generate?: boolean;
   /**
-   * Key-value pairs injected as context headers into all tool call requests made during this session.
+   * Key-value pairs forwarded as `X-Soat-Context-<Key>` headers on every `http`, `mcp` and `soat` tool call in this session. Each key's first character is uppercased and the rest is used verbatim. 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`.
    */
   tool_context?: {
     [key: string]: string;
@@ -3985,7 +3987,7 @@ type AddSessionMessageRequest = {
    */
   message: string;
   /**
-   * Key-value pairs injected as context headers into all tool call requests made during this generation.
+   * Key-value pairs forwarded as `X-Soat-Context-<Key>` headers on every `http`, `mcp` and `soat` tool call in this generation. Each key's first character is uppercased and the rest is used verbatim. Keys are never case-converted — they round-trip exactly as sent. An invalid or colliding key is rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
    */
   tool_context?: {
     [key: string]: string;
@@ -4001,7 +4003,7 @@ type AddSessionMessageRequest = {
    */
   document_id: string;
   /**
-   * Key-value pairs injected as context headers into all tool call requests made during this generation.
+   * Key-value pairs forwarded as `X-Soat-Context-<Key>` headers on every `http`, `mcp` and `soat` tool call in this generation. Each key's first character is uppercased and the rest is used verbatim. Keys are never case-converted — they round-trip exactly as sent. An invalid or colliding key is rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
    */
   tool_context?: {
     [key: string]: string;
@@ -4027,7 +4029,7 @@ type GenerateSessionRequest = {
    */
   model?: string;
   /**
-   * Key-value pairs injected as context headers into all tool call requests made during this generation.
+   * Key-value pairs forwarded as `X-Soat-Context-<Key>` headers on every `http`, `mcp` and `soat` tool call in this generation. Each key's first character is uppercased and the rest is used verbatim. Keys are never case-converted — they round-trip exactly as sent. An invalid or colliding key is rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
    */
   tool_context?: {
     [key: string]: string;
@@ -7142,7 +7144,7 @@ type GenerateConversationMessageData = {
      */
     stream?: boolean;
     /**
-     * Key-value pairs injected as context headers into all tool call requests made during this generation.
+     * Key-value pairs forwarded as `X-Soat-Context-<Key>` headers on every `http`, `mcp` and `soat` tool call in this generation. Each key's first character is uppercased and the rest is used verbatim; keys are never case-converted — they round-trip exactly as sent. An invalid or colliding key is rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
      */
     tool_context?: {
       [key: string]: string;
@@ -8820,7 +8822,7 @@ type DownloadFileBase64Responses = {
     /**
      * MIME type of the file
      */
-    contentType?: string;
+    content_type?: string;
     /**
      * File size in bytes
      */
@@ -14886,7 +14888,7 @@ declare class Orchestrations {
   /**
    * Start an orchestration run
    *
-   * Creates a new run for the orchestration named by orchestration_id. By default the run executes durably in the background: the response returns immediately with status "running" and progress is observed via get-orchestration-run or run lifecycle webhook events (orchestration_runs.started/awaiting_input/succeeded/failed). Delay and poll waits park the run as "sleeping" and are woken by a background scheduler, surviving restarts. Pass wait=true to block until the run reaches a terminal or awaiting_input state (the legacy synchronous behaviour).
+   * Creates a new run for the orchestration named by orchestration_id. By default the run executes durably in the background: the response returns immediately with status "queued" (a worker then claims it and moves it to "running") and progress is observed via get-orchestration-run or run lifecycle webhook events (orchestration_runs.started/awaiting_input/succeeded/failed). Delay and poll waits park the run as "sleeping" and are woken by a background scheduler, surviving restarts. Pass wait=true to block until the run reaches a terminal or awaiting_input state (the legacy synchronous behaviour).
    */
   static startOrchestrationRun<ThrowOnError extends boolean = false>(options: Options<StartOrchestrationRunData, ThrowOnError>): RequestResult<StartOrchestrationRunResponses, StartOrchestrationRunErrors, ThrowOnError>;
   /**
@@ -14904,7 +14906,7 @@ declare class Orchestrations {
   /**
    * Resume an orchestration run
    *
-   * Resumes an awaiting_input orchestration run from its last checkpoint.
+   * Re-drives an awaiting_input orchestration run from its last checkpoint. This does not satisfy the pause itself — it carries no node_id or payload, so a run parked on a human or webhook-receive node re-parks on the same node. Use submit-human-input to supply the awaited payload and advance the run.
    */
   static resumeOrchestrationRun<ThrowOnError extends boolean = false>(options: Options<ResumeOrchestrationRunData, ThrowOnError>): RequestResult<ResumeOrchestrationRunResponses, ResumeOrchestrationRunErrors, ThrowOnError>;
   /**
@@ -15069,7 +15071,7 @@ declare class Sessions {
   /**
    * Create a session
    *
-   * Creates a new session for the specified agent. Internally creates a conversation and two actors (agent + user) so the caller only needs this single call to start interacting with the agent.
+   * Creates a new session for the specified agent, along with the underlying conversation, so the caller only needs this single call to start interacting with the agent. No actor is created: pass `actor_id` to attach an existing actor as the session's end user. When it is omitted the session has no actor, and generations in it carry no end-user attribution — they are not billed to an actor in the usage meter and they match no `actor`-scoped quota.
    *
    */
   static createSession<ThrowOnError extends boolean = false>(options?: Options<CreateSessionData, ThrowOnError>): RequestResult<CreateSessionResponses, CreateSessionErrors, ThrowOnError>;

package/dist/index.d.mts

@@ -726,7 +726,7 @@ type CreateAgentGenerationRequest = {
    */
   max_call_depth?: number;
   /**
-   * Key-value pairs injected as context headers into all tool call requests made during this generation.
+   * Key-value pairs forwarded as `X-Soat-Context-<Key>` headers on every `http`, `mcp` and `soat` tool call in this generation. Each key's first character is uppercased and the rest is used verbatim. Keys are never case-converted — they round-trip exactly as sent. An invalid or colliding key is rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
    */
   tool_context?: {
     [key: string]: string;
@@ -3721,7 +3721,7 @@ type StartRunRequest = {
     [key: string]: unknown;
   };
   /**
-   * When true, block until the run reaches a terminal (succeeded/failed) or awaiting_input state and return the settled run. When false (default), return immediately with status "running" and execute the run in the background.
+   * When true, block until the run reaches a terminal (succeeded/failed) or awaiting_input state and return the settled run. When false (default), return immediately with status "queued" and execute the run in the background.
    */
   wait?: boolean;
 };
@@ -3740,7 +3740,7 @@ type PolicyStatement = {
   action: Array<string>;
   resource?: Array<string>;
   /**
-   * Optional condition block. Keys are condition operators (e.g. StringEquals) mapping to context-key/value maps; evaluated by the policy compiler. Free-form — keys are dynamic, not validated.
+   * Optional condition block. Keys are condition operators (e.g. StringEquals) mapping to context-key/value maps; evaluated by the policy compiler. Free-form — keys are dynamic, not validated. Operator and context keys are matched by exact string and are never case-converted, so they round-trip exactly as written: `soat:ResourceTag/cost_center` selects the tag `cost_center`, not `costCenter`.
    *
    */
   condition?: {
@@ -3880,7 +3880,8 @@ type SessionRecord = {
   status?: 'open' | 'closed' | 'expired';
   name?: string | null;
   /**
-   * Public ID of the user actor
+   * Public ID of the user actor, or null when the session was created without one
+   *
    */
   actor_id?: string | null;
   tags?: {
@@ -3897,7 +3898,7 @@ type SessionRecord = {
   created_at?: Date;
   updated_at?: Date;
   /**
-   * Key-value pairs injected as context headers into all tool call requests made during this session.
+   * Key-value pairs forwarded as `X-Soat-Context-<Key>` headers on every `http`, `mcp` and `soat` tool call in this session. Each key's first character is uppercased and the rest is used verbatim. 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`.
    */
   tool_context?: {
     [key: string]: string;
@@ -3926,7 +3927,8 @@ type CreateSessionRequest = {
    */
   name?: string;
   /**
-   * Optional public ID of an existing actor to use as the user actor
+   * Optional public ID of an existing actor to use as the user actor. Actors are created separately (POST /actors); this field only links one. Omit it and the session has no end user, so its generations match no actor-scoped quota.
+   *
    */
   actor_id?: string;
   /**
@@ -3934,7 +3936,7 @@ type CreateSessionRequest = {
    */
   auto_generate?: boolean;
   /**
-   * Key-value pairs injected as context headers into all tool call requests made during this session.
+   * Key-value pairs forwarded as `X-Soat-Context-<Key>` headers on every `http`, `mcp` and `soat` tool call in this session. Each key's first character is uppercased and the rest is used verbatim. 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`.
    */
   tool_context?: {
     [key: string]: string;
@@ -3963,7 +3965,7 @@ type UpdateSessionRequest = {
    */
   auto_generate?: boolean;
   /**
-   * Key-value pairs injected as context headers into all tool call requests made during this session.
+   * Key-value pairs forwarded as `X-Soat-Context-<Key>` headers on every `http`, `mcp` and `soat` tool call in this session. Each key's first character is uppercased and the rest is used verbatim. 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`.
    */
   tool_context?: {
     [key: string]: string;
@@ -3985,7 +3987,7 @@ type AddSessionMessageRequest = {
    */
   message: string;
   /**
-   * Key-value pairs injected as context headers into all tool call requests made during this generation.
+   * Key-value pairs forwarded as `X-Soat-Context-<Key>` headers on every `http`, `mcp` and `soat` tool call in this generation. Each key's first character is uppercased and the rest is used verbatim. Keys are never case-converted — they round-trip exactly as sent. An invalid or colliding key is rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
    */
   tool_context?: {
     [key: string]: string;
@@ -4001,7 +4003,7 @@ type AddSessionMessageRequest = {
    */
   document_id: string;
   /**
-   * Key-value pairs injected as context headers into all tool call requests made during this generation.
+   * Key-value pairs forwarded as `X-Soat-Context-<Key>` headers on every `http`, `mcp` and `soat` tool call in this generation. Each key's first character is uppercased and the rest is used verbatim. Keys are never case-converted — they round-trip exactly as sent. An invalid or colliding key is rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
    */
   tool_context?: {
     [key: string]: string;
@@ -4027,7 +4029,7 @@ type GenerateSessionRequest = {
    */
   model?: string;
   /**
-   * Key-value pairs injected as context headers into all tool call requests made during this generation.
+   * Key-value pairs forwarded as `X-Soat-Context-<Key>` headers on every `http`, `mcp` and `soat` tool call in this generation. Each key's first character is uppercased and the rest is used verbatim. Keys are never case-converted — they round-trip exactly as sent. An invalid or colliding key is rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
    */
   tool_context?: {
     [key: string]: string;
@@ -7142,7 +7144,7 @@ type GenerateConversationMessageData = {
      */
     stream?: boolean;
     /**
-     * Key-value pairs injected as context headers into all tool call requests made during this generation.
+     * Key-value pairs forwarded as `X-Soat-Context-<Key>` headers on every `http`, `mcp` and `soat` tool call in this generation. Each key's first character is uppercased and the rest is used verbatim; keys are never case-converted — they round-trip exactly as sent. An invalid or colliding key is rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
      */
     tool_context?: {
       [key: string]: string;
@@ -8820,7 +8822,7 @@ type DownloadFileBase64Responses = {
     /**
      * MIME type of the file
      */
-    contentType?: string;
+    content_type?: string;
     /**
      * File size in bytes
      */
@@ -14886,7 +14888,7 @@ declare class Orchestrations {
   /**
    * Start an orchestration run
    *
-   * Creates a new run for the orchestration named by orchestration_id. By default the run executes durably in the background: the response returns immediately with status "running" and progress is observed via get-orchestration-run or run lifecycle webhook events (orchestration_runs.started/awaiting_input/succeeded/failed). Delay and poll waits park the run as "sleeping" and are woken by a background scheduler, surviving restarts. Pass wait=true to block until the run reaches a terminal or awaiting_input state (the legacy synchronous behaviour).
+   * Creates a new run for the orchestration named by orchestration_id. By default the run executes durably in the background: the response returns immediately with status "queued" (a worker then claims it and moves it to "running") and progress is observed via get-orchestration-run or run lifecycle webhook events (orchestration_runs.started/awaiting_input/succeeded/failed). Delay and poll waits park the run as "sleeping" and are woken by a background scheduler, surviving restarts. Pass wait=true to block until the run reaches a terminal or awaiting_input state (the legacy synchronous behaviour).
    */
   static startOrchestrationRun<ThrowOnError extends boolean = false>(options: Options<StartOrchestrationRunData, ThrowOnError>): RequestResult<StartOrchestrationRunResponses, StartOrchestrationRunErrors, ThrowOnError>;
   /**
@@ -14904,7 +14906,7 @@ declare class Orchestrations {
   /**
    * Resume an orchestration run
    *
-   * Resumes an awaiting_input orchestration run from its last checkpoint.
+   * Re-drives an awaiting_input orchestration run from its last checkpoint. This does not satisfy the pause itself — it carries no node_id or payload, so a run parked on a human or webhook-receive node re-parks on the same node. Use submit-human-input to supply the awaited payload and advance the run.
    */
   static resumeOrchestrationRun<ThrowOnError extends boolean = false>(options: Options<ResumeOrchestrationRunData, ThrowOnError>): RequestResult<ResumeOrchestrationRunResponses, ResumeOrchestrationRunErrors, ThrowOnError>;
   /**
@@ -15069,7 +15071,7 @@ declare class Sessions {
   /**
    * Create a session
    *
-   * Creates a new session for the specified agent. Internally creates a conversation and two actors (agent + user) so the caller only needs this single call to start interacting with the agent.
+   * Creates a new session for the specified agent, along with the underlying conversation, so the caller only needs this single call to start interacting with the agent. No actor is created: pass `actor_id` to attach an existing actor as the session's end user. When it is omitted the session has no actor, and generations in it carry no end-user attribution — they are not billed to an actor in the usage meter and they match no `actor`-scoped quota.
    *
    */
   static createSession<ThrowOnError extends boolean = false>(options?: Options<CreateSessionData, ThrowOnError>): RequestResult<CreateSessionResponses, CreateSessionErrors, ThrowOnError>;

package/dist/index.mjs

@@ -2473,7 +2473,7 @@ var Orchestrations = class {
 	/**
 	* Start an orchestration run
 	*
-	* Creates a new run for the orchestration named by orchestration_id. By default the run executes durably in the background: the response returns immediately with status "running" and progress is observed via get-orchestration-run or run lifecycle webhook events (orchestration_runs.started/awaiting_input/succeeded/failed). Delay and poll waits park the run as "sleeping" and are woken by a background scheduler, surviving restarts. Pass wait=true to block until the run reaches a terminal or awaiting_input state (the legacy synchronous behaviour).
+	* Creates a new run for the orchestration named by orchestration_id. By default the run executes durably in the background: the response returns immediately with status "queued" (a worker then claims it and moves it to "running") and progress is observed via get-orchestration-run or run lifecycle webhook events (orchestration_runs.started/awaiting_input/succeeded/failed). Delay and poll waits park the run as "sleeping" and are woken by a background scheduler, surviving restarts. Pass wait=true to block until the run reaches a terminal or awaiting_input state (the legacy synchronous behaviour).
 	*/
 	static startOrchestrationRun(options) {
 		return (options.client ?? client).post({
@@ -2514,7 +2514,7 @@ var Orchestrations = class {
 	/**
 	* Resume an orchestration run
 	*
-	* Resumes an awaiting_input orchestration run from its last checkpoint.
+	* Re-drives an awaiting_input orchestration run from its last checkpoint. This does not satisfy the pause itself — it carries no node_id or payload, so a run parked on a human or webhook-receive node re-parks on the same node. Use submit-human-input to supply the awaited payload and advance the run.
 	*/
 	static resumeOrchestrationRun(options) {
 		return (options.client ?? client).post({
@@ -2844,7 +2844,7 @@ var Sessions = class {
 	/**
 	* Create a session
 	*
-	* Creates a new session for the specified agent. Internally creates a conversation and two actors (agent + user) so the caller only needs this single call to start interacting with the agent.
+	* Creates a new session for the specified agent, along with the underlying conversation, so the caller only needs this single call to start interacting with the agent. No actor is created: pass `actor_id` to attach an existing actor as the session's end user. When it is omitted the session has no actor, and generations in it carry no end-user attribution — they are not billed to an actor in the usage meter and they match no `actor`-scoped quota.
 	*
 	*/
 	static createSession(options) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soat/sdk",
-  "version": "0.16.3",
+  "version": "0.17.0",
   "description": "TypeScript SDK for the SOAT API",
   "type": "module",
   "main": "dist/index.mjs",